AACsearch
Api reference

Get aggregated analytics

GET
/projects/{projectId}/analytics

Authorization

BearerAuth
AuthorizationBearer <token>

Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.

In: header

Path Parameters

projectId*string

Query Parameters

period?string
Default"last7"
Value in"last7" | "last30"

Response Body

application/json

curl -X GET "https://loading/api/v1/projects/string/analytics"
{
  "totalSearches": 0,
  "totalSessions": 0,
  "topQueries": [
    {
      "query": "string",
      "count": 0
    }
  ],
  "zeroResultQueries": [
    {
      "query": "string",
      "count": 0
    }
  ],
  "topClickedProducts": [
    {
      "productId": "string",
      "title": "string",
      "clicks": 0
    }
  ],
  "ctr": 0,
  "searchesOverTime": [
    {
      "date": "string",
      "count": 0
    }
  ]
}