Search our Knowledge Base
Search

Rank Stats API



The rank stats method returns ranking data for all keywords in a campaign for a specific date including URL, landing page, keyword, tags for that keyword, rank, search volume and search engine.

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
domain tld Top level domain requested
date yyyy-mm-dd Requested data date
campaign_id
string Campaign ID number
keyword_id string Optional: you can add the &additional_tags=keyword_id parameter to the end of the call and it will display the Rank Ranger keyword_id in the success response
se_id string Optional: you can add the &se_id parameter to the end of the call and in the success response only the results for the search engine id you enter will display.
best_rank string Optional: you can add the &include_best_rank=true  parameter to the end of the call and it will display the best rank an individual keyword has achieved since we began tracking it.


Example

 

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

https://www.rankranger.com/api/v2/?rank_stats&key=YOURAPIKEY&date=2016-07-31&domain=yourdomain.com&campaign_id=YourCampaignID

Example with call to retrieve keyword_id and best rank
https://www.rankranger.com/api/v2/?rank_stats&key=YOURAPIKEY&date=2016-07-31&domain=yourdomain.com&campaign_id=YourCampaignID
&additional_tags=keyword_id&include_best_rank=true

Example with call to retrieve results for only a specific search engine and keyword
https://www.rankranger.com/api/v2/?rank_stats&key=YOURAPIKEY&domain=yourdomain.com&date=2016-07-31&se_id=1&keyword=your keyword 

The default output is in XML format, if you would like the output to be json the you will need to add "&output=json” at the end of the string



Response

 
<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="12:28:59" status="ok" total_results="311">
   
<result>
   
   <date>07/31/2016</date>
      
<url>yourdomain.com</url>
      <lp>
/electronics/cameras</lp>
      <keyword>
camera</keyword>
      <keyword_id>123456</keyword_id>
      <tags>
        <tag>
sony</tag>
     </tags>
      <search_volume>
25100</search_volume>
     
<se>google.com</se>
      <se_name>Google USA</se_name>
      <rank>3</rank>
      <best_rank>1
</best_rank>
    </
result>
   <result>
   
   <date>07/31/2016</date>
      
<url>yourdomain.com</url>
      <lp>
/electronics/cameras</lp>
      <keyword>digital camera</keyword>
      
<keyword_id>123457</keyword_id>
      <tags>
      <tag>sony</tag>
    </tags>
      <search_volume>
18109</search_volume>
     
<se>google.com</se>
      <se_name>Google USA</se_name>
      
<rank>4</rank>
      <best_rank>2</best_rank>

    </
result>
etc.

 

API Console: Construct & Test API Requests


Using the Method options information, you can construct and test API requests using Rank Ranger's API Console (accessed via Tools > Utilities in the top navigation and the API Console link in the bottom navigation when you're logged into your account).  Simply:
  • Select the desired Method
  • Complete the applicable fields based on the specific method (e.g., Campaign ID, Package ID, Profile ID, Date Range, Domain URL, Keyword)
  • Click the Generate button
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 applications.

Rank Ranger API Testing Tool


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