Skip to content
AACSearch

Popular queries with search/CTR/conversion/revenue metrics

Per-query table for the organization: searches, results-found rate (whose inverse is the zero-result rate), CTR, no-click rate, add-to-carts, purchases, revenue and conversion rate, computed from stored search events. Sorted by search volume, then revenue. Requires a bounded date range (`from`/`to`, max 366 days).

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
GET
/analytics/metrics/queries

Per-query table for the organization: searches, results-found rate (whose inverse is the zero-result rate), CTR, no-click rate, add-to-carts, purchases, revenue and conversion rate, computed from stored search events. Sorted by search volume, then revenue. Requires a bounded date range (from/to, max 366 days).

Authorization

api_key_header
X-NOVA-API-KEY<token>

Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).

In: header

Query Parameters

from*string

Range start (ISO 8601 date or date-time, inclusive).

to*string

Range end (ISO 8601 date or date-time, inclusive; a date-only value covers the whole day). The range may not exceed 366 days.

collection?string
limit?integer
Range1 <= value <= 1000
Default100
offset?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/metrics/queries?from=string&to=string"
{  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "collection": "string",  "events": 0,  "truncated": true,  "total": 0,  "next_offset": 0,  "data": [    {      "q": "string",      "searches": 0,      "results_found_rate": 0,      "clicks": 0,      "ctr": 0,      "no_click_rate": 0,      "add_to_carts": 0,      "purchases": 0,      "revenue": 0,      "conversion_rate": 0,      "revenue_per_search": 0    }  ]}

Upserts an analytics rule PUT

Upserts an analytics rule with the given name.

Zero-result query share GET

Per-query zero-result rate (the inverse of `results_found_rate`), sorted by zero-result rate then search volume, plus the organization-wide zero-result share for the range. Requires a bounded date range (`from`/`to`, max 366 days).