Do you offer a tool to help me create my API requests?
Yes, you may refer to the specific documentation for the API method you want to utilize for examples of URL construction, or you may use our API Console for most methods.
To make construction of API requests easy, we offer this API testing tool. Most parameters are included in the options of the console, however, you may need to add custom option parameters to your API requests based on the specific API you're using. 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:
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.
Getting Started: Samples of APIs used for Creating Campaigns
We recommend reviewing our Best Practices Guide
prior to structuring campaigns.
Get Packages Info
: Required when there is more than 1 package in an account
Add a Profile
: An option for adding an identifier to your campaigns for categorization (e.g., by language, country, etc)
Get Profile ID list
: Optional Data needed for Add a Campaign
Obtain the Search Engine List
: Data needed for Add a Campaign
Add a Campaign
: Create a new campaign, response will include the Campaign ID number that is needed for adding a search engine and keywords
*Note that Profile ID is an optional field that you may use, if you choose not to use it, then please remove "&profile_id=ProfileIDnumber” from the end of this call
Add a Search Engine
: Add search engine to a campaign
Add a Keyword
: An optional field is available for keyword_identifier field, allowing you to add your own unique identifier to each keyword
Bulk Add Keywords
: You may download and use the spreadsheet found on the Campaign Settings > Keywords screen to organize and import your keywords, or use this API
You'll find additional API methods in the Account Management and Data documentation