Search our Knowledge Base
Search

Get All Campaigns in a Profile API



The get_profile_campaigns method allows you to retrieve a list of all the campaigns and their ids assigned to a specific profile. 

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
profile_id
or
profile_ref_id
int

string

Profile ID (can be obtained using the Get All Profiles method)

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



Example

 
https://www.rankranger.com/api/v2/?get_profile_campaigns&key=YOURAPIKEY&profile_id=12

Example using YOUR Profile Reference ID

https://www.rankranger.com/api/v2/?get_profile_campaigns&key=YOURAPIKEY&profile_ref_id=your-profile-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="16:53:12status="ok" >
<profile>
 <campaign>
  
  <profile_id>12</profile_id
    <profile_name>Music City</profile_name>  
    <profile_ref_id>Your Profile Reference ID</profile_ref_id

  </profile>
 <campaigns>
 - <campaign>
    <campaign_id>12345</campaign_id
    <campaign_name>Music City Events</campaign_name
    <main_domain>your-domain.com</main_domain
    <reference_id>Your Reference ID</reference_id
     - <portal>
         <custom_url>test-url.com</custom_url>  
         <password>demo</password
         <direct_url_active>true</direct_url_active
         <direct_url>http://demo.bestseoreports.com/report/?r=123&abc=X1y2Z3D</direct_url>  

      </portal>  
 -  </campaign>
 - <campaign>
    <campaign_id>98765</campaign_id>  
    <campaign_name>Music City Musicians</campaign_name
    <main_domain>your-domain.com/musicians</main_domain
    <reference_id>Your Reference ID</reference_id>  
     - <portal>
         <custom_url/>  
         <password/> 
         <direct_url_active>false</direct_url_active
         <direct_url/>  

      </portal>  
 -  </campaign>
 </campaigns>
</tracking-data>
 
Note: profile_ref_id is an optional parameter that you can use as your internal identifier for a customer or other grouping of campaigns. Profile Reference ID is included in the response only if a profile_ref_id parameter was assigned to the campaign when created or edited.

How to Obtain API Access

More

How to Generate New API Keys

More

API Console: Construct & Test API Requests

More

API Query Limits

More

Developer API Methods

More

API Error Codes

More

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