Linkdex API Documentation


From 31 January 2017 you must use HTTPS to access the Linkdex API

Release Notes

28 April 2017

OAuth access

The API uses "2-legged" OAuth v1.0a to provide authentication and authorisation services.

A Linkdex Account administrator can create an API user, which will be assigned an API key and a "secret". The key and secret should be used to sign any HTTP requests being submitted to the Linkdex API service using the HMAC-SHA1 algorithm.
The Java oauth-signpost library provides one simple method for doing this:

                    // create an HTTP request to a protected resource
                    URL url = new URL("https://api.example.com/protected")
                    HttpURLConnection request = (HttpURLConnection) url.openConnection();


                    // sign the request (consumer is a Signpost DefaultOAuthConsumer)
                    DefaultOAuthConsumer consumer = new DefaultOAuthConsumer("my_api_key", "my_api_secret");
                    consumer.sign(request);

                    // send the request
                    request.connect();
    		

There is a library and simple PHP implementation at this link

The OAuth signing process also generates a timestamp and unique request id.
The Linkdex API will validate the signed request, including the timestamp and unique id, before allowing access to the requested resource.
An HTTP 401 Unauthorized response will be returned if access to the resource is not permitted.

Stateless requests with {path_context}

{path_context} contains contextual information to correctly identify resources being accessed.
The starting point for resource access is https://api.linkdex.com/v1/projects/list. This will return a collection of project descriptors available for the provided API key.

Resource access

Basic resource access

/<resource_type>/<context_path>/list
returns a list of resource descriptors containing a name and URI to access the resource
/<resource_type>/<context_path>/<id>
returns detailed information for an individual resource

Content Negotiation

The API supports retrieval of data in XML (application/xml) or JSON (application/json) format.
Requests to the API can include an Accept header to indicate the preferred response type.
The default response type is XML.

Asynchronous Export Generation

Some of the resources can have detailed exports generated with additional data. These will be generated asynchronously.

An export request will be of the form <path_to_resource>/<resource_id>/export_[format].

Once the export request has been submitted, an HTTP 202 Accepted response will be returned. The body of the response will contain a URL to monitor the progress of the export job. The URL will also be set in the Location header of the response.

The client can use this URL to retrieve the current status of the job; the status will be contained in the response body as plain text. Once the data are ready for retrieval, the response will contain a URL to allow download of the exported data.

Export data will be compressed using GZIP.

Summary

ResourceMethodDescription
https://api.linkdex.com/application.wadl.htmlGET

Get Linkdex API documentation
https://api.linkdex.com/v1/rankings/{path_context}/shareofsearchPOST

Request a CSV of "share of search" data for the project encoded in path context.
https://api.linkdex.com/v1/rankings/{path_context}/taganalysisPOST

Request a CSV export of "Tag Analysis" for the given config and domain.
https://api.linkdex.com/v1/rankings/{path_context}/export_csvPOST

Request a CSV export of current rank tracking data for the project encoded in path context.
https://api.linkdex.com/v1/rankings/{path_context}/marketwinnersPOST

Request a CSV export of "Market Winners" for the given config param.
https://api.linkdex.com/v1/rankings/{path_context}/all_pagesPOST

Request a CSV export of rank tracking data for all pages for the project encoded in path context.
https://api.linkdex.com/v1/rankings/{path_context}/historyPOST

Request XML export of rank tracking history for project encoded in path context. <p> For filtering result by date, dateFrom and dateTo must both be supplied.
https://api.linkdex.com/v1/rankings/{path_context}/full_resultsPOST

Request XML export of raw organic and ppc rank tracking results for project encoded in path context.
https://api.linkdex.com/v1/indexes/{path_context}/{index_id:\d+}/export_csvPOST

Request CSV export of an index
https://api.linkdex.com/v1/indexes/{path_context}/{index_id:\d+}GET

Request details of an index
https://api.linkdex.com/v1/indexes/{path_context}/listGET

Request a list of indexes associated with a domain encoded in path context
https://api.linkdex.com/v1/keywords/{path_context}/{keyword_id}GET

Request details of a keyword
https://api.linkdex.com/v1/keywords/{path_context}/listGET

Request a list of keywords associated with project encoded in path context
https://api.linkdex.com/statusGET

Check availability of Linkdex API
https://api.linkdex.com/v1/tags/{path_context}/{id}GET

Request details of a tag.
https://api.linkdex.com/v1/tags/{path_context}/listGET

Request a list of tags associated with the project encoded in the path context.
https://api.linkdex.com/schemaGET

Request base XML schema describing resources returned the API
https://api.linkdex.com/v1/projects/{path_context}GET

Request details of project encoded in the path context
https://api.linkdex.com/v1/projects/listGET

Request a list of projects in API user's account. This will be the normal starting point for access to resources.
https://api.linkdex.com/v1/domains/{path_context}GET

Request details of a domain encoded in path context
https://api.linkdex.com/v1/domains/{path_context}/localesGET

Request a list of locales which can be used for visibility export.
https://api.linkdex.com/v1/domains/{path_context}/exportVisibilityPOST

Request a CSV export of visibility for the domanain encoded in path context.
https://api.linkdex.com/v1/domains/{path_context}/listGET

Request a list of domains associated with project encoded in path context.
https://api.linkdex.com/v1/contacts/{path_context}/{id}GET

Request contact details for given id
https://api.linkdex.com/v1/contacts/{path_context}/listGET

Request a list of contacts associated with account encoded in path context.
https://api.linkdex.com/v1/jobs/{path_context}/{job_id:\d+}/dataGET

Retrieve data created by asynchronous job
https://api.linkdex.com/v1/jobs/{path_context}/{job_id:\d+}GET

Retrieves details of an asynchronous job. A job description will contain: <ul> <li>the job name</li> <li>a URI to allow retrieval of the job data when the job is complete</li> <li> the job status: <ul> <li>PENDING - job has been queued for processing</li> <li>PROCESSING - job is being processed</li> <li>READY - job is complete and data are ready for download</li> <li>FAILED - job has failed</li> <li>DATA_UNAVAILABLE - data not available to generate job content</li> </ul> </li> </ul>
https://api.linkdex.com/v1/jobs/{path_context}/listGET

Request a list of jobs currently available for access by the API user
https://api.linkdex.com/v1/sitecrawls/{path_context}/{crawl_id:\d+}GET

Request details of a site crawl
https://api.linkdex.com/v1/sitecrawls/{path_context}/{crawl_id:\d+}/export_csvPOST

Request a CSV export containing details of a site crawl Format of CSV export changed in release 20 November 2013
https://api.linkdex.com/v1/sitecrawls/{path_context}/listGET

Request a list of site crawls associated with the domain encoded in the path context.
https://api.linkdex.com/schema/v1GET

Request V1 XML schema describing resources returned by API
https://api.linkdex.com/v1/rankingconfigs/{path_context}/{id}GET

Request details of a ranking configuration.
https://api.linkdex.com/v1/rankingconfigs/{path_context}/listGET

Request a list of ranking configurations associated with the project encoded in the path context.
https://api.linkdex.com/v1/searchanalytics/{path_context}/countriesGET

Request a list of available countries, plus "GLOBAL"
https://api.linkdex.com/v1/searchanalytics/{path_context}/exportKeywordsPOST

Request a CSV export of keywords for the domain encoded in path context. (Primary domain only)
https://api.linkdex.com/v1/searchanalytics/{path_context}/exportKeywordsAllPagesPOST

Request a CSV export of keywords for the domain encoded in path context. (Primary domain only)
https://api.linkdex.com/v1/searchanalytics/{path_context}/exportPagesPOST

Request a CSV export of raw domain pages for the domain encoded in path context. (Primary domain only)
https://api.linkdex.com/v1/campaigns/{path_context}/export_xmlPOST

Request an XML export containing link campaigns
https://api.linkdex.com/v1/campaigns/{path_context}/export_csvPOST

Request a CSV export containing link campaigns.
https://api.linkdex.com/v1/campaigns/{path_context}/listGET

Request a list of link campaigns

Grammars

schema
schema/v1

Resources


https://api.linkdex.com/application.wadl.html

Methods
GET

Get Linkdex API documentation

request
unspecified
responses
status:
200
representations
text/html Returns an HTML formatted version of the application WADL
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the WADL cannot be found

https://api.linkdex.com/v1/rankings/{path_context}/shareofsearch

Methods
POST

Request a CSV of "share of search" data for the project encoded in path context.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
configstringURI of ranking configuration to include in export. Mandatory - only one configuration permitted.
keywordstringURI of keyword to include in export (can be repeated for multiple keywords). If not specified all keywords in project will be included
tagstringURI of keyword tag to select the keywords to include in export (can be repeated for multiple tags). If not specified all keywords in project will be included

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
400
representations
If config is not for the project, or not specified
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/rankings/{path_context}/taganalysis

Methods
POST

Request a CSV export of "Tag Analysis" for the given config and domain.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
configstringURI of ranking configuration to include in export. Mandatory - only one configuration permitted.
domainstringURI of domain to include in export. Mandatory - only one configuration permitted.
tagstringURI of keyword tag to select the keywords to include in export (can be repeated for multiple tags). If not specified all keywords in project will be included

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
400
representations
If config or domain is not for the project, or not specified
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/rankings/{path_context}/export_csv

Methods
POST

Request a CSV export of current rank tracking data for the project encoded in path context.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
domainstringURI of domain to include in export (can be repeated for multiple domains). If not specified all domains in project will be included
configstringURI of ranking configuration to include in export (can be repeated for multiple configurations). If not specified all ranking configurations in project will be included
keywordstringURI of keyword to include in export (can be repeated for multiple keywords). If not specified all keywords in project will be included
tagstringURI of keyword tag to select the keywords to include in export (can be repeated for multiple tags). If not specified all keywords in project will be included

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/rankings/{path_context}/marketwinners

Methods
POST

Request a CSV export of "Market Winners" for the given config param.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
configstringURI of ranking configuration to include in export. Mandatory - only one configuration permitted.
tagstringURI of keyword tag to select the keywords to include in export (can be repeated for multiple tags). If not specified all keywords in project will be included

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
400
representations
If config is not for the project, or not specified
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/rankings/{path_context}/all_pages

Methods
POST

Request a CSV export of rank tracking data for all pages for the project encoded in path context.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
domainstringURI of domain to include in export (can be repeated for multiple domains). If not specified all domains in project will be included
configstringURI of ranking configuration to include in export (can be repeated for multiple configurations). If not specified all ranking configurations in project will be included
keywordstringURI of keyword to include in export (can be repeated for multiple keywords). If not specified all keywords in project will be included
tagstringURI of keyword tag to select the keywords to include in export (can be repeated for multiple tags). If not specified all keywords in project will be included
date_fromstringoptional start date of history results - format YYYY-MM-DD
date_tostringoptional end date of history results - format YYYY-MM-DD

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/rankings/{path_context}/history

Methods
POST

Request XML export of rank tracking history for project encoded in path context. <p> For filtering result by date, dateFrom and dateTo must both be supplied.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
domainstringURI of domain to include in history (can be repeated for multiple domains). If not specified all domains in project will be included
configstringURI of ranking configuration to include in history (can be repeated for multiple configurations). If not specified all ranking configurations in project will be included
keywordstringURI of keyword to include in history (can be repeated for multiple keywords). If not specified all keywords in project will be included
tagstringURI of keyword tag to select the keywords to include in history (can be repeated for multiple tags). If not specified all keywords in project will be included
date_fromstringoptional start date of history results - format YYYY-MM-DD
date_tostringoptional end date of history results - format YYYY-MM-DD

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/rankings/{path_context}/full_results

Methods
POST

Request XML export of raw organic and ppc rank tracking results for project encoded in path context.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
configstringURI of ranking configuration to filter results
keywordstringURI of keyword to filter results
datestringDate of history results - format YYYY-MM-DD

responses
status:
202 - List of raw organic and ppc rank tracking results, empty list with message if no results. Includes estimated date of next rank check for keyword/ranking configuration
representations
application/xml, application/json List of full ranking results
status:
401 - List of raw organic and ppc rank tracking results, empty list with message if no results. Includes estimated date of next rank check for keyword/ranking configuration
representations
If access to the resource is not permitted
status:
404 - List of raw organic and ppc rank tracking results, empty list with message if no results. Includes estimated date of next rank check for keyword/ranking configuration
representations
If the resources to create the export cannot be found
status:
429 - List of raw organic and ppc rank tracking results, empty list with message if no results. Includes estimated date of next rank check for keyword/ranking configuration
representations
If too many requests per second are received

https://api.linkdex.com/v1/indexes/{path_context}/{index_id:\d+}/export_csv

Methods
POST

Request CSV export of an index

request
template params
index_idlongid of index to export
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
fullboolean
default: false
set true to add extended data to export (default is false)

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/indexes/{path_context}/{index_id:\d+}

Methods
GET

Request details of an index

request
template params
index_idlongid of index to retrieve
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonindex Details of requested index.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/indexes/{path_context}/list

Methods
GET

Request a list of indexes associated with a domain encoded in path context

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonindexes A collection of descriptors containing the crawl time and URIs of available indexes.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/keywords/{path_context}/{keyword_id}

Methods
GET

Request details of a keyword

request
template params
keyword_idlong
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonkeyword Details of requested keyword.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/keywords/{path_context}/list

Methods
GET

Request a list of keywords associated with project encoded in path context

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonkeywords A collection of descriptors containing the text and URIs of available keywords.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/status

Methods
GET

Check availability of Linkdex API

request
unspecified
responses
status:
200
representations
text/plain Returns "API is available" if service is running
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the status check cannot be found

https://api.linkdex.com/v1/tags/{path_context}/{id}

Methods
GET

Request details of a tag.

request
template params
idlongid of requested tag
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsontag A descriptor for specified tag.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/tags/{path_context}/list

Methods
GET

Request a list of tags associated with the project encoded in the path context.

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsontag A collection of descriptors for available tag.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/schema

Methods
GET

Request base XML schema describing resources returned the API

request
unspecified
responses
status:
200
representations
application/xml The XML schema in XSD format.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the schema cannot be found

https://api.linkdex.com/v1/projects/{path_context}

Methods
GET

Request details of project encoded in the path context

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonproject Detail of project identified by {path_context}.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/projects/list

Methods
GET

Request a list of projects in API user's account. This will be the normal starting point for access to resources.

request
unspecified
responses
status:
200
representations
application/xml, application/jsonprojects A collection of descriptors containing the name and URIs of available projects.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/domains/{path_context}

Provide access to available domain information.

Methods
GET

Request details of a domain encoded in path context

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsondomain Details of selected domain.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/domains/{path_context}/locales

Methods
GET

Request a list of locales which can be used for visibility export.

request
template params
path_contextstringencoded context of the request
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsondomains A collection of descriptors containing the name and URIs of available domains.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/domains/{path_context}/exportVisibility

Methods
POST

Request a CSV export of visibility for the domanain encoded in path context.

request
template params
path_contextstringencoded context of the request
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
localestringmandatory country and language for which the visibility data are required

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
204
representations
If domain does not support visibility export
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/domains/{path_context}/list

Methods
GET

Request a list of domains associated with project encoded in path context.

request
template params
path_contextstringencoded context of the request
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsondomains A collection of descriptors containing the name and URIs of available domains.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/contacts/{path_context}/{id}

Methods
GET

Request contact details for given id

request
template params
idlongid of requested contact
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsoncontact Details of selected contact.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/contacts/{path_context}/list

Methods
GET

Request a list of contacts associated with account encoded in path context.

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsoncontacts A collection of descriptors containing the name and URIs of available contacts.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/jobs/{path_context}/{job_id:\d+}/data

Methods
GET

Retrieve data created by asynchronous job

request
template params
job_idlongid of job
path_contextstringencoded context of the request

responses
status:
200
representations
application/octet-stream Content created by requested job in a gzip compressed file.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/jobs/{path_context}/{job_id:\d+}

Methods
GET

Retrieves details of an asynchronous job. A job description will contain: <ul> <li>the job name</li> <li>a URI to allow retrieval of the job data when the job is complete</li> <li> the job status: <ul> <li>PENDING - job has been queued for processing</li> <li>PROCESSING - job is being processed</li> <li>READY - job is complete and data are ready for download</li> <li>FAILED - job has failed</li> <li>DATA_UNAVAILABLE - data not available to generate job content</li> </ul> </li> </ul>

request
template params
job_idlongid of job
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonjob Details of requested job.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/jobs/{path_context}/list

Methods
GET

Request a list of jobs currently available for access by the API user

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonjobs A collection of descriptors containing the name and URIs of available asynchronous jobs.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/sitecrawls/{path_context}/{crawl_id:\d+}

Methods
GET

Request details of a site crawl

request
template params
crawl_idlongid of site crawl
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonsitecrawl Details of requested site crawl
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/sitecrawls/{path_context}/{crawl_id:\d+}/export_csv

Methods
POST

Request a CSV export containing details of a site crawl Format of CSV export changed in release 20 November 2013

request
template params
crawl_idlongid of crawl to generate export for
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name
pageFilterstringan optional filter name; values include: <ul> <li>ExcludedByRobotsTxt</li> <li>NoIndexSet</li> <li>403PageForbidden</li> <li>404PageNotFound</li> <li>500ServerError</li> <li>503Unavailable</li> <li>301PermanentRedirect</li> <li>302TemporaryRedirect</li> <li>DuplicatedPageTitles</li> <li>DuplicatedDescriptions</li> <li>MissingPageTitles,</li> <li>MissingDescriptions</li> <li>MissingHeadings</li> <li>ShortPageTitles</li> <li>LongPageTitles</li> <li>InternalBrokenLinks</li> <li>ExternalBrokenLinks,</li> <li>Top3Ranks</li> <li>Top10Ranks</li> <li>Top20Ranks</li> <li>CanonicalNonSelf</li> <li>CanonicalExternal</li> </ul>

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/sitecrawls/{path_context}/list

Methods
GET

Request a list of site crawls associated with the domain encoded in the path context.

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonsitecrawls A collection of descriptors containing the crawl time and URIs of available site crawls.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/schema/v1

Methods
GET

Request V1 XML schema describing resources returned by API

request
unspecified
responses
status:
200
representations
application/xml The XML schema in XSD format.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the schema cannot be found

https://api.linkdex.com/v1/rankingconfigs/{path_context}/{id}

Methods
GET

Request details of a ranking configuration.

request
template params
idintid of requested ranking configuration
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonranking-configuration A descriptor for specified ranking configuration.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/rankingconfigs/{path_context}/list

Methods
GET

Request a list of ranking configurations associated with the project encoded in the path context.

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsonranking-configurations A collection of descriptors for available ranking configurations.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/searchanalytics/{path_context}/countries

Methods
GET

Request a list of available countries, plus "GLOBAL"

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/json/searchanalytics/[context]/countries A collection of descriptors containing the code and name of available countries.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found

https://api.linkdex.com/v1/searchanalytics/{path_context}/exportKeywords

Methods
POST

Request a CSV export of keywords for the domain encoded in path context. (Primary domain only)

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
countrystringmandatory country, or "GLOBAL" for which the keywords data is required
reportNamestringan optional export name
datestringmandatory single date for the export - format YYYY-MM-DD

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
400
representations
If domain is not primary domain for that project, or if country is not specified
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/searchanalytics/{path_context}/exportKeywordsAllPages

Methods
POST

Request a CSV export of keywords for the domain encoded in path context. (Primary domain only)

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
countrystringmandatory country, or "GLOBAL" for which the keywords data is required
reportNamestringan optional export name
datestringmandatory single date for the export - format YYYY-MM-DD

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
400
representations
If domain is not primary domain for that project, or if country is not specified
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/searchanalytics/{path_context}/exportPages

Methods
POST

Request a CSV export of raw domain pages for the domain encoded in path context. (Primary domain only)

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
countrystringmandatory country, or "GLOBAL" for which the raw domain pages data is required
reportNamestringan optional export name
datestringmandatory single date for the export - format YYYY-MM-DD

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
400
representations
If domain is not primary domain for that project, or if country is not specified
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/campaigns/{path_context}/export_xml

Methods
POST

Request an XML export containing link campaigns

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation. The job URI will also be encoded in the response Location header
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/campaigns/{path_context}/export_csv

Methods
POST

Request a CSV export containing link campaigns.

request
template params
path_contextstringencoded context of the request

representations
application/x-www-form-urlencoded
query params
reportNamestringan optional export name

responses
status:
202
representations
text/plain A plain text response containing a job URI that can be used to monitor status of the export generation.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resources to create the export cannot be found
status:
503
representations
If service is temporarily unavailable

https://api.linkdex.com/v1/campaigns/{path_context}/list

Methods
GET

Request a list of link campaigns

request
template params
path_contextstringencoded context of the request

responses
status:
200
representations
application/xml, application/jsoncampaigns A collection of descriptors for available link campaigns.
status:
401
representations
If access to the resource is not permitted
status:
404
representations
If the resource cannot be found