Content available in: eng | ita
This document describes the current behavior of the Advanced Analytics API, including known limitations; it will be updated as the API evolves.
AccelaSearch tracks how shoppers use a shop's search box — queries, clicks, filters, sorting — and exposes aggregated statistics through the Advanced Analytics API. The full request/response schemas are documented in doc/API.yaml; this page explains what each endpoint is for and how they fit together.
All endpoints report on a single shop, over a date range, optionally restricted to one device type.
Every request requires the X-Accelasearch-Apikey header. The shop identified by {id} in the path must belong to the customer that owns the API key, otherwise the request is rejected.
All endpoints are POST requests with a JSON body. The following parameters recur across most of them:
| Parameter | Location | Required | Notes |
|---|---|---|---|
id |
path | yes | Shop identifier. |
| device | body | no | One of all, desktop, mobile. Defaults to all. |
date.startDate |
body | yes | Start of the date range, as a Unix timestamp in milliseconds. |
date.endDate |
body | yes | End of the date range, as a Unix timestamp in milliseconds. |
| page | body | no | Zero-based page index. Only affects endpoints that paginate or gate part of their response (see below). |
| query | body | varies | Required by query-info. Accepted but silently ignored by facet-info and facets-info — it has no effect there. |
| facet | body | varies | Required by facet-info only: the facet/filter type to report on (e.g. brand). |
| Endpoint | Purpose |
|---|---|
POST /API/analytics/{id}/overview |
KPI overview (searches, search intents, clicks, exit rate, search usage) and their daily trend. |
POST /API/analytics/{id}/query |
Most searched queries, most clicked products, most frequent queries with no results. |
POST /API/analytics/{id}/query-info |
Trend and product detail for one specific search query. |
POST /API/analytics/{id}/facet-info |
Usage breakdown of the values of a single facet (filter) type. |
POST /API/analytics/{id}/facets-info |
Overall usage of facets and sorting options, plus best/worst performing filter values. |
Returns the main performance indicators for the period, each paired with its percentage variation against the immediately preceding period of equal length: total searches, search intents, product clicks, exit rate (average search intents per session that used search), and search-box usage rate. It also returns a daily breakdown (columns + data) aligned day by day over the range, and the day-of-week label for each entry.
Returns three ranked lists — most searched queries, most clicked products, and queries that produced no results — paginated 20 items per page. Note pages 0 and 1 currently return the same first page.
Given a specific query, returns its daily search-intent trend and the products shown for it. The product list (queryProducts) is only included when page is 0 or omitted; its three sub-lists (all, filters, query) currently carry identical content.
Given a facet type (e.g. brand), returns how often each of its values was used among filtered searches. The facets array is only included for pages 0 and 1.