Search our Knowledge Base
Search

Add Campaign API



The add_campaign method allows you to add a new campaign to your account. 


 
 

Parameters

 
 
key string The unique API key assigned to your account
campaign_name string The campaign name
campaign_domain string The primary URL/domain for your campaign
campaign_ranking_system string The ranking system you would like to setup for this campaign
Available parameters:
  • count_as_is – for SERP (count as is) ranking system
  • explicit_domain_count – for SERP (explicit domain count) ranking system; ignores duplicate domains in SERPs
  • exact – for Exact URL ranking system; track rank for specific page or section within a website
Refer to Ranking System Count documentation for examples and additional information.
profile_id or

profile_ref_id
int

string
Profile ID (refer to Get All Profiles to obtain a list of Profile IDs.)

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).
reference_id string Optional parameter for your internal reference, e.g., primary domain identifier. Character limit is 50 English letters, numbers and/or the characters ". _ -"
package_id string If you have more than one package in your account, you need to include the package ID in order for the campaign to be added to the correct package.
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)


Examples

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

https://www.rankranger.com/api/v2/?add_campaign&key=YOURAPIKEY&campaign_name=yourcampaignname
&campaign_domain=yourdomain.com&campaign_ranking_system=count_as_is&package_id=123456789

Example including profile ID
https://www.rankranger.com/api/v2/?add_campaign&key=YOURAPIKEY&campaign_name=yourcampaignname
&campaign_domain=yourdomain.com&campaign_ranking_system=count_as_is&profile_id=ProfileIDnumber&package_id=123456789

Example including your reference ID
https://www.rankranger.com/api/v2/?add_campaign&key=YOURAPIKEY&campaign_name=yourcampaignname
&campaign_domain=yourdomain.com&campaign_ranking_system=count_as_is&reference_id=YourReferenceID&package_id=123456789

Example including your profile and your reference ID
https://www.rankranger.com/api/v2/?add_campaign&key=YOURAPIKEY&campaign_name=yourcampaignname
&campaign_domain=yourdomain.com&campaign_ranking_system=count_as_is&profile_ref_id=YourProfileReferenceID
&reference_id=YourReferenceID&package_id=123456789


Response

 
<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="19:15:12" status="ok" >
  
<new_campaign_id>1234567</new_campaign_id
</tracking-data>
 

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

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.

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

406 Too many processes requested
The account has exceeded the limit on the number of exports that can be run and stored via the Tools > Utilities > Campaign Export tool. After downloading the files, you may delete them in the Campaign Export screen or via the API.



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