Search our Knowledge Base
Search

Add Keyword API



The add_keyword method allows you to add one keyword with optional tag(s) to a campaign in your account. 

Campaign Keyword Limit


Please add no more than 1000 keywords per campaign in order to ensure efficient report generation and convenient viewing (this is especially important when tracking competitor URLs that you'll want to view in comparison to the primary domain). Adding more than 1000 keywords to a campaign will cause some functionality to be disabled.

If you need to track more than 1000 keywords for a site, then the best practice is to create additional campaigns (e.g., separate them by keyword category, location, tags, etc.).  If you have an Enterprise package, you can view rank performance data for multiple campaigns in the Portfolio Report and by using cross-campaign metrics in the Insight Graph and Single Metric Widgets.


 
 

Parameters

 

 Reporting Package Options



key string The unique API key assigned to your account
campaign_id or

reference_id
int

string
The campaign ID (can be obtained using the package_campaigns method)

Optional: your internal reference_id can be used instead of campaign_id if this parameter exists in the campaign (refer to Add Campaign or Update Campaign methods).
keyword string Keyword
tags string Optional: assign self-defined tags to a keyword for filtering and display in reports
keyword_id string Optional: you can add the &identifier=true parameter to the end of the call and it will display the Rank Ranger keyword_id in the success response
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 an array instead of objects) 
    • &output=json&json_arr=true 
      (causes the entire json to be wrapped as array)

 API Package Options



key string The unique API key assigned to your account
campaign_id or

reference_id
int

string
The campaign ID (can be obtained using the package_campaigns method)

Optional: your internal reference_id can be used instead of campaign_id if this parameter exists in the campaign (refer to Add Campaign or Update Campaign methods).
keyword string Keyword
keyword_id string Optional: you can add the &identifier=true parameter to the end of the call and it will display the Rank Ranger keyword_id in the success response
keyword_identifier string Optional: you can add your own unique keyword identifier (up to 50 alpha-numeric English characters)
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 an 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_keyword&key=YOURAPIKEY&campaign_id=123&keyword
=yourkeyword

Example with call to retrieve Rank Ranger's keyword_id
https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123&keyword
=yourkeyword&identifier=true

Example with Tag included
https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123&keyword
=yourkeyword&tags=my+tag+1

Example with multiple Tags included
https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123&keyword
=yourkeyword&tags=my+tag+1,my+tag+2,my+tag+3

For example, for the keyword 'sunglasses' with tags 'Summer 2015" and 'August Facebook Ad', the API request would be:

 https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123&keyword
=sunglasses&tags=Summer+2015,August+Facebook+Ad

Example with adding your own unique keyword identifier
(available only in API packages)
https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123&keyword
=yourkeyword&keyword_identifier=your-keyword-identifier

The default output format is XML, if you want JSON simply add "&output=json" to the end of the string.


Response

 
<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger"  date="02/01/2016" time="12:53:14" status="ok" >
      
<status>success</status>
   
</status>
</tracking-data>
Response with keyword identifier parameter

<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger"  date="02/01/2016" time="12:53:14" status="ok" >
      
<status>success</status>
      <keyword_id>
987654</keyword_id>
   
</status>
</tracking-data>

 

How to Obtain API Access


If you'd like to help determining which of our API plans is most appropriate for your needs, contact our service team and an account manager will be happy to assist you.

If you already have a Rank Ranger plan and see an error message when accessing the Account Settings > 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.

If your company has API services included in a plan and you aren't able to access the screen, contact your company's Rank Ranger account administrator to request that your user permissions be set to include access to the Account Settings > API & Connected Apps screen.

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. Campaigns
2. API Resources
3. API Key Generator
4. Click the Generate Key button
5. Select a User and add a note (optional)
6. Click the Add button

Generate API Key

API Console: Construct & Test API Requests


To make construction of API requests easy, we offer this API testing tool. Most parameters are included in the options of the console, however, you may need to add custom option parameters to your API requests based on the specific API you're using. 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. Campaigns
2. API Resources > API Console
3. Select the Method and complete the applicable fields
4. Click the Generate button
5. 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



Getting Started: Samples of APIs used for Creating Campaigns



We recommend reviewing our Best Practices Guide prior to structuring campaigns.

Get Packages Info: Required when there is more than 1 package in an account
https://www.rankranger.com/api/v2/?packages&key=YOURAPIKEY

Add a Profile: An option for adding an identifier to your campaigns for categorization (e.g., by language, country, etc)
https://www.rankranger.com/api/v2/?add_profile&key=YOURAPIKEY&profile_name=Profile Name&profile_ref_id=YourInternalReferenceID

Get Profile ID list: Optional Data needed for Add a Campaign
https://www.rankranger.com/api/v2/?get_all_profiles&key=YOURAPIKEY

Obtain the Search Engine List: Data needed for Add a Campaign
https://www.rankranger.com/api/v2/?se_list&key=YOURAPIKEY

Add a Campaign: Create a new campaign, response will include the Campaign ID number that is needed for adding a search engine and keywords
https://www.rankranger.com/api/v2/?add_campaign&key=YOURAPIKEY&campaign_name=yourcampaignname&campaign_domain=example.com&campaign_ranking_system
=default&profile_id=ProfileIDnumber

*Note that Profile ID is an optional field that you may use, if you choose not to use it, then please remove "&profile_id=ProfileIDnumber” from the end of this call

Add a Search Engine: Add search engine to a campaign
https://www.rankranger.com/api/v2/?add_search_engine&key=YOURAPIKEY&campaign_id=123456&se_id=se_id

Add a Keyword: An optional field is available for keyword_identifier field, allowing you to add your own unique identifier to each keyword
https://www.rankranger.com/api/v2/?add_keyword&key=YOURAPIKEY&campaign_id=123456 &keyword=yourkeyword&keyword_identifier=your-keyword-identifier

Bulk Add Keywords: You may download and use the spreadsheet found on the Campaign Settings > Keywords screen to organize and import your keywords, or use this API
https://www.rankranger.com/api/v2/?add_bulk_keywords&key=YOURAPIKEY&campaign_id=123456&keywords=keyword1,keyword2,keyword3

You'll find additional API methods in the Account Management and Data documentation

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.
Research API Methods
  • The variety of Research Method APIs have limits on the number of queries per day based on the capacity of your package. If you require additional units, please contact customer service and an account manager will provide you with package upgrade pricing.
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


Account Management 

 

Account Data 


Reporting API



Rank Data Methods 

 


Research Methods 


Search API



SEO Intelligence Methods


These are stand-alone packages that do not include use of reports, graphs or analysis tools in the Rank Ranger platform.
 

API FAQs



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 Campaigns > Import & Export > 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