Event Types
List and get project-scoped 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.
Harness Service Account Token (SAT) or Personal Access Token (PAT). Generate tokens in Harness under Account Settings → Access Management.
Harness account identifier. Required on all endpoints.
{{accountId}}Pattern: ^[-_A-Za-z0-9]+$Harness organization identifier.
defaultPattern: ^[-_A-Za-z0-9]+$Harness project identifier.
my_projectPattern: ^[-_A-Za-z0-9]+$Number of items to return per page. Defaults to 100, maximum 100.
100Example: 100Number of items to skip before the first returned result. Defaults to 0.
0Example: 0Case-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.
Filter to event types associated with the given traffic type, by id or name. A traffic type outside the requesting workspace matches nothing.
OK — paginated list of event types returned.
10002Bad Request — validation errors or invalid state transition.
Unauthorized — the request is missing a valid API key, or the key has expired.
Forbidden — the caller is authenticated but not permitted to perform this operation.
Returned when the API can deny the operation without leaking whether a resource exists,
such as create, or write operations where the caller can already read the resource. When
returning 403 would reveal resource existence, the API returns 404 instead.
Environment-scoped mutations that require approval also return 403.
Too Many Requests — the caller has exceeded the rate limit for this endpoint.
Internal Server Error — an unexpected error occurred while processing the request.
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
}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.
Harness Service Account Token (SAT) or Personal Access Token (PAT). Generate tokens in Harness under Account Settings → Access Management.
Event type id — the event name assigned by the ingestion pipeline (the value sent as
eventTypeId by SDKs), not a system-generated UUID.
purchaseHarness account identifier. Required on all endpoints.
{{accountId}}Pattern: ^[-_A-Za-z0-9]+$Harness organization identifier.
defaultPattern: ^[-_A-Za-z0-9]+$Harness project identifier.
my_projectPattern: ^[-_A-Za-z0-9]+$OK — event type returned.
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.
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.
purchaseBad Request — validation errors or invalid state transition.
Unauthorized — the request is missing a valid API key, or the key has expired.
Forbidden — the caller is authenticated but not permitted to perform this operation.
Returned when the API can deny the operation without leaking whether a resource exists,
such as create, or write operations where the caller can already read the resource. When
returning 403 would reveal resource existence, the API returns 404 instead.
Environment-scoped mutations that require approval also return 403.
Not Found — the requested resource does not exist. Also returned when the caller lacks access to the resource (to avoid leaking resource existence).
Too Many Requests — the caller has exceeded the rate limit for this endpoint.
Internal Server Error — an unexpected error occurred while processing the request.
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?