GetIndexItemInfo

Command status: Active
Supported by OpenApps API: Yes
Supported by Internal/Reseller API: Yes
Possibly queued processing: No

Calls to this function will result in usage of the following subscription resources:

Resource Description

IndexItemInfoResUnits

This resource will be decreased by a number of items that were queried by this function.

This function returns key information about "index items":

  1. Root domain name, ie: example.com - analysis will be done for all urls that belong to this root domain, this will include all subdomains
  2. Subdomain, ie: www.example.com - analysis will be done for all urls that belong to this subdomain
  3. Exact URL, ie: http://www.example.com - analysis will be only done for this particular URL only.

The primary objective of this function is to provide amount of analysis resource units that will be used by AnalyseIndexItem function

Parameter Description

cmd

Required: must be set to: GetIndexItemInfo

datasource

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

items

Required: must be a positive integer from 1 to maximum of 100 indicating how many items this query supplies in itemN parameters

item0, item1 ... itemN

One or more items starting from item0 that information

Note: do not forget to URL encode each item even if item may already contain URL encoding.

DesiredTopics

Optional: The number of trust flow topics which will be displayed, this is limited to 30 for Domains, 20 for Subdomains and 10 for URL.

Default: 3

Note: for URLs with very few external backlinks this function may return estimated numbers rather than exact, in which case returned field Status will be set to MayExist.

http://api.majestic.com/api/xml?app_api_key=API_KEY&cmd=GetIndexItemInfo&items=1&item0=http://www.majestic.com&datasource=fresh

This query in the Fresh Index produces the following XML:



http://api.majestic.com/api/json?app_api_key=API_KEY&cmd=GetIndexItemInfo&items=1&item0=http://www.majestic.com&datasource=fresh

This query in the Fresh Index produces the following JSON:

GlobalVars contain a number of useful variables:

  1. IndexBuildDate: date when backlinks index was build (created), this date can be used to detect if index update took place
  2. MostRecentBackLinkDate: the date of the most recent backlink in the index.

Note: The index that supplies data for this command usually gets updated right before main index is released, therefore for the analysis purposes (AnalyseIndexItem, GetTopBackLinks or any other similar functions that return backlinks data) it is best to call GetSubscriptionInfo command in order to get dates from the actual index.

Results table contains one or more lines of data:

Header Meaning

ItemNum

Integer indicating numeric position of item in original request

ItemType

Type of the item:

  1. root domain
  2. sub domain
  3. URL

Item

Actual item (domain/subdomain/URL) in its original form

ResultCode

ResultCode:

  • OK - info was successfully retrieved for this item
  • Any other text is an error message (should not usually happen)

Status

Status of this item in index:

  1. Found – this item is present in index and can be analysed
  2. NotFound - this item is definitely not present in index yet
  3. MayExist – returned for URLs only that have very few external backlinks, in this case AnalysisResUnitsCost is an estimate that won’t be exceeded. This is likely to happen for URLs with less than 20 external backlinks.

ExtBackLinks

Number of external backlinks for this item

  • this includes all type of links excluding mentions. Including links deleted within the last 90 days when querying fresh or links marked as deleted when querying historic indexes

RefDomains

Number of referring domains known for this item. If -1 then this number is not yet known (currently returned for subdomains)

IndexedURLs

Number of URLs for given item type present in index - these are NOT backlinks, but rather URLs belonging to given domain or subdomain: this metric is useful as an indication of domain content size.

AnalysisResUnitsCost

Amount of analysis resource units that will be required to analyse this item using AnalyseIndexItem function: this cost is determined as a number of external backlinks pointing to given index item.

GetTopBackLinksAnalysisResUnitsCost

Amount of analysis resource units that will be required to analyse this item using GetTopBackLinks function.

The information above is provided a guidance only - please call this function to get exact values for any specific index items or call GetSubscriptionInfo to get current minimum and maximums.

RefIPs

Number of referring IP addresses

RefSubNets

Number of referring C-class subnets (SEO wise here, ie: 212.100.100.*)

RefDomainsEDU

ExtBackLinksEDU

RefDomainsGOV

ExtBackLinksGOV

Number of referring domains and external backlinks from EDUcational (includes .AC. versions and regional .EDU.xx TLDs) and GOVernment sites (includes .MIL. and regional versions such .MIL.*).

RefDomainsEDU_Exact

ExtBackLinksEDU_Exact

RefDomainsGOV_Exact

ExtBackLinksGOV_Exact

Same as above but applies only to domains with exact TLDs such as .EDU and .GOV/.MIL thus excluding any regional versions.

CrawledFlag

If set to true true then this URL was crawled (not applicable to domain/subdomains)

LastCrawlDate

Date when URL was crawled, only meaningful if CrawledFlag is true.

LastCrawlResult

Last crawl result, usually self-explanatory phrase

RedirectFlag

If set to true then URL was found to be redirecting

FinalRedirectResult

If URL redirects then we include crawl result of where it leads to (say redirect can lead to 404 not found page)

OutDomainsExternal

Experimental - we do not recommend to rely on this value which is number of external domains crawled URL links out to

OutLinksExternal

Same as OutDomainsExternal only counts external out links

OutLinksInternal

Same as OutLinksExternal only counts internal links

Title

Title of the URL if it was successfully crawled and present on page

RedirectTo

Target location of redirect - only present if URL was crawled and found to be redirecting

Citation Flow

Citation Flow of Domain / Subdomain / URL being queried

Trust Flow

Trust Flow of Domain / Subdomain / URL being queried

Topical Trust Flow

Categories of Topical Trust Flow of Domain / Subdomain / URL being queried
Note: Topical Trust Flow is is currently available in the Fresh Index only

Common Problems

Problem: calling this function in a loop to look up backlink counts for each of the many URLs separately is slow.
Solution: every call has overheads, so it is strongly recommended to batch multiple URLs or domains into single request: this can result in a very substantial increase in performance.
Problem: for some URLs function returns backlink counts that are not the same as when tried on our website.
Solution: check that Status is not “MayExist” - if it is, then it means that for those URLs backlink counts are less of equal to specified backlink values.
Problem: backlink counts were desired for a domain but they were actually returned for the homepage.
Solution: if you use a URL in the query (ie with a / in it) then the system will return data for the URL itself, so you need to avoid adding protocol (http://) or any other characters that are not part of valid domain name.
Problem: counts reported by this function are not matched by AnalyseIndexItem.
Solution: this can be due to additional filtering options used by that function which can reduce number of qualifying backlinks for analysis thus reducing counts such as referring domains etc.

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