v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB

Search Usage

Retrieve search execution events

get/v7/analytics/api/v1/search/executions

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 executions 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

eventIdstring

eventTypestring

dateTimestring date-time

userIdstring

termsstring[]

operatorstring

Example response

[
  {
    "eventId": "1408aec2-3114-43dd-be20-ffb1246a5231",
    "eventType": "SearchExecuted",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "terms": [
      "digital"
    ],
    "filters": [
      {
        "field": "language",
        "value": "english"
      }
    ],
    "operator": "OR",
    "sortOrder": {
      "field": "datePublished",
      "order": "desc"
    },
    "results": {
      "assets": 48
    }
  }
]