Skip to content

Event types

Lists distinct generic-event (vendor, category, action) combinations that have been emitted in a date range.

Those three fields are the loose type mask used to describe a generic event: you typically match on some subset of vendor / category / action (and maybe label) rather than on every column. This endpoint is for exploring which masks exist in your data — not for listing individual rows.

How-to: Event type catalog.

To list matching rows, see Generic events. Chat messages are a different dataset and are not included.

Authentication

For server-to-server calls, authenticate with a user API token: Authorization: Token <api token>. OAuth2 access tokens use Authorization: Bearer <access token> instead. How to obtain and use each: Get API token. The URL organization_id must match the authenticated organization.

Endpoint

POST https://api.giosg.com/api/objectives/v1/orgs/<organization_id>/event-types

Payload

Attribute Type Description
start datetime Inclusive start of collector_created_at (ISO-8601). Required.
end datetime Inclusive end of collector_created_at (ISO-8601). Required. Must be after start.
include_blacklisted_categories boolean Include internal/system categories. Default false.
1
2
3
4
{
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-31T23:59:59Z"
}

Response

Attribute Type Description
organization_id string Organization UUID.
start_date string Start used.
end_date string End used.
include_blacklisted_categories boolean Whether internal categories were included.
count number Number of distinct combinations.
event_types array Distinct type masks: objects with vendor, category, action.

No 2-day window limit and no pagination — unlike list events. The range uses collector_created_at, which is functionally the same as timestamp (they may differ by milliseconds). Both exist for legacy reasons; a later API will use timestamp only.

Errors: 400 for an invalid range; 401/403 for auth; 503 when the analytics backend is unavailable.