GetPrefixQueryEstimate

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

This function checks if real time querying of a given item is possible

Resource Description

AnalysisResUnits

100

RetrievalResUnits

0

This function accepts the following parameters:

Parameter Description

cmd

Required: must be set to: GetPrefixQueryEstimate

item

Required: for queried item: http://www.api.majestic.com for URL or www.api.majestic.com for subdomain or api.majestic.com for root domain

type

Optional way to force item to required type

exactmode

Optional, if set to 1 then in cases when estimated links are fairly low exact check will be done,
this should be used in cases when report is about to get created, but NOT for fast checks like in Site Explorer to see if real time query in other command is possible


This function returns the following values:

Return Value Description

RealTimeQueryAllowed

If 1 then this prefix query can be used in real-time commands, otherwise only option to get data is to call DownloadBackLinks

EstimatedExtBacklinks

Very rough estimate, it's entirely possible prefix scan will yield zero links

ActualCountsAvailable

Set to 1 if exactmode=1 was specified, in this case for relatively small items exact counts will be provided in ActualExtBackLinks and ActualURLs return vars

Example:
https://api.majestic.com/api/xml?app_api_key=API_KEY&cmd=GetPrefixQueryEstimate&item=api.majestic.com

This produces the following XML:



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

This produces the following JSON:

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