Search our Knowledge Base
Search

Client Dashboard Public Access API



The set_white_label_portal method allows you to manage access to your White Label Client Dashboard for any campaign by creating a custom URL or enabling public access, resetting public access and then disabling public access.

Use of the optional Profile ID or Profile Reference ID parameter allows you to show additional campaigns in one white label portal.

Refer to the 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.

client dashboard example
 

 

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).
White Label Portal Access Options
string
  • direct_public_access=enabled – for enabling public access to a campaign in White Label Client Dashboard
  • reset_public_url=true – for voiding a used URL and resetting a new public URL, this request returns the new public access URL
  • direct_public_access=disabled – for disabling public access (e.g., when a session ends)
  • custom_url= - create a custom URL for a campaign
  • profile_id or use your internal profile_ref_id to view multiple campaigns in one white label dashboard. This parameter must already exist in your account (refer to Add Profile) and be referenced in each of the campaigns you want to view.  Refer to Get All Profiles to obtain a list of Profile IDs.

Construct & test API requests in the API Console
or follow one of the examples below.


Public Access Enable/Disable Example

 
Public Access Enabled
https://www.rankranger.com/api/v2/?set_white_label_portal&key=YOURAPIKEY
&campaign_id=1234&direct_public_access=enabled

Public Access Disabled
https://www.rankranger.com/api/v2/?set_white_label_portal&key=YOURAPIKEY
&campaign_id=1234&direct_public_access=disabled

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


Public Access Enable/Disable Response

 
Public Access Enabled
<?
xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="13:10:05" status="ok" >
  
<direct_public_access>enabled</direct_public_access>  
</tracking-data>

Public Access Disabled
<?
xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="13:11:05" status="ok" >
  
<direct_public_access>disabled</direct_public_access>  
</tracking-data>
 
 
 

Reset Public Access Example

 
https://www.rankranger.com/api/v2/?set_white_label_portal&key=YOURAPIKEY&campaign_id=1234
&reset_public_url=true

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


Reset Public Access Response

 
This request returns the new public access URL

<?
xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="17:23:05" status="ok" >
  
<direct_public_url>http://yourdomain.com/report/?r=1234&wlp=f123g456h789aceg9876x
  </
direct_public_url>  
</tracking-data>
 

Custom URL Example

 
https://www.rankranger.com/api/v2/?set_white_label_portal&key=YOURAPIKEY&campaign_id=1234
&custom_url=your-name

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


Custom URL Response

 
<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="13:23:05" status="ok" >
  
<custom_url>http://subdomain.bestseoreports.com/your-name
  </
custom_url>  
</tracking-data>
 

Your Reference ID & Profile Reference ID Example

 
https://www.rankranger.com/api/v2/?set_white_label_portal&key=YOURAPIKEY&reference_id=Your-ReferenceID
&profile_ref_id=Your-ProfileReferenceID&reset_public_url=true

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


Your Reference IDs Response

 
<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="06/25/2014" time="13:23:05" status="ok" >
    <direct_public_url>
     http://.bestseoreports.com/report/?r=xxxx&wlp=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   </direct_public_url
</tracking-data>
 


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