Search events with filtering and pagination

`POST /event/search`

For technical personnel to search and analyze events across the system. Allows searching, filtering, and paginating through events independent of ticket ID. Technical information is always included in the results.

Query parameters

offsetintegerquery

Pagination offset

limitintegerquery

Number of items to return (max 100)

orderByFieldenumquery

Field to sort by (only indexed fields are supported)

orderByDirectionenumquery

Sort direction

includeTracesbooleanquery

Whether to include event traces in the response

formatenumquery

Response format. 'formatted' returns processed events with typed data and transformations. 'raw' returns raw database objects with JSON fields decoded but without additional postprocessing.

Request body

Filters for searching events

filtersobject[]body

Array of filter objects for searching events. Supported filter fields (indexed fields only): e.id, e.type, e.subType, e.contractId, e.ticketId, e.status, e.createdAt, e.createdBy Note: e.subType can only be used in combination with e.type due to the way the database is indexed. Supported comparators: - "=" (equals) - "!=" (not equals) - ">" (greater than) - "<" (less than) - ">=" (greater than or equal) - "<=" (less than or equal) - "in" (in list, use with 'values' array) - "between" (between range, use with 'from' and 'to') Special key 'q': - A filter with key 'q' will search across all JSON data fields (data, outcome, hookOutcome) - Example: {"key":"q","comparator":"equal","value":"abc"} searches for "abc" in all JSON fields - Must be used with at least one other non-LIKE filter (e.g. status, id, date) - An exception will be thrown if used without other non-LIKE filters - The 'value' parameter is required Special date values for date comparisons: - "CURRENT_TIME" - Current time - "CURRENT_DATE" - Current date - "-1 DAY" - Yesterday - "1 DAY" - Tomorrow - "-1 HOUR" - One hour ago - "1 HOUR" - One hour from now Example: - {"filters":[{"key":"e.ticketId","value":"8","comparator":"="},{"key":"e.type","values":["TicketUpdated"],"comparator":"in"}]}

Request Example

{
  "filters": [
    {
      "key": "channel",
      "comparator": "in",
      "values": [
        "email"
      ],
      "value": 1609459200,
      "from": 1609459200,
      "to": 1612051200
    }
  ]
}

Responses

200 — Successful operation

Response Example

{
  "events": [
    {
      "id": 1,
      "status": "open",
      "user": {
        "id": 1,
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string"
      },
      "createdAt": "2026-01-01T12:00:00Z",
      "activity": "string",
      "details": [
        {
          "label": "string",
          "value": "string",
          "type": "string",
          "url": "string"
        }
      ],
      "tabs": [
        {
          "key": "string",
          "label": "string"
        }
      ],
      "eventTraces": [
        null
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "limit": 1
  }
}

403 — Forbidden - Insufficient permissions