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.
Table of Contents
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. |
output | string | Output format options:
|
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&output=json |
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&output=xml |
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 |
<tracking-data provider="rankranger" date="05/07/2019" time="13:17:26" status="ok" total_results="118">
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>holiday recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>12</max_rank>
<avg_rank>8.76</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>chicken recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>10</max_rank>
<avg_rank>6.93</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>seafood recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>9</max_rank>
<avg_rank>6.43</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>11</min_rank>
<max_rank>11</max_rank>
<avg_rank>11.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>recipes for kids</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>7</max_rank>
<avg_rank>4.23</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>bread recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>7</max_rank>
<avg_rank>4.87</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>best apple pie recipe</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>2</max_rank>
<avg_rank>1.93</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>how to make apple pie</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>2</max_rank>
<avg_rank>2.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>appetizer ideas</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>4</min_rank>
<max_rank>6</max_rank>
<avg_rank>4.37</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>desert recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>8</max_rank>
<avg_rank>4.33</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>what to make for breakfast</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>5</min_rank>
<max_rank>17</max_rank>
<avg_rank>10.76</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>what to make for lunch</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>6</min_rank>
<max_rank>8</max_rank>
<avg_rank>7.17</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>what to make for dinner</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>14</min_rank>
<max_rank>24</max_rank>
<avg_rank>19.97</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>11</max_rank>
<avg_rank>9.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>salad recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>12</max_rank>
<avg_rank>9.33</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>easy salads</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>4</min_rank>
<max_rank>6</max_rank>
<avg_rank>5.47</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>salad ideas</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>5</min_rank>
<max_rank>11</max_rank>
<avg_rank>8.20</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>slow cooker recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>7</max_rank>
<avg_rank>4.33</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>crock pot recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>11</min_rank>
<max_rank>12</max_rank>
<avg_rank>11.58</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>dinner recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>11</max_rank>
<avg_rank>9.23</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>pasta recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>5</min_rank>
<max_rank>10</max_rank>
<avg_rank>7.52</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>lunch recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>6</max_rank>
<avg_rank>3.07</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>soup recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>11</max_rank>
<avg_rank>6.47</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>stew recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>5</max_rank>
<avg_rank>3.80</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>mexican food recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>4</max_rank>
<avg_rank>2.87</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>french food recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>13</max_rank>
<avg_rank>10.82</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>chinese food recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>10</max_rank>
<avg_rank>7.68</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>japanese food recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>11</max_rank>
<avg_rank>6.43</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>italian food recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>3</max_rank>
<avg_rank>1.30</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>chocolate cake recipe</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>1</max_rank>
<avg_rank>1.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>cookie recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>2</max_rank>
<avg_rank>1.07</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>best chocolate chip cookies recipe</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>1</max_rank>
<avg_rank>1.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>dessert recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>8</max_rank>
<avg_rank>3.91</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>grandma's brownies</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>4</max_rank>
<avg_rank>2.24</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>holiday cookie recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>13</max_rank>
<avg_rank>12.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy lunch recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>13</max_rank>
<avg_rank>10.07</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy cheap recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>23</min_rank>
<max_rank>24</max_rank>
<avg_rank>23.50</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy heart recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>13</max_rank>
<avg_rank>10.85</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy recipes vegetarian</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank/>
<max_rank>0</max_rank>
<avg_rank/>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy food recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>13</max_rank>
<avg_rank>11.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>low carb recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>3</min_rank>
<max_rank>7</max_rank>
<avg_rank>4.60</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy recipes for kids</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>11</min_rank>
<max_rank>11</max_rank>
<avg_rank>11.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>quick healthy recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>24</min_rank>
<max_rank>26</max_rank>
<avg_rank>25.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy diet recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>6</min_rank>
<max_rank>6</max_rank>
<avg_rank>6.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy fall recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank/>
<max_rank>0</max_rank>
<avg_rank/>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>easy healthy recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>11</max_rank>
<avg_rank>9.33</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy recipes for weight loss</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>2</min_rank>
<max_rank>12</max_rank>
<avg_rank>10.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>heart healthy recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>11</min_rank>
<max_rank>12</max_rank>
<avg_rank>11.92</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>diabetic recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>10</min_rank>
<max_rank>11</max_rank>
<avg_rank>10.92</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy recipes for two</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank/>
<max_rank>0</max_rank>
<avg_rank/>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>mexican vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>5</min_rank>
<max_rank>13</max_rank>
<avg_rank>11.92</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>simple vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>5</min_rank>
<max_rank>10</max_rank>
<avg_rank>8.50</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>quick vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>9</min_rank>
<max_rank>10</max_rank>
<avg_rank>9.92</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>tasty vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>9</min_rank>
<max_rank>9</max_rank>
<avg_rank>9.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>healthy vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>20</min_rank>
<max_rank>20</max_rank>
<avg_rank>20.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>vegetarian recipes for kids</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>92</min_rank>
<max_rank>92</max_rank>
<avg_rank>92.00</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>indian vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>1</min_rank>
<max_rank>2</max_rank>
<avg_rank>1.67</avg_rank>
</result>
<result>
<dates>04/01/2019 - 04/30/2019</dates>
<url>allrecipes.com</url>
<keyword>best vegetarian recipes</keyword>
<se>google.com</se>
<se_name>Google Mobile</se_name>
<min_rank>8</min_rank>
<max_rank>10</max_rank>
<avg_rank>9.25</avg_rank>
</result>
</tracking-data>
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. |