Refer to 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 |
profile_id or profile_ref_id |
int string |
Profile ID (can be obtained using the Get All Profiles method) Optional: your internal profile_ref_id can be used instead of profile_id if this parameter has been added to your account (refer to Add Profile). |
https://www.rankranger.com/api/v2/?get_profile_campaigns&key=YOURAPIKEY&profile_id=12 |
Example using YOUR Profile Reference ID https://www.rankranger.com/api/v2/?get_profile_campaigns&key=YOURAPIKEY&profile_ref_id=your-profile-identifier |
<?xml version="1.0" encoding="utf-8"?> <tracking-data provider="rankranger" date="02/01/2016" time="16:53:12" status="ok" > <profile> <campaign> <profile_id>12</profile_id> <profile_name>Music City</profile_name> <profile_ref_id>Your Profile Reference ID</profile_ref_id> </profile> <campaigns> - <campaign> <campaign_id>12345</campaign_id> <campaign_name>Music City Events</campaign_name> <main_domain>your-domain.com</main_domain> <reference_id>Your Reference ID</reference_id> - <portal> <custom_url>test-url.com</custom_url> <password>demo</password> <direct_url_active>true</direct_url_active> <direct_url>http://demo.bestseoreports.com/report/?r=123&abc=X1y2Z3D</direct_url> </portal> - </campaign> - <campaign> <campaign_id>98765</campaign_id> <campaign_name>Music City Musicians</campaign_name> <main_domain>your-domain.com/musicians</main_domain> <reference_id>Your Reference ID</reference_id> - <portal> <custom_url/> <password/> <direct_url_active>false</direct_url_active> <direct_url/> </portal> - </campaign> </campaigns> </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. |