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.

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


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>

 

API Console: Construct & Test API Requests


Using the Method options information, you can construct and test API requests using Rank Ranger's API Console (accessed via Tools > Utilities in the top navigation and the API Console link in the bottom navigation when you're logged into your account).  Simply:
  • Select the desired Method
  • Complete the applicable fields based on the specific method (e.g., Campaign ID, Package ID, Profile ID, Date Range, Domain URL, Keyword)
  • Click the Generate button
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 applications.

Rank Ranger API Testing Tool


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