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>
 

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