List Event Types

List event types with aggregated statistics.

Scopes: events:read events:write

GET /v1/event-types

List Event Types

cURL

curl --request GET \
  --url https://api.spairehq.com/v1/event-types/ \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "label": "<string>",
      "organization_id": "<string>",
      "occurrences": 123,
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z",
      "label_property_selector": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

patoat

Authorization · string · header · required

You can generate a Personal Access Token from your settings.

Query Parameters

organization_id · string<uuid4> string<uuid4>[]

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

customer_id · string<uuid4> string<uuid4>[]

Filter by customer ID. The customer ID.

external_customer_id · string string[]

Filter by external customer ID.

query · string | null

Query to filter event types by name or label.

root_events · boolean · default: false

When true, only return event types with root events (parent_id IS NULL).

parent_id · string<uuid> | null

Filter by specific parent event ID.

source · enum<string> | null

Filter by event source (system or user).

Available options: system, user

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

Size of a page, defaults to 10. Maximum is 100.

sorting · enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options: name, -name, label, -label, occurrences, -occurrences, first_seen, -first_seen, last_seen, -last_seen

Response

200

application/json

Successful Response

items · EventTypeWithStats · object[] · required

Show child attributes

pagination · Pagination · object · required

Show child attributes