Search our Knowledge Base
Search

Market Reach API



The market_reach method provides Market Reach data using a scalable metric to measure the potential revenue of a business opportunity on a global scale for tracked keywords.

The market_reach method returns the keyword total volume, search engine URL, search engine rank, and market reach of keywords in a campaign for a specific date, plus:
  • Approximate Monthly Search: the sum of all the Keyword’s Total Volumes
  • Total Monthly Reach:  the sum of all the Keywords’ Reach values for the campaign across all the search engines combined.
  • Approximate Daily Search: a calculation of the Approximate Monthly Searches divided by 30 days
  • Total Organic Reach: Total Monthly Reach divided by the Total Volume of monthly searches for the keywords in the campaign.
  • Keyword Tags: optional

Refer to Market Reach documentation for more information on the metrics.

Refer to Rank Ranger API Overview page for information on how to obtain API access, obtain an API Key, error codes and a full list of API methods.

 

Parameters

 
key string The unique API key assigned to your account
domain tld Top level domain requested
date yyyy-mm-dd Requested data date
campaign_id
string Campaign ID number
pos int Rank Reach Value percentage assigned to each rank  position
search engine
int Search Engine Market Share percentage assigned to Google, Bing, Yahoo
and Other based on your targeting and market focus for the specific campaign. 
In this example, Google is set at 50%, Bing at 20% and Other (e.g., Google Mobile) at 30%:
&google=50&bing=20&other=30
Tags int Optional: to include Keyword Tags in the results add this parameter to the request:
&show_tags=true


Example

 
Construct & test API requests in the API Console or follow this example:

https://rankranger.com/api/v2/?market_reach&key=YOURAPIKEY&campaign_id=YourCampaignID&domain=yourdomain.com&date=2016-01-31&pos_1=90&pos_2=80&pos_3=70&pos_4=60&pos_5=50&pos_6=40&pos_7_10=30&pos_11_20=20&pos_20_plus=10&google=70&bing=20&yahoo=10&other=0

In the above example, we have used the following values. Please refer to Market Reach documentation for more information about these metrics and determine the settings that best match your market focus.
Rank Reach Value
  • pos_1=90
  • pos_2=80
  • pos_3=70
  • pos_4=60
  • pos_5=50
  • pos_6=40
  • pos_7_10=30
  • pos_11_20=20
  • pos_20_plus=10
Search Engine Market Share Percentage
  • google=70
  • bing=20
  • yahoo=10
  • other=0

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


Response

 
<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="12:28:59" status="ok">
   
<keyword_results>
     - <keyword>
   
     <name>camera</name>
        <total_volume>
31714</total volume>
        - <search_engines>
            - <se>
                 <se_name>
Google USA</se_name>
                 <se_url>google.com</se_url>
                
<rank>18</rank>
                 <reach>
4440</reach>
              </se>
            - <se>                
                <
se_name>
Bing USA</se_name>
                 <se_url>
bing.com</se_url>
                
<rank>
2</rank>
                 <reach>
5074</reach>
              </se>

            - <se>
                 <se_name>
Yahoo USA</se_name>
                 <se_url>
yahoo.com</se_url>
                
<rank>
6</rank>
                 <reach>
1269</reach>
              </se>

          </search_engines>
      </keyword>
     - <keyword>
   
     <name>
digital camera</name>
        <total_volume>
7714</total volume>
        - <search_engines>
            - <se>
                 <se_url>
google.com</se_url>
                
<rank>
19</rank>
                 <reach>
1080</reach>
              </se>
            - <se>
                 <se_url>
bing.com</se_url>
                
<rank>
2</rank>
                 <reach>
1234</reach>
              </se>

            - <se>
                 <se_url>
yahoo.com</se_url>
                
<rank>
1</rank>
                 <reach>
694</reach>
              </se>

          </search_engines>
      </keyword>
[continued for each keyword]
   </keyword_results>
  - <summary>
      <daily_search>
112132</daily_search>
      <monthly_search>
3363955</monthly_search>
      <monthly_reach>
243482</monthly_reach>
      <organic_reach>
7.2%</organic_reach>
    </summary>
 </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 > 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.

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 acccount administrator to request that your user permissions be set to include access to the Account > API and 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. 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

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. 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



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 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