Skip to main content
GET
Get Popular Search Terms
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs. Use this to fill a “popular searches” list before the shopper types anything.

Headers

x-tenant-id
string
required

Identifies your organization. Ensures data isolation per tenant.

x-workspace-id
string
required

Identifies the workspace within your organization. Scopes resources to a specific workspace.

x-environment-id
string
required

Identifies the environment you are targeting. Scopes the call to a specific deployment environment.

Query Parameters

catalog_id
string
required

The catalog to return popular terms for. Unlike most endpoints this is not validated as a UUID, but an unknown catalog returns 404.

limit
integer
default:5

How many terms to return.

skip
integer
default:0

How many terms to skip before the first one returned.

Response

Success.