Search our Knowledge Base
Search

Get Campaign Info API




The get_campaign_info method allows you to get all the information for a campaign in your account.

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.
 
 

Parameters

 
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).
show_tags true Optional parameter can be used to retrieve keyword tags
include_rank_stats true Optional parameter can be used to retrieve rank stats for the past month (average rank per search engine, daily changes in rank position per search engine, overall performance per search engine since rank tracking began, and visibility score per tracked search engine).


Example

 
https://www.rankranger.com/api/v2/?get_campaign_info&key=YOURAPIKEY&campaign_id=XXXXX

Example with show_tags

https://www.rankranger.com/api/v2/?get_campaign_info&key=YOURAPIKEY&campaign_id=XXXXX&show_tags=true

Example with include_rank_stats

https://www.rankranger.com/api/v2/?get_campaign_info&key=YOURAPIKEY&campaign_id=XXXXX&include_rank_stats=true

Example with show_tags and rank_stats

https://www.rankranger.com/api/v2/?get_campaign_info&key=YOURAPIKEY&campaign_id=XXXXX&show_tags=true&include_rank_stats=true

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="01/01/2017" time="13:51:09" status="ok" >
<result>
  <campaign_id>12345</campaign_id>  
  <campaign_name>Your Campaign</campaign_name>  
  <main_domain>yourdomain.com</main_domain>
  <campaign_manager>Dave (if applicable)</campaign_manager>
  <industry/>
  <profile_name>ecommerce (if applicable)</profile_name>
  <reference_id>your internal reference (if applicable)</reference_id>   
  <package>Premium</package>  
  <keywords_count>67</keywords_count>
  <keywords>
     <keyword>keyword 1</keyword>  
     <keyword>keyword 2</keyword>  
     <keyword>keyword 3</keyword>  
     <keyword>keyword 4</keyword> 
... continued for each keyword 
  </keywords>
   <search_engines>
    <se>
      <id>1*</id>  
     <name>Google (USA)</name>  
     <url>google.com</url>  
     <country>UNITED STATES</country>  
     <local_business_name>Google Business Page Title (if applicable)</local_business_name>  
     <local_business_url>yourdomain.com</local_business_url>  
   </se>
    <se>
     <id>186</id>  
     <name>Google Maps</name>  
     <url>google.com</url>  
     <country>UNITED STATES</country>  
   </se>
 </search_engines>
   <domains>
      <domain>your-domain.com</domain>  
      <domain>competitor-1.com</domain>  
      <domain>competitor-2.com</domain>  
   </domains>
   <portal> (if applicable)
      <custom_url>name</custom_url>  
      <password>123456</password>  
      <direct_url_active>false</direct_url_active>  
   </portal>
  </result>
</tracking-data>
 
* Refer to Search Engine List API

Response including Keyword Tags

 
When Keyword Tags are set to true, then the keywords section of the response includes the tags for the keywords that have tags and for those that don't, the result is displayed as <tags/>


  <keywords>
      <keyword>
        <name>keyword 1</name> 
        <tags/>
      </keyword> 
      <keyword>
        <name>keyword 2</name> 
        <tags>
            <tag>your keyword tag</tag>
         <tags/>
      </keyword> 
      <keyword>
        <name>keyword 3</name> 
        <tags>
           <tag>your keyword tag</tag>
         <tags/>
      </keyword> 
      <keyword>
        <name>keyword 4</name> 
        <tags/>
      </keyword> 
  </keywords>
  
 


Response including Rank Stats

 
When rank_stats is set to true, the results include average rank per search engine, daily changes in rank position per search engine, overall performance per search engine since rank tracking began, and visibility score per tracked search engine - all for the past month - as in this example.


<rank_stats>
   <total_keywords>15</total_keywords>
   <total_search_engines>2</total_search_engines>
   <stats>
     <avg_rank>
       <se>
        <se_id>1</se_id>
          <today>8.47</today>
          <week>5.67</week>
          <month>9.93</month>
       </se>
       <se>
        <se_id>186</se_id>
          <today>2.90</today>
          <week>2.50</week>
          <month>3.90</month>
       </se>
     </avg_rank>
     <daily_change>
       <se>
       <se_id>1</se_id>
          <up>1</up>
          <down>1</down>
          <none>13</none>
       </se>
       <se>
       <se_id>186</se_id>
          <up>0</up>
          <down>1</down>
          <none>14</none>
       </se>
     </daily_change>
     <overall_performance>
       <se>
       <se_id>1</se_id>
          <min_rank>10.0000</min_rank>
          <max_rank>8.4667</max_rank>
       </se>
       <se>
       <se_id>186</se_id>
          <min_rank>6.6250</min_rank>
          <max_rank>1.6250</max_rank>
       </se>
     </overall_performance>
     <visibility>
       <se>
       <se_id>1</se_id>
         <vis_results>
          <vis_result>
            <date>2017-01-12</date>
            <score>324</score>
          </vis_result>
... continued for month 
          <vis_result>
            <date>2017-02-12</date>
            <score>363</score>
          </vis_result>
        </vis_results>
     </se>
... continued for each search engine
     </visibility>
   </stats>
</rank_stats>
 



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.

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


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



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