Skip to content

Event type catalog

Explore which generic-event type masks have been emitted — distinct vendor, category, and action combinations in a date range. Those three fields are the loose mask used to describe a generic event (and to filter rows later). This is a catalog of types, not individual rows.

To fetch matching rows, see Listing generic events. Chat messages are a different dataset and are not included.

Base URL: https://api.giosg.com/api/objectives/v1/orgs/<organization_id>

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.

Basic request

1
2
3
4
5
6
7
8
POST /event-types
Authorization: Token <api token>
Content-Type: application/json

{
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-31T23:59:59Z"
}

The response is an event_types array of { vendor, category, action } objects, plus a count. Use a returned combination as a type mask when writing a list filter, a pipeline step, or when deciding what to send next.

Unlike listing endpoints, this call is not limited to a 2-day window and is not paginated. 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.

Including internal types

By default, internal/system categories are omitted. Add them when you need the full catalog:

1
2
3
4
5
{
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-01-31T23:59:59Z",
  "include_blacklisted_categories": true
}

What to do with the result

Typical next steps:

Full request/response tables: Event types reference.