Sign in

v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Search Usage

Retrieve search keyword events

Deprecated. Use the Search Executions endpoint instead.

get/v7/analytics/api/v1/search/keyword

Query parameters

limitinteger

The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.

cursorstring

Cursor mark returned in the response headers to be used for pagination purposes.

fromDateTimestring date-time

Retrieve keyword events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.

toDateTimestring date-time

Set a date range together with the "fromDateTime" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.

Response

Successful response

idstring
eventTypestring
userIdstring
dateTimestring date-time
keywordstring
totalResultsinteger
tagsResultsinteger
assetsResultsinteger
documentsResultsinteger
guidelinesResultsinteger
collectionsResultsinteger
metapropertiesResultsinteger
collectionAssetsResultsinteger
workflowCampaignsResultsinteger
brandstoreProductsResultsinteger

Example response

[
  {
    "id": "62de6d714e29485a81824fe3",
    "eventType": "search.keyword",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "keyword": "digital templates",
    "totalResults": 27,
    "assetsResults": 24,
    "collectionsResults": 3
  }
]