GetSubscriptionInfo

Command status: Active
Supported by OpenApps API: Yes - With modifications - Limited data returned
Supported by Internal/Reseller API: Yes
Possibly queued processing: No

This function returns information on existing subscriptions with current resource usage values provided.

Parameter Description

cmd

Required: must be set to: GetSubscriptionInfo

datasource

Optional - defaults to historic
Either: "fresh" - to query against fresh index, or "historic" - to query against historic index.

Sample API request:

https://api.majestic.com/api/xml?app_api_key=API_KEY&cmd=GetSubscriptionInfo

Successful XML returned by this function:



https://api.majestic.com/api/json?app_api_key=API_KEY&cmd=GetSubscriptionInfo

This produces the following JSON:

Below you can see explanation of the key columns in Subscriptions table.

Column Description

IndexItemInfoResUnits

Resource units that are used to lookup backlinks counts for URLs, subdomains and root domains.

Used by GetIndexItemInfo function.

AnalysisResUnits

Resource units used in analysis of backlinks.

Used by functions such as AnalyseIndexItem.

RetrievalResUnits

Resource units used when backlinks are retrieved (returned).

Used by functions such as AnalyseIndexItem.

StandardReportsRemaining

Number of standard reports that can be created in our web front end OR (for API requests) number of time GetTopBackLinks function can be called.

StandardReportBacklinksShown

Maximum number of backlinks that can be returned by GetTopBackLinks function.

MinGetTopBackLinksAnalysisResUnitsCost

Maximum number of Analysis Units used to analyse each item with GetTopBackLinks function.

MaxGetTopBackLinksAnalysisResUnitsCost

Maximum number of Analysis Units used to analyse each item with GetTopBackLinks function.

Table IndexInfo provides useful information about the backlink index itself.

Column Description

Name

Internal name of the index

IndexBuildDate

Date when index was build (merged) - this is not to be confused with the most recent backlink date in the index which in all cases will be ealier than index build date. This date can be used to detect if index has been updated, but it is recommended to take MostRecentBackLinkDate date into account as well.

UniqueCrawledPages

64-bit number of unique crawled pages in this index

UniqueIndexedURLs

64-bit number of unique indexed URLs (this includes number of unique crawled pages)

MostRecentBackLinkDate

Date indicating when the most recent backlink was found in this index, format: YYYY-MM-DD.

For more information about access to the Majestic API suite, visit our Plans & Pricing page.