v4

latestSwagger 2.02026-08-0343714211.7 MB

event_records

Event Records

List Event Records

get/event_records

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are event_type, created_at or workspace_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, event_type or workspace_id. Valid field combinations are [ event_type, created_at ], [ workspace_id, created_at ], [ workspace_id, event_type ] or [ workspace_id, event_type, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is prefixed by the supplied value. Valid fields are event_type.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of EventRecords objects.

idinteger

Event Record ID

workspace_idinteger

Workspace ID. 0 means the default workspace or site-wide.

event_uuidstring

Stable event UUID.

event_typestring

Versioned event type string.

severity'info' | 'warning' | 'error' | 'critical'

Event severity.

source_typestring

Source record type.

source_idinteger

Source record ID.

occurred_atstring date-time

Event occurrence date/time.

human_titlestring

Human-readable event title.

human_summarystring

Human-readable event summary.

human_fieldsobject[]

Human-readable event detail fields.

actorobject

Actor associated with the event.

resourcesobject[]

Resources associated with the event.

payloadobject

Event payload.

created_atstring date-time

Event Record create date/time.

Example response

[
  {
    "id": 1,
    "workspace_id": 1,
    "event_uuid": "example",
    "event_type": "example",
    "severity": "example",
    "source_type": "example",
    "source_id": 1,
    "occurred_at": "2000-01-01T01:00:00Z",
    "human_title": "example",
    "human_summary": "example",
    "human_fields": [
      "example"
    ],
    "resources": [
      "example"
    ],
    "created_at": "2000-01-01T01:00:00Z"
  }
]