GET Parameters

In order to use the API you need to call an endpoint URL with your private access token.[QUERY]

HTTP GET Parameters



A string query containing the filters that define which reviews will be returned.

Find any review containing either ipod or ipad, but not android:

(ipod OR ipad) -android


Your private access token. You get a unique access token when you sign up.


By default (when the sort parameter isn't specified) the results are sorted by the recommended order of crawl date.
You can however change the sort order by using the following values:

  • relevancy
  • reviews_count
  • reviewers_count
  • spam_score
  • domain_rank
  • ord_in_thread
  • rating



If you choose to order the posts by any of the above numeric sort values, you can choose in what order you want to get them:

  • desc (default)
  • asc



A paging parameter that works only when you don't sort the data by crawl date.



The "ts" (timestamp) parameter is telling the system to return results that were crawled after this timestamp (Unix Timestamp in milliseconds).

When not specified the default is the past 3 days.



The output format of the results set. It can be either:

  • json
  • xml
  • rss
  • excel

The default is json



The total number of posts returned per request, ranges between 1 to 100 (default is 100)

Will return 2 posts


Return only reviews with high extraction accuracy, but removes about 30% of the total matching reviews (with lower confidence).



Return the fragments in the review that matched the textual Boolean query. The matched keywords will be surrounded by <em/> tags.



This will return the latest 100 crawled reviews matching your query.
It's NOT recommended to use this feature as it may result in you missing important reviews.


Updated 2 years ago

GET Parameters

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.