LRT Link Research Tools

API Documentation

Table of Contents


API Basics

The LinkResearchTools API allows you to start JUICE reports for a list of URLs and values. To use the API you need a unique API key which you can find on the Settings page of your account.

You can access the API functionality via simple HTTP POST or GET requests. The response is JSON-formatted.

The request URL for all API calls is: http://www.linkresearchtools.com/toolkit/api.php

The Link Research Tools API is designed for internal customer applications only and specifically does not permit re-selling (like integration of the data into public available applications) of any data provided through the LinkResearchTools. For a reseller license, please contact us, we would be happy to provide data for your application.


Starting a JUICE Report

To start a report send a request with data described in this section to the API URL.

FieldValueComment
api_keyYour API keyCheck your accounts settings area for your personal API key
actionstart_report 
urls[]List of input URLsFor example: urls[0]=...&urls[1]=...&urls[2]=...
url_boostURL BoostAllows you to multiply the maximum number of URLs. Takes values from 1 - 5.
values[]List of value namesYou can even request a list of available value names via the API.
toolJUICEThe tool you want to use. This field is optional and defaults to JUICE.
titleReport titleOptional: If not provided, the API will automatically generate a title
projectProject nameOptional: If not provided, the project will be the default project.

Response Object

The response object is an object with the following fields.

FieldValueComment
statusThe request status codeError codes can be found here.
messageA descriptive status message. 
reportAn object with report information.This is only set when the API call succeeded.
   report_idThe id of the reportYou need this id to request the report data.
   titleThe title of the report 
   urlsThe URLs for which the report was started. 
   value_namesThe values for which the report was started. 
   toolThe tool. 

Retrieving Report Data

To get report data send a request with data described in this section to the API URL.

Request Data

FieldValueComment
api_keyYour API keyCheck your accounts settings area for your personal API key
actionget_data 
report_idThe id of the reportYou got this id when you started a report.
data_sectionsArray of data sections which to retrieve.See below for a list of data sections for each tool. If not set, then all available data sections are returned.
pageThe page you want to retrieveIf you have more than 25 input URLs in a report, you might have to get the data in separate batches. By default, the first page is shown.
per_pageNumber of data rows per pageThis parameter defines how many data rows (input URLs + metrics) are shown per page. It is generally a good idea not to load 1,000 results in one batch but rather make several smaller requests. Default value is 25.

Response Data

The Response object is an object with the following fields.

FieldValueComment
statusThe request status codeError codes can be found here.
messageA descriptive status message. 
reportAn object with report information.This is only set when the API call succeeded.
   report_idThe id of the reportYou need this id to request the report data.
   titleThe title of the report 
   urlsThe URL(s) for which the report was started. 
   value_namesThe values for which the report was started. 
   toolThe tool. 
   statusThe status of the report.Based on the status of the report there are additional fields.
   progressThe progress of the report.Only set if status is In Progress. (List of report status values)
      overallThe number of overall jobs.The report progress in percent is 100 * done/overall
      doneThe number of jobs done.
   pagesThe progress of the report.Only set if status is Done, Done with errors or Terminated. (List of report status values)
      columnsArray with the column titles. 
      dataArray of arrays with the column values. 

Additionally in the report object are the returned data sections. Each data section is an object with columns and data attributes. Optionally there can also be a rows attribute. The columns and rows attributes are an array with the column and row headers of the data. The data attribute is an array of arrays with the values associated to a column/row. The inner array holds the values for one row.

Report Status Values

The status field can take the following values

ValueComment
QueuedReport is waiting to be processed.
In ProgressReport is currently processing.
DoneReport is finished.
Done with errorsReport is done but major errors occured.
BrokenReport is somehow broken.
EmptyReport is done, but empty. (Happens if a BLP, SSPT etc. report didn't return any input values.)
SuspendedReport is suspended. This happens if you have no credits left or your subscription is expired.
removedReport was deleted.
TerminatedReport got terminated. The data that was crawled so far is available.

Retrieving a List of SEO Metrics (Value Names)

A request to the API URL with the api_key, the tool and action=list_value_names parameters provided returns a json encoded object with the attribute value_names. The value of this attribute is an array with the available value names as description objects (with attributes name and title).

FYI: Internally, we call our SEO metrics "value names", therefore the difference between the API documentation and the toolkit.


Retrieving a List of Reports

A request to the API URL with the api_key and the action=list_reports parameters returns a json encoded object with the attribute reports which is a list of objects describing the reports that were started by the API. The report description consists of the attributes report_id, date, title and url_count.


Retrieving a List of Reports

A request to the API URL with the api_key and the action=list_reports parameters returns a json encoded object with the attribute reports which is a list of objects describing the reports that were started by the API. The report description consists of the attributes report_id, date, title and url_count.


Error Codes

CodeDescription
100API call succeeded
200Internal API Error
201User has no API key
202No API key provided or incorrect API key
203Incorrect tool name
204Incorrect value names provided
205No valid URL(s) provided
206Not enough credits to start report
207Could not create report
208Incorrect report id
209Not supported action
210Wrong account type
211Account blocked from API
212No Reports found for account

Download Example Scripts

We prepared test implementations in PHP and Ruby (with and without CURL) that should help you start coding quickly.
If you find any problems or have any questions, please contact us using the feedback form!

Download API Examples


Questions or Feedback?

1. We know this can seem a bit complex at first.
2. This is a work in progress and we're looking for feedback!
3. We'd love to hear how you're using our API.

If you have questions, comments or just want to tell us how you're using the API, we'd love to hear from you - please contact us using the feedback form.

 

Compare Plans and Pricing

Check out our other tools

 
LinkResearchTools is trusted by the world’s most respected brands.

LinkResearchTools trusted brands

Finding the 'right' link sources with little effort and monitoring and optimizing the own link building activities. The Link Research Tools of CEMPER.COM offer the tools for it. You can analyze several SEO data sources at one time together with CEMPER.COM's own Juice parameter. Combining the individual tools offers a new, previously unutilized link building potential.

Marc Schmitz, goFeminin.de GmbH

Link Research Tools is an important weapon in any serious Internet marketer's arsenal.

Chris Winfield, CMO & Managing Partner at Blueglass,