Skip to content
ShopentlyLearn
English

Search analytics and rules

Read search activity and maintain rules used by the store search.

Search statistics and queries

Get search analyticsGet search analytics using GET /api/v1/search/overview. Select the time window with days and inspect the returned summary fields. GET List search queriesView customer search phrases, no-result searches and click metrics. GET List occurrences of a search queryList occurrences for a query_hash using Shopently API. Filter by time range, source and market, and paginate the returned occurrences with a cursor. GET

Search rules

List search rulesView search rules. For external integration operations. GET Get a search ruleView search rules. For external integration operations. GET Create a search ruleCreate search rules. For external integration operations. POST Update a search ruleEdit search rules. For external integration operations. PATCH Delete a search ruleDelete search rules. For external integration operations. DELETE

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.