For the complete documentation index, see llms.txt. This page is also available as Markdown.

Event Types

List and get project-scoped event types.

List Event Types

get
/v4/event-types

Returns a paginated list of Event Types in the specified project workspace, ordered by id. Results can be filtered by id substring or traffic type.

Event types are only known from events actually received, and only the last 30 days are considered: an event type that has received no events in that window is not returned.

Authorizations
x-api-keystringRequired

Harness Service Account Token (SAT) or Personal Access Token (PAT). Generate tokens in Harness under Account Settings → Access Management.

Query parameters
account_idstring · max: 128Required

Harness account identifier. Required on all endpoints.

Example: {{accountId}}Pattern: ^[-_A-Za-z0-9]+$
organization_identifierstring · max: 128Required

Harness organization identifier.

Example: defaultPattern: ^[-_A-Za-z0-9]+$
project_identifierstring · max: 128Required

Harness project identifier.

Example: my_projectPattern: ^[-_A-Za-z0-9]+$
limitinteger · min: 1 · max: 100Optional

Number of items to return per page. Defaults to 100, maximum 100.

Default: 100Example: 100
offsetintegerOptional

Number of items to skip before the first returned result. Defaults to 0.

Default: 0Example: 0
namestringOptional

Case-insensitive substring match on the event type id. Event types have no separate display name, so this filters on the same value returned as id.

traffic_typestringOptional

Filter to event types associated with the given traffic type, by id or name. A traffic type outside the requesting workspace matches nothing.

Responses
200

OK — paginated list of event types returned.

application/json
limitintegerRequiredExample: 100
offsetintegerRequiredExample: 0
totalCountinteger · int64RequiredExample: 2
get/v4/event-types
GET /fme/api/v4/event-types?account_id={{accountId}}&organization_identifier=default&project_identifier=my_project HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "id": "purchase",
      "trafficTypes": [
        {
          "id": "ad2eb8f0-9c3a-11ed-873c-e234abaad323",
          "name": "user"
        }
      ]
    }
  ],
  "limit": 100,
  "offset": 0,
  "totalCount": 1
}

Get an Event Type

get
/v4/event-types/{event-type-id}

Returns a single Event Type by its id (the ingestion-assigned event name). An event type that exists but has no traffic type in scope for the requesting workspace is hidden as a 404, to avoid leaking cross-workspace existence.

As with the list operation, only the last 30 days of received events are considered, so an event type that has been idle longer than that also returns 404.

Authorizations
x-api-keystringRequired

Harness Service Account Token (SAT) or Personal Access Token (PAT). Generate tokens in Harness under Account Settings → Access Management.

Path parameters
event-type-idstringRequired

Event type id — the event name assigned by the ingestion pipeline (the value sent as eventTypeId by SDKs), not a system-generated UUID.

Example: purchase
Query parameters
account_idstring · max: 128Required

Harness account identifier. Required on all endpoints.

Example: {{accountId}}Pattern: ^[-_A-Za-z0-9]+$
organization_identifierstring · max: 128Required

Harness organization identifier.

Example: defaultPattern: ^[-_A-Za-z0-9]+$
project_identifierstring · max: 128Required

Harness project identifier.

Example: my_projectPattern: ^[-_A-Za-z0-9]+$
Responses
200

OK — event type returned.

application/json

A project-scoped Event Type. Event types are read-only: they are observed by the events ingestion pipeline rather than created through this API, which is also why they carry no display name or description — the pipeline records neither.

idstringRequired

The event name assigned by the ingestion pipeline (the value sent as eventTypeId by SDKs) — not a system-generated UUID. Use this value as baseEventTypes[].eventTypeId or filterEventType.eventTypeId when creating a metric.

Example: purchase
get/v4/event-types/{event-type-id}
GET /fme/api/v4/event-types/{event-type-id}?account_id={{accountId}}&organization_identifier=default&project_identifier=my_project HTTP/1.1
Host: app.harness.io
x-api-key: YOUR_API_KEY
Accept: */*
{
  "id": "purchase",
  "trafficTypes": [
    {
      "id": "ad2eb8f0-9c3a-11ed-873c-e234abaad323",
      "name": "user"
    }
  ]
}

Last updated

Was this helpful?