Request method is HTTP GET.
These parameters are common to all the Endpoints in the eCommerce API
Parameter | Description | Endpoint Availability | Example |
|---|---|---|---|
q | A boolean query containing the filters that define which product data or review data will be returned. | getProducts | Find any review with the text “great”: &q=text:%22great%22 |
token | Your private access token that you received when you signed up. | addNewSearch | &token=[MY TOKEN] |
sort | crawled published (Only on getReviews endpoint) | getSearches | &sort=crawled |
order | If you choose to order the reviews by any of the above sort types, you can choose the sort order: Ascending - asc (default) | getSearches | &sort=rating&order=desc |
from | A paging parameter applicable for sort types other than crawl date. | getSearches | &from=100 |
ts | The ts (timestamp) parameter returns results that were crawled after this timestamp (ts is a Unix timestamp in milliseconds). Here is a Timestamp/Date converter When not specified the default is the past 3 days. | getProducts | &ts=1459835503426 |
size | The number of reviews returned per request. size may be between 1 and 100 (default is 100). | getProducts | &size=2 Will return 2 reviews |
latest | Return the latest 100 crawled reviews matching your query. Use of this feature is NOT recommended as it may result in loss of important reviews. | getProducts | &latest=true |