v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Event Enrichments

List Event Enrichments

Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields.

<!-- theme: warning -->

Early Access

This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.

Retrieve a list of all Event Enrichments in the account.

get/enrichment/event_enrichments

Query parameters

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

include[]string[]

Include additional details. Supported value is "privileges".

Headers

Acceptstring required

The Accept header is used as a versioning header.

Response

A list of Event Enrichments for the account.

limitinteger

The minimum of the limit parameter used in the request or the maximum request size of the API.

offsetinteger

Echoes offset pagination property.

moreboolean

Indicates if there are additional records to return.

totalinteger nullable

The total number of records matching the given query.