Search our Knowledge Base
Search

Average Rank API



The average rank method returns ranking data for the selected domain within a specific date range with minimum, maximum and average rank.  Available options include Keyword ID, list of Tags per keyword, and filtering results for a specific tag.

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

 

 

Parameters

 
key string The unique API key assigned to your account
campaign_id tld Campaign ID number
domain tld Top level domain requested. This can be the primary domain or one of the competitor domains.
start_date yyyy-mm-dd Requested data start date
end_date yyyy-mm-dd Requested data end date

keyword_id string Optional: you can add the &additional_tags=keyword_id parameter to the end of the request and it will display the Rank Ranger keyword_id in the success response
show_tags string Optional: you can add the &additional_tags=show_tags parameter to the end of the request and it will display a list of tags per keyword
tag_filter string Optional: you can add the &tag_filter=YourTagName parameter to the end of the request to filter the results by a single tag. The Tag Name must be entered exactly the way it displays in the Campaigns Settings > Keywords screen, so if you are using Tag Manager, you need to enter the Tag Group: Tag Option (e.g., if you have a Tag Group named branded product and a Tag Option named blue widgets, you should enter &tag_filter=branded product: blue widgets at the end of the request string.


 

Examples

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

https://www.rankranger.com/api/v2/?average&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD

Example to retrieve keyword_id

https://www.rankranger.com/api/v2/?average&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&additional_tags=keyword_id

Example including show tags

https://www.rankranger.com/api/v2/?average&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&show_tags=true

Example including tag filter

https://www.rankranger.com/api/v2/?average&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&tag_filter=YourTagName

Example including all options and tag filter

https://www.rankranger.com/api/v2/?average&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&tag_filter=YourTagName&additional_tags=keyword_id&show_tags=true

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="07/02/2017" time: "13:35:06" status="ok" total_results="90">
   <result>
   
   <dates>06/01/2017-06/30/2017</dates>
      
<url>apple.com</url>
      <keyword_id>876543</keyword_id>
      <keyword>
           <
name>apple</name>
      <tags>
           <tag>brand: brand name</tag>
      </tags>
      </keyword>
      
<se>google.com</se>
      <se_name>Google USA</se_name>
      <min_rank>1</min_rank>
      <max_rank>1</max_rank>
      <avg_rank>1.00</avg_rank>
    </
result>
 
  <result>
   
   <dates>06/01/2017-06/30/2017</dates>
      
<url>apple.com</url>
      <keyword_id>876542</keyword_id>
      <keyword>
           <
name>ipad</name>
      <tags>
           <tag>branded product: brand</tag>
      </tags>
      </keyword>
      
<se>google.com</se>
      <se_name>Google USA</se_name>
      <min_rank>1</min_rank>
      <max_rank>1</max_rank>
      <avg_rank>1.00</avg_rank>
    </
result>
etc.


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