Add Profile API
method allows you to add a Profile Name, internal reference id and profile description to your account. Profiles can be used to filter or group campaigns in reports, and to group multiple campaigns in one white label portal.
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.
||The unique API key assigned to your account
||Profile name must be a unique string that does not already exist in your account.
||Optional parameter for your internal reference use. Must be unique string that does not already exist in your account. Character limit is 50 English letters, numbers and/or the characters ". _ -"
||Optional parameter for your internal reference use.
| Construct & test API requests in the API Console or follow one of these examples:
Example including Profile Description
https://www.rankranger.com/api/v2/?add_profile&key=YOURAPIKEY&profile_name=Profile Name&profile_ref_id=YourInternalReferenceID&profile_description=Your Internal description of this profile
The default output format is XML, if you want JSON simply add "&output=json
" to the end of the string.
|<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="09:30:25" status="ok" >
<profile_description>Your internal description of this profile</profile_description>
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.
You can obtain API Keys per user if your Rank Ranger account has API access by navigating to
2. Connections > API & Connected Apps
3. Click the Generate Key
4. Select a User and add a note (optional)
5. Click the Add
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:
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 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
Search API 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.
- 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.