Search our Knowledge Base
Search

Add Link API



The add_link method allows you to add a new link to Link Manager. 

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.


 
 

Parameters

 
 
key string The unique API key assigned to your account
link_from URL The link source URL
link_to URL The link destination URL
manager_id int The link manager assigned to the link.
Refer to Manage Users documentation for assistance with creating account sub-users.
profile_id
int
Profile ID (refer to Get All Profiles to obtain a list of Profile IDs.)
supplier_id int Refer to Manage Contacts for assistance with creating supplier records.
anchor_text string The text that is linking to the destination URL. If the anchor is an image instead of text, you may enter [image]
link_type int Enter 1 for Paid link, 2 for Non-paid link or 3 for Link Exchange
link_position string Enter header, middle, footer or other
link_price int Optional: can be used if you want to register a paid link price
link_currency string Optional: can be used if paid link and you register a link price. Refer to ISO Codes alpha list for country currency codes (for example, United States currency code is USD).
invoice_number string Optional: can be used to store an invoice number for a paid link
link_start_date date Optional: Enter the date that the link should be live. Format: YYYY-MM-DD
link_end_date date Optional: Enter the date that the link is to expire. Format: YYYY-MM-DD
notes string Optional: you may record your internal notes (max. 255 characters)



Request Examples

 
Construct & test API requests in the API Console or follow one of these examples:

https://www.rankranger.com/api/v2/?add_link&key=YourAPIkey&manager_id=12&profile_id=18&supplier_id=1&link_from=https://www.link-source.com&link_to=https://www.link-destination.com&anchor_text=your anchor text&link_type=1&price=25.00&link_currency=USD&start_date=YYYY-MM-DD&link_position=middle

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



Response Example

            
 



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

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.

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

406 Too many processes requested
The account has exceeded the limit on the number of exports that can be run and stored via the Tools > Utilities > Campaign Export tool. After downloading the files, you may delete them in the Campaign Export screen or via the API.



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