Retrieve the top 10 searches

GET 
/metrics/top

Retrieve the top 10 searches

Request

Query Parameters

from date

The date to search from (inclusive)

to date

The date to search up to (inclusive)

Header Parameters

X-SaleCycle-Id stringrequired

Your SaleCycle API Subscription key

Responses

200

Successful operation

application/json

Schema

Schema

data object[]required
Array [
searchTerm string
count integer
]
meta object
timeRange object
from date-time
to date-time

Example (from schema)

{
  "data": [
    {
      "searchTerm": "Vanishing Oranges",
      "count": 12
    }
  ],
  "meta": {
    "timeRange": {
      "from": "2024-07-29T15:51:28.071Z",
      "to": "2024-07-29T15:51:28.071Z"
    }
  }
}

Loading...