Documentation > Reporting API > Rank Data Methods

Rank Stats API

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

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.

Table of Contents

Parameters

key	string	The unique API key assigned to your account
domain	tld	Top level domain requested: this must be a domain that is being tracked in the campaign
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 Rank Ranger began tracking it.
rank_breakdown	string	Optional: you can add the &rank_breakdown=true parameter to the end of the request and it will include a breakdown of the number of keywords that ranked in each rank position or range.
output	string	Output format options: &output=xml (this is the default format) &output=json Either of these parameters can be added to the json output parameter: &output=json&json_strict=true (forces the results to come back as array instead of objects) &output=json&json_arr=true (causes the entire json to be wrapped as array)

Example

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

Base URL
https://www.rankranger.com/api/v2/?rank_stats&key=YOURAPIKEY&campaign_id=XXXXX&domain=example.com&date=YYYY-MM-DD

Example with call to retrieve keyword_id and best rank
https://www.rankranger.com/api/v2/?rank_stats&key=YOURAPIKEY&campaign_id=XXXXX&domain-example.com&date=YYYY-MM-DD&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=YYYY-MM-DD&se_id=XXX&keyword=your keyword

Response

URL for this example:
https://www.rankranger.com/api/v2/?rank_stats&key=YourAPIKey&date=YYYY-MM-DD&campaign_id=12345&se_id=123&domain=example.com&rank_breakdown=true&include_best_rank=true

<tracking-data provider="rankranger" date="07/10/2019" time="14:08:32" status="ok" total_results="59">
    <results>
        <result>
            <date>07/10/2019</date>
            <url>www.allrecipes.com</url>
            <lp>/recipes/84/healthy-recipes/</lp>
            <keyword>healthy recipes</keyword>
            <tags>
                <tag>healthy</tag>
            </tags>
            <search_volume>246000</search_volume>
            <se>google.com</se>
            <se_name>Google USA</se_name>
            <rank>3</rank>
            <best_rank>1</best_rank>
        </result>
        <result>
            <date>07/10/2019</date>
            <url>www.allrecipes.com</url>
            <lp>
/recipes/453/everyday-cooking/family-friendly/kid-friendly/
</lp>
            <keyword>recipes for kids</keyword>
            <tags/>
            <search_volume>40500</search_volume>
            <se>google.com</se>
            <se_name>Google USA</se_name>
            <rank>1</rank>
            <best_rank>1</best_rank>
        </result>
        <result>
            <date>07/10/2019</date>
            <url>www.allrecipes.com</url>
            <lp>/recipes/156/bread/</lp>
            <keyword>bread recipes</keyword>
            <tags/>
            <search_volume>90500</search_volume>
            <se>google.com</se>
            <se_name>Google USA</se_name>
            <rank>1</rank>
            <best_rank>1</best_rank>
        </result>
        <result>
            <date>07/10/2019</date>
            <url>www.allrecipes.com</url>
            <lp>/recipe/12682/apple-pie-by-grandma-ople/</lp>
            <keyword>best apple pie recipe</keyword>
            <tags>
                <tag>dessert</tag>
            </tags>
            <search_volume>14800</search_volume>
            <se>google.com</se>
            <se_name>Google USA</se_name>
            <rank>2</rank>
            <best_rank>1</best_rank>
        </result>
        <result>
            <date>07/10/2019</date>
            <url>www.allrecipes.com</url>
            <lp>/recipe/219165/chef-johns-easy-apple-pie/</lp>
            <keyword>how to make apple pie</keyword>
            <tags>
                <tag>dessert</tag>
            </tags>
            <search_volume>22200</search_volume>
            <se>google.com</se>
            <se_name>Google USA</se_name>
            <rank>2</rank>
            <best_rank>1</best_rank>
        </result>
        <result>
            <date>07/10/2019</date>
            <url>www.allrecipes.com</url>
            <lp>/recipes/76/appetizers-and-snacks/</lp>
            <keyword>appetizer ideas</keyword>
            <tags>
                <tag>appetizers</tag>
            </tags>
            <search_volume>12100</search_volume>
            <se>google.com</se>
            <se_name>Google USA</se_name>
            <rank>3</rank>
            <best_rank>1</best_rank>
        </result>
      
      *** CONTINUES FOR EACH KEYWORD ***     
       
    </results>
    <rank_breakdown>
        <result>
            <se>
                <id>1</id>
                <name>Google USA</name>
                <url>google.com</url>
            </se>
            <ranks>
                <rank>
                    <position>1</position>
                    <count>14</count>
                </rank>
                <rank>
                    <position>2</position>
                    <count>12</count>
                </rank>
                <rank>
                    <position>3</position>
                    <count>9</count>
                </rank>
                <rank>
                    <position>1-3</position>
                    <count>35</count>
                </rank>
                <rank>
                    <position>4-7</position>
                    <count>9</count>
                </rank>
                <rank>
                    <position>4-10</position>
                    <count>11</count>
                </rank>
                <rank>
                    <position>8-10</position>
                    <count>2</count>
                </rank>
                <rank>
                    <position>1-10</position>
                    <count>46</count>
                </rank>
                <rank>
                    <position>1-20</position>
                    <count>52</count>
                </rank>
                <rank>
                    <position>11-20</position>
                    <count>6</count>
                </rank>
                <rank>
                    <position>21-30</position>
                    <count>2</count>
                </rank>
                <rank>
                    <position>21-50</position>
                    <count>4</count>
                </rank>
                <rank>
                    <position>31-40</position>
                    <count>2</count>
                </rank>
                <rank>
                    <position>41-50</position>
                    <count>0</count>
                </rank>
                <rank>
                    <position>51-100</position>
                    <count>0</count>
                </rank>
                <rank>
                    <position>100+</position>
                    <count>3</count>
                </rank>
            </ranks>
        </result>
    </rank_breakdown>
</tracking-data>

AخA
 
<tracking-data provider="rankranger" date="07/10/2019" time="14:08:32" status="ok" total_results="59">    <results>        <result>            <date>07/10/2019</date>            <url>www.allrecipes.com</url>            <lp>/recipes/84/healthy-recipes/</lp>            <keyword>healthy recipes</keyword>            <tags>                <tag>healthy</tag>            </tags>            <search_volume>246000</search_volume>            <se>google.com</se>            <se_name>Google USA</se_name>            <rank>3</rank>            <best_rank>1</best_rank>        </result>        <result>            <date>07/10/2019</date>            <url>www.allrecipes.com</url>            <lp>/recipes/453/everyday-cooking/family-friendly/kid-friendly/</lp>            <keyword>recipes for kids</keyword>            <tags/>            <search_volume>40500</search_volume>            <se>google.com</se>            <se_name>Google USA</se_name>            <rank>1</rank>            <best_rank>1</best_rank>        </result>        <result>            <date>07/10/2019</date>            <url>www.allrecipes.com</url>            <lp>/recipes/156/bread/</lp>            <keyword>bread recipes</keyword>            <tags/>            <search_volume>90500</search_volume>            <se>google.com</se>            <se_name>Google USA</se_name>            <rank>1</rank>            <best_rank>1</best_rank>        </result>        <result>            <date>07/10/2019</date>            <url>www.allrecipes.com</url>            <lp>/recipe/12682/apple-pie-by-grandma-ople/</lp>            <keyword>best apple pie recipe</keyword>            <tags>                <tag>dessert</tag>            </tags>            <search_volume>14800</search_volume>            <se>google.com</se>            <se_name>Google USA</se_name>            <rank>2</rank>            <best_rank>1</best_rank>        </result>        <result>            <date>07/10/2019</date>            <url>www.allrecipes.com</url>            <lp>/recipe/219165/chef-johns-easy-apple-pie/</lp>            <keyword>how to make apple pie</keyword>            <tags>                <tag>dessert</tag>            </tags>            <search_volume>22200</search_volume>            <se>google.com</se>            <se_name>Google USA</se_name>            <rank>2</rank>            <best_rank>1</best_rank>        </result>        <result>            <date>07/10/2019</date>            <url>www.allrecipes.com</url>            <lp>/recipes/76/appetizers-and-snacks/</lp>            <keyword>appetizer ideas</keyword>            <tags>                <tag>appetizers</tag>            </tags>            <search_volume>12100</search_volume>            <se>google.com</se>            <se_name>Google USA</se_name>            <rank>3</rank>            <best_rank>1</best_rank>        </result>            *** CONTINUES FOR EACH KEYWORD ***                </results>    <rank_breakdown>        <result>            <se>                <id>1</id>                <name>Google USA</name>                <url>google.com</url>            </se>            <ranks>                <rank>                    <position>1</position>                    <count>14</count>                </rank>                <rank>                    <position>2</position>                    <count>12</count>                </rank>                <rank>                    <position>3</position>                    <count>9</count>                </rank>                <rank>                    <position>1-3</position>                    <count>35</count>                </rank>                <rank>                    <position>4-7</position>                    <count>9</count>                </rank>                <rank>                    <position>4-10</position>                    <count>11</count>                </rank>                <rank>                    <position>8-10</position>                    <count>2</count>                </rank>                <rank>                    <position>1-10</position>                    <count>46</count>                </rank>                <rank>                    <position>1-20</position>                    <count>52</count>                </rank>                <rank>                    <position>11-20</position>                    <count>6</count>                </rank>                <rank>                    <position>21-30</position>                    <count>2</count>                </rank>                <rank>                    <position>21-50</position>                    <count>4</count>                </rank>                <rank>                    <position>31-40</position>                    <count>2</count>                </rank>                <rank>                    <position>41-50</position>                    <count>0</count>                </rank>                <rank>                    <position>51-100</position>                    <count>0</count>                </rank>                <rank>                    <position>100+</position>                    <count>3</count>                </rank>            </ranks>        </result>    </rank_breakdown></tracking-data>

How to Obtain API Access

How to Generate New API Keys

API Console: Construct & Test API Requests

API Query Limits

Developer API Methods

API Error Codes

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

Featured SEO Tools

SEO Dashboard Rank Tracker Social Analytics Link Manager White Label SEO

Marketing Dashboard Keyword Finder Insight Graph API

Resources

Top 100 Websites Rank Risk Index Google Algorithm Updates Google SERP Features Tool Mobile SERP Features Tool Visual Guide to SERP Features SEO Glossary

Rank Ranger

Pricing Contact us Blog Help Center Documentation Brand Ambassadors

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 Campaigns > Import & Export > Campaign Export tool. After downloading the files, you may delete them in the Campaign Export screen or via the API.

Rank Stats API

Parameters

Example

Response

How to Obtain API Access

How to Generate New API Keys

API Console: Construct & Test API Requests

Getting Started: Samples of APIs used for Creating Campaigns

API Query Limits

Developer API Methods

Account Management

Account Data

Reporting API

Rank Data Methods

Research Methods

Search API

SEO Intelligence Methods

API FAQs

API Error Codes