Search our Knowledge Base
Search

Campaign Domain Metrics Export API



The campaign domain metrics export method generates a process based on the selected campaign(s) that returns a compressed ZIP file with CSV file(s) containing the following domain metrics:
  • URL
  • IP Country
  • Google Indexed Pages
  • Majestic: Pages, Backlinks, Referring Domains, Class C subnets, Referring IP, Edu, Gov, Citation Flow, Trust Flow
  • Ahrefs: Pages, Backlinks, Referring Pages, No Follow, Redirect, Edu, Gov
  • Moz: Backlinks, Domain Authority, Page Authority, Referring Domains
  • Alexa Rank
  • Dmoz listings 

Refer to Rank Ranger API Overview page for information on how to obtain API access, obtain an API Key, error codes and a full list of API methods.


 

Parameters

 
key string The unique API key assigned to your account
campaigns string Campaign ID number(s) with comma between multiple IDs 
date yyyy-mm-dd Requested data date
data_type
string domain_metrics provides Google, Majestic, Ahrefs, Moz, Alexa and Dmoz data for the primary domain


Sample API Requests

 

Construct & test API requests in the API Console or follow one of these examples:

To retrieve domain metric data for 1 campaign
https://www.rankranger.com/api/v2/?campaigns_rank_export&key=YOUR-API-KEY&campaigns=XXXXX&data_type=domain_metrics&date=YYYY-MM-DD  

To retrieve domain metric data for multiple campaigns (individual CSV file for each campaign in 1 zipped file)
https://www.rankranger.com/api/v2/?campaigns_rank_export&key=YOUR-API-KEY&campaigns=XXXXX,XXXXX,XXXXX&date=YYYY-MM-DD&data_type=domain_metrics



Response

 
After sending a properly constructed API request, the following message displays in the browser
 
<tracking-data provider="rankranger" date="08/10/2016" time="13:59:37" status="ok">
<status>success</status>
<process_id>XXX</process_id>
</tracking-data>
 
The process_id is needed to obtain the status and download the file when the process is completed





Request Process Status

 
Enter the Process ID (from the response you received when running the API request) and run this API request:

https://www.rankranger.com/api/v2/?get_process_status&key=YOUR-API-KEY&process_id=XXX

Data generation can take a few minutes to several hours depending upon the size of your request and its position in the queue.

This response indicates that the request is waiting to be processed:
<tracking-data provider="rankranger" date="08/10/2016" time="14:01:12" status="ok">
<process_id>XXX</process_id>
<process_status>waiting</process_status>
</tracking-data>

This response indicates that the request is processing:
<tracking-data provider="rankranger" date="08/10/2016" time="14:01:12" status="ok">
<process_id>XXX</process_id>
<process_status>in_process</process_status>
</tracking-data>

This response indicates that the process has been completed:
<tracking-data provider="rankranger" date="08/10/2016" time="14:01:12" status="ok">
<process_id>XXX</process_id>
<process_status>done</process_status>
</tracking-data>

            

Request Download File

 
When the process status is done, you can request the ZIP file for download by running this API request:

https://rankranger.com/api/v2/?download_process&key=YOUR-API-KEY&process_id=XXX

Campaign Domain Metrics Export Download
The ZIP file will download based on your browser settings.  The file is in compressed ZIP format, you can extract the individual CSV file(s) using utilities such as WinRaR, WinZip, 7-Zip, iZip, RAR Extractor, UnZip, etc. depending upon your computer's operating system.

Campaign Domain Metric Export API Download


Results
The CSV file(s) can be viewed, analyzed and edited in Excel and various CSV readers depending upon your computer's operating system. This is an example of what the file looks like when first opened in Excel. Column width can be expanded and Excel's filters and functions can be employed based on your needs.

View Campaign Domain Metrics data in Excel


After Download Delete Process API


After you have downloaded the file that was generated by your API request, you should run the Delete Process API request to clear the process and CSV file from your account:

https://www.rankranger.com/api/v2/?delete_process&key=YOUR-API-KEY&process_id=XXX

CSV files are automatically removed 7 days after generation, however, there is a limit to the number of processes and files an account can store and if the files aren't removed you'll receive a "too many processes requested" error message until they are cleared.

How to Obtain API Access


If you'd like to help determining which of our API plans is most appropriate for your needs, contact our service team and an account manager will be happy to assist you.

If you already have a Rank Ranger plan and see an error message when accessing the Account > Connections > API & Connected Apps screen, then to obtain API access you will need to upgrade to a package that includes API access by completing a custom package request form or contacting Rank Ranger support with your requirements.

If your company has API services included in a plan and you aren't able to access the screen, contact your company's Rank Ranger acccount administrator to request that your user permissions be set to include access to the Account > API and Connected Apps screen.

How to Generate New API Keys


You can obtain API Keys per user if your Rank Ranger account has API access by navigating to
1. Account  
2. Connections > API & Connected Apps
3. Click the Generate Key button
4. Select a User and add a note (optional)
5. Click the Add button

Generate API Key

API Console: Construct & Test API Requests


To make construction of API requests easy, we offer this API testing tool. Most parameters are included in the options of the console, however, you may need to add custom option parameters to your API requests based on the specific API you're using. Referencing the parameters information that is listed in the specific API method documentation, you can construct and test API requests in Rank Ranger's API Console by navigating to:

1. Tools
2. Utilities
3. API Console
4. Select the Method and complete the applicable fields
5. Click the Generate button
6. Test your API method by clicking the launch URL icon and view your results. Once your results are as you want them, copy that URL into your own application and modify as needed for each request.

Rank Ranger API Testing Tool



Getting Started: Samples of APIs used for Creating Campaigns



We recommend reviewing our Best Practices Guide prior to structuring campaigns.

Get Packages Info: Required when there is more than 1 package in an account
https://www.rankranger.com/api/v2/?packages&key=YOURAPIKEY

Add a Profile: An option for adding an identifier to your campaigns for categorization (e.g., by language, country, etc)
https://www.rankranger.com/api/v2/?add_profile&key=YOURAPIKEY&profile_name=Profile Name&profile_ref_id=YourInternalReferenceID

Get Profile ID list: Optional Data needed for Add a Campaign
https://www.rankranger.com/api/v2/?get_all_profiles&key=YOURAPIKEY

Obtain the Search Engine List: Data needed for Add a Campaign
https://www.rankranger.com/api/v2/?se_list&key=YOURAPIKEY

Add a Campaign: Create a new campaign, response will include the Campaign ID number that is needed for adding a search engine and keywords
https://www.rankranger.com/api/v2/?add_campaign&key=YOURAPIKEY&campaign_name=yourcampaignname&campaign_domain=example.com&campaign_ranking_system
=default&profile_id=ProfileIDnumber

*Note that Profile ID is an optional field that you may use, if you choose not to use it, then please remove "&profile_id=ProfileIDnumber” from the end of this call

Add a Search Engine: Add search engine to a campaign
https://www.rankranger.com/api/v2/?add_search_engine&key=YOURAPIKEY&campaign_id=123456&se_id=se_id

Add a Keyword: An optional field is available for keyword_identifier field, allowing you to add your own unique identifier to each keyword
https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123456 &keyword=yourkeyword&keyword_identifier=your-keyword-identifier

Bulk Add Keywords: You may download and use the spreadsheet found on the Campaign Settings > Keywords screen to organize and import your keywords, or use this API
https://www.rankranger.com/api/v2/?add_bulk_keywords&key=YOURAPIKEY&campaign_id=123456&keywords=keyword1,keyword2,keyword3

You'll find additional API methods in the Account Management and Data documentation

API Query Limits


Rank Ranger APIs can pull up to 100 queries per minute. If more than 10,000 API GET requests per hour is required, then there is an option available at an additional throughput fee, contact customer service for assistance.

Rank Reporting Method Limits
  • Rank Data & Research Reporting API methods can only provide data from campaigns tracking in your Rank Ranger account.
  • You can run an unlimited number of queries through the API.
Research API Methods
  • The variety of Research Method APIs have limits on the number of queries per day based on the capacity of your package. If you require additional units, please contact customer service and an account manager will provide you with package upgrade pricing.
Search API Method Limits
  • SEO Intelligence API method query limits are based on the number of units purchased for your custom plan (e.g., 1 unit = 1 keyword tracked on 1 search engine, 1 time).
  • Search API plans do not include access to the reporting platform.

Developer API Methods


Account Management 

 

Account Data 


Reporting API



Rank Data Methods 

 


Research Methods 


Search API



SEO Intelligence Methods


These are stand-alone packages that do not include use of reports, graphs or analysis tools in the Rank Ranger platform.
 

API FAQs



API Error Codes


Code Text Description
101 Invalid Method
Method does not exist, check your syntax
102 Invalid API Key
The API Key inserted is invalid, check for key accuracy
103 Invalid Domain
The Domain requested is invalid or does not exist in your account
104 Invalid Date
The selected date range or syntax is invalid
105 Invalid Keyword
The Keyword does not exist in this campaign 
202 Invalid Campaign Name
The Campaign name is invalid or missing
203 Invalid Primary URL
The Primary URL is invalid or missing
204 Invalid Campaign ID
The Campaign ID is invalid or missing
208 Invalid Search Engine
Invalid Search Engine ID
210 Keyword already exists
The Keyword already exists in this campaign
211 Keywords exist in campaign
You need to delete Keywords from this campaign before trying to delete the campaign
212 Invalid Package ID
Invalid Package ID
215 Custom White Label URL is already in use for another campaign
The Custom URL that you have selected for your White Label Portal is in use by another campaign, please select a different URL
400 No Results
No results were found
401 Limit Reached
You have reached the maximum number of Campaigns allowed in your package

406 Too many processes requested
The account has exceeded the limit on the number of exports that can be run and stored via the Tools > Utilities > Campaign Export tool. After downloading the files, you may delete them in the Campaign Export screen or via the API.



Get the ultimate SEO tools with the Rank Ranger Software
Learn More About Rank Ranger