This web service responds with information about the search terms that were most popular among users in a selected period.
| Method | Endpoint |
|---|---|
POST |
/analytics/api/v2/searches/terms-top |
Request example
The following lines show an example of a JSON request body:
{
"startDate": "2023-03-29",
"endDate": "2023-04-29",
"paging": {
"page": 2,
"perPage": 10
},
"contentLocale": "fr-FR"
}
| Field Name | Type | Required? | Description |
|---|---|---|---|
startDate |
String | Yes | Inclusive start date of the period (within the past year). |
endDate |
String | Yes | Exclusive end date of the period (after the start date). |
paging |
Object | Yes | Element containing page and perPage elements. |
page |
Number | Yes | Current page number (starts at 1). |
perPage |
Number | Yes | Number of results per page. |
contentLocale |
String | Yes | Combination of ISO 639-1 language code and ISO 3166-1 country code. |
All of the request parameters described above are mandatory.
Response body
The following lines show an example of a JSON response body:
{
"startDate": "2023-03-29",
"endDate": "2023-04-29",
"paging": {
"lastPage": false,
"page": 2,
"perPage": 20,
"totalCount": 1328
},
"results": [
{
"queryCount": 312,
"terms": "install guide"
}
]
}
| Field | Type | Description |
|---|---|---|
startDate |
String | Inclusive start date of the period |
endDate |
String | Exclusive end date of the period |
lastPage |
Boolean | Indicates whether the page is the last page |
page |
Number | Current page number |
perPage |
Number | Number of results per page |
totalCount |
Number | Total number of available results |
queryCount |
Number | Number of queries submitted during the period |
terms |
Array | Keywords of the query |
| Return code | Description |
|---|---|
200 OK |
Returns 0 or more results. |