Operations
GETGet search analytics/api/v1/search/overview
GETList search queries/api/v1/search/queries
GETList occurrences of a search query/api/v1/search/queries/{query_hash}
GETList search rules/api/v1/search/rules
POSTCreate a search rule/api/v1/search/rules
DELETEDelete a search rule/api/v1/search/rules/{rule_id}
GETGet a search rule/api/v1/search/rules/{rule_id}
PATCHUpdate a search rule/api/v1/search/rules/{rule_id}
How it works
GET /api/v1/search/overview and /api/v1/search/queries expose summary statistics and grouped queries. Fetch a query's occurrences using its query_hash. Reporting periods support 7, 30 or 90 days, with the filters listed by each endpoint.
Search rules connect phrases to selected products and categories and can be created, read, updated or deleted. Rules and analytics have separate permissions; reading search statistics does not grant configuration access.