API Queries - Search Terms

The searchterms function lists the top 10 requested search terms for a domain in descending order and includes the hits for the time period selected.

Additional Parameters

• domain - The domain you wish to retrieve requested pages for. (Required)
• view_period - The time period to retrieve statistics for. Default is "last7days". Accepted values are "last7days", "last3months" and "last6months". (Optional)
• start - The starting offset for results. Default is 0 (Optional)
• num - The number of results to show from the report. Default is 100, maximum is 1,000 (Optional)

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=searchterms&domain=example.com&view_period=last6months&start=0&num=10

Response:

<results>

<resulthits="10099"search_term="example"/>

<resulthits="2587"search_term="example login"/>

<resulthits="1962"search_term="ex ample login"/>

<resulthits="770"search_term="example.net"/>

<resulthits="538"search_term="example net"/>

<resulthits="205"search_term="example login.net"/>

<resulthits="204"search_term="example domain login"/>

<resulthits="198"search_term="examplelogin. net"/>

<resulthits="188"search_term="ex-ample login"/>

<resulthits="178"search_term="examplelogin admin"/>

</results>

Error Responses:

Possible error responses for this function are:

• 400 - Invalid mode parameter
• 410 - Domain is missing or invalid
• 412 - Period, from_date and to_date combination or value is invalid
• General errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.