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.

How to Obtain API Access


If you 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.

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


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

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.
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

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



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