Offset

Parameter name: offset
Aliases: o, s, start, start_at
Default: 0
Maximum: 10,000
Values: integers 0 -> ..
Description: The results number at which to start returning records from.
Example: The following query returns results for the phrase airport parking, starting from the 10th result:
http://api.keyworddiscovery.com/query.php?query=airport+parking&offset=10

To obtain 10,000 results, the offset parameter must be used. eg.

To obtain the first 1000 results for the query "airport":
http://api.keyworddiscovery.com/query.php?query=airport&offset=0&limit=1000

To obtain the next 1000 results, use the offset variable to specify the starting point of 1000:
http://api.keyworddiscovery.com/query.php?query=airport&offset=1000&limit=1000

To obtain the next 1000 results, again increment the offset parameter by 1000:
http://api.keyworddiscovery.com/query.php?query=airport&offset=2000&limit=1000
Etc.


Results

Results are returned as XML. A simple example:

http://api.keyworddiscovery.com/query.php?query=airport&offset=0&limit=1000

This request will display the top 1000 results for the search term "airport". 1000 results per query is the limit via the API. By default, compact result display is turned on. The XML returned from this query is shown below:

<?xml version="1.0" encoding="utf-8"?>
<results compact="true" maximum="1000" offset="0" query="airport">
 <r m="50058" q="airport" t="29841" />
 <r m="6240" q="airport parking" t="3720" />
 <r m="6061" q="manchester airport" t="3613" />
 <r m="5412" q="orlando international airport" t="3226" />
 <r m="4991" q="airport security" t="2975" />
 <r m="4590" q="jfk airport" t="2736" />
 <r m="4081" q="dfw airport" t="2433" />
 <r m="3610" q="bwi airport" t="2152" />
 <r m="3608" q="atlanta airport" t="2151" />
 <r m="3457" q="heathrow airport" t="2061" />
 ..............
 <exclude />
</results>

Each result is returned as an 'r' tag with the following attributes

  • q - query string
  • t - total search
  • m - monthly estimate. (takes into account a percentage of data that Keyword discovery has in relation to the total number searches done world wide.)



NOTE: Data provided on a URL has to be correctly URL encoded.




Single query | Limit