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
  • Dmoz listings 

Refer to the 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 a comma between multiple IDs 
date yyyy-mm-dd Requested data date
data_type
string domain_metrics provides Google, Majestic, Ahrefs, Moz, 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

More

How to Obtain API Access

More

How to Generate New API Keys

More

API Console: Construct & Test API Requests

More

API Query Limits

More

Developer API Methods

More

API Error Codes

More

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