Search our Knowledge Base
Search

API Console: API Testing Tool



To make construction of API requests easy, we offer this API Testing Tool which can be accessed in the Tools > Utilities section or via the API Console link in the footer of the user interface. 

Refer to Rank Ranger API for an up-to-date list of API methods.

API Console - API Testing Tool
 

Construct an API Request

 
Select API Method

Select an API Method from the menu:

Select Campaign ID

Customize API Request:

The fields that display are dependent on the Method you have chosen. In this example we're working with Rank Stats.

  • Select the Date you want data for
  • Enter the Domain URL (this can be the campaign primary domain or other URLs being tracked in the campaign)
  • Select Campaign ID or Reference ID in the Campaign ID Option field
  • Select the Campaign ID Option Value from the menu, or enter your internal Reference ID
  • If using Keyword IDs, you may check the box to include Keyword ID in the output
  • Select the desired Output type: XML or JSON
Generate API Request

Generate API Request:

  • After completing all parameters, click the Generate button
  • Click the Launch URL icon to run the API request or copy the link for use in your application

 


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