API Console: API Testing Tool

Select an API Method from the menu:

• Rank Stats
• Rank Top 50
  
• Average Rank
• Market Reach
• Google Suggested Search
• Google Related Search
  
• Search Engine List
• Get Campaign Info
• Get Keyword Info
• Competitors
• Additional methods are described in the API Overview.
  

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:

• 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