Datadog Events API
The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information.**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question.
Datadog Events API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes 23 operations across 22 paths, and defines 239 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
23 operations
22 paths
239 schemas
8 GET15 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Datadog Events API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes.
An API key is passed in the header as DD-API-KEY (apiKeyAuth).
An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth).
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
AuthZ— This API uses OAuth 2 with the implicit grant flow.apiKeyAuth— Your Datadog API Key.appKeyAuth— Your Datadog APP Key.
Paths & Operations 23
Across 22 paths, the API surfaces 23 operations — 8 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.
Events 23
The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.…
GET
/api/v2/audit/events
Datadog Get a List of Audit Logs Events
POST
/api/v2/audit/events/search
Datadog Search Audit Logs Events
POST
/api/v2/ci/pipeline
Datadog Send Pipeline Event
POST
/api/v2/ci/pipelines/analytics/aggregate
Datadog Aggregate Pipelines Events
GET
/api/v2/ci/pipelines/events
Datadog Get a List of Pipelines Events
POST
/api/v2/ci/pipelines/events/search
Datadog Search Pipelines Events
POST
/api/v2/ci/tests/analytics/aggregate
Datadog Aggregate Tests Events
GET
/api/v2/ci/tests/events
Datadog Get a List of Tests Events
POST
/api/v2/ci/tests/events/search
Datadog Search Tests Events
POST
/api/v2/dora/deployment
Datadog Send a Deployment Event for Dora Metrics
POST
/api/v2/dora/deployments
Datadog Get a List of Deployment Events
GET
/api/v2/dora/deployments/{deployment_id}
Datadog Get a Deployment Event
POST
/api/v2/dora/failures
Datadog Get a List of Failure Events
GET
/api/v2/dora/failures/{failure_id}
Datadog Get a Failure Event
POST
/api/v2/dora/incident
Datadog Send an Incident Event for Dora Metrics
GET
/api/v2/events
Datadog Get a List of Events
POST
/api/v2/events
Datadog Post an Event
POST
/api/v2/events/search
Datadog Search Events
POST
/api/v2/logs/analytics/aggregate
Datadog Aggregate Events
POST
/api/v2/rum/analytics/aggregate
Datadog Aggregate Rum Events
GET
/api/v2/rum/events
Datadog Get a List of Rum Events
POST
/api/v2/rum/events/search
Datadog Search Rum Events
GET
/api/v2/events/{event_id}
Datadog Get an Event
Schemas 239
The contract defines 239 schemas that model the data the API accepts and returns. The most detailed are CIAppPipelineEventFinishedPipeline (20 properties), EventAttributes (19 properties), CIAppPipelineEventInProgressPipeline (19 properties), CIAppPipelineEventJob (19 properties). Each schema is shown below with its type and property counts.
CIAppGroupByTotal
A resulting object to put the given computes in over all the matching records.
LogsAggregateRequestPage
object
Paging settings
1 property
AuditLogsResponsePage
object
Paging attributes.
1 property
RUMResponseStatus
string
The status of the response.
CIAppPipelineEventPipelineInProgressStatus
string
The in progress status of the pipeline.
RUMEventAttributes
object
JSON object containing all event attributes and their associated values.
4 properties
CIAppComputeType
string
The type of compute.
ChangeEventCustomAttributesImpactedResourcesItems
object
Object representing a uniquely identified resource. Only the resource type service is supported.
2 properties
2 required
GitCommitSHA
string
Git Commit SHA.
CIAppAggregateBucketValueSingleString
string
A single string value.
CIAppPipelinesAggregationBucketsResponse
object
The query results.
1 property
EventCreateResponseAttributes
object
JSON object containing all events attributes and their associated values.
1 property
LogsAggregateBucketValueSingleString
string
A single string value
JSONAPIErrorItem
object
API error response body
5 properties
RUMAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of RUM events from your organization.
5 properties
CIAppPipelineEventParameters
object
A map of key-value parameters or environment variables that were defined for the pipeline.
RUMGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
APIErrorResponse_2
object
Standard API error response returned for failed requests
1 property
1 required
CIAppPipelineEventPipelineStatus
string
The final status of the pipeline.
CIAppPipelineEventStageStatus
string
The final status of the stage.
CIAppPipelineEventTags
array
A list of user-defined tags. The tags must follow the key:value pattern.
EventResponseAttributes
object
The object description of an event response attribute.
4 properties
EventsRequestPage
object
Pagination settings.
2 properties
CIAppGroupByMissing
The value to use for logs that don't have the facet used to group-by.
CIAppPipelineEventMetrics
array
A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
DORADeploymentRequestAttributes
object
Attributes to create a DORA deployment event.
8 properties
3 required
DORAGitInfo
object
Git info for DORA Metrics events.
2 properties
2 required
CIAppCompute
object
A compute rule to compute metrics or timeseries.
4 properties
1 required
RUMAggregateBucketValueTimeseries
array
A timeseries array.
EventsListResponse
object
The response object with all events matching the request and pagination information.
3 properties
CIAppPipelineEventStepLevel
string
Used to distinguish between pipelines, stages, jobs and steps.
EventPayloadAttributes
JSON object for custom attributes. Schema are different per each event category.
RUMGroupByTotalNumber
number
A number to use as the key value for the total bucket.
AuditLogsResponseMetadata
object
The metadata associated with a request.
5 properties
CIAppTestsQueryFilter
object
The search and filter query settings.
3 properties
CIAppGitInfo
object
If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not…
12 properties
3 required
CIAppPipelineEventStage
object
Details of a CI stage.
16 properties
8 required
LogsStorageTier
string
Specifies storage type as indexes, online-archives or flex
RUMResponseMetadata
object
The metadata associated with a request.
5 properties
DORAIncidentRequest
object
Request to create a DORA incident event.
1 property
1 required
AuditLogsEventType
string
Type of the event.
CIAppTestsAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of test events from your organization.
4 properties
JSONAPIErrorResponse
object
API error response.
1 property
1 required
LogsGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal"
CIAppTestEvent
object
Object description of test event after being processed and stored by Datadog.
3 properties
DORAListDeploymentsRequestDataType
string
The definition of DORAListDeploymentsRequestDataType object.
ChangeEventCustomAttributesAuthorType
string
Author's type.
CIAppPipelineEventJob
object
Details of a CI job.
19 properties
9 required
CIAppPipelineEventInProgressPipeline
object
Details of a running pipeline.
19 properties
7 required
RUMAggregateBucketValueSingleString
string
A single string value.
EventCreateRequestPayload
object
Payload for creating an event.
1 property
DORAIncidentRequestAttributes
object
Attributes to create a DORA incident event.
10 properties
1 required
Event_2
object
A single event from the Datadog Events Explorer
3 properties
EventsResponseMetadataPage
object
Pagination attributes.
1 property
EventPayload
object
Event attributes.
7 properties
3 required
DORAIncidentResponseData
object
Response after receiving a DORA incident event.
2 properties
1 required
CIAppCreatePipelineEventRequest
object
Request object.
1 property
CIAppPipelineEventTypeName
string
Type of the event.
LogsAggregateBucketValueTimeseriesPoint
object
A timeseries point
2 properties
RUMGroupByTotal
A resulting object to put the given computes in over all the matching records.
CIAppGroupByTotalNumber
number
A number to use as the key value for the total bucket.
CIAppAggregateBucketValueSingleNumber
number
A single number value.
AuditLogsEvent
object
Object description of an Audit Logs event after it is processed and stored by Datadog.
3 properties
LogsGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
ChangeEventCustomAttributesChangedResourceType
string
Resource's type.
CIAppWarning
object
A warning message indicating something that went wrong with the query.
3 properties
RUMSearchEventsRequest
object
The request for a RUM events list.
4 properties
RUMQueryFilter
object
The search and filter query settings.
3 properties
LogsAggregateSort
object
A sort rule
4 properties
CIAppAggregateSort
object
A sort rule. The aggregation field is required when type is measure.
4 properties
CIAppTestEventsRequest
object
The request for a tests search.
4 properties
CIAppComputes
object
A map of the metric name to value for regular compute, or a list of values for a timeseries.
CIAppPipelinesGroupBy
object
A group-by rule.
6 properties
1 required
CIAppPipelineEventsResponse
object
Response object with all pipeline events matching the request and pagination information.
3 properties
RUMQueryPageOptions
object
Paging attributes for listing events.
2 properties
LogsAggregateResponse
object
The response object for the logs aggregate API endpoint
2 properties
CIAppTestsGroupBy
object
A group-by rule.
6 properties
1 required
ChangeEventCustomAttributes
object
Object representing custom change event attributes.
6 properties
1 required
LogsGroupByTotalString
string
A string to use as the key value for the total bucket
AuditLogsWarning
object
Warning message indicating something that went wrong with the query.
3 properties
AuditLogsEventAttributes
object
JSON object containing all event attributes and their associated values.
5 properties
EventPriority
string
The priority of the event's monitor. For example, normal or low.
RUMAnalyticsAggregateResponse
object
The response object for the RUM events aggregate API endpoint.
3 properties
CIAppGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
CIAppCreatePipelineEventRequestAttributesResource
Details of the CI pipeline event.
CIAppCIError
object
Contains information of the CI error.
4 properties
CIAppResponseStatus
string
The status of the response.
EventCreateResponsePayload
object
Response containing information about created event.
1 property
DORADeploymentType
string
JSON:API type for DORA deployment events.
LogsResponseMetadataPage
object
Paging attributes.
1 property
EventStatusType
string
If an alert event is enabled, its status is one of the following: failure, error, warning, info, success, userupdate, recommendation, or snapshot.
CIAppTestEventsResponse
object
Response object with all test events matching the request and pagination information.
3 properties
RUMAggregateBucketValue
A bucket value, can be either a timeseries or a single value.
EventsSort
string
The sort parameters when querying events.
CIAppPipelinesBucketResponse
object
Bucket values.
2 properties
RUMQueryOptions
object
Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
2 properties
CIAppPipelineEventJobLevel
string
Used to distinguish between pipelines, stages, jobs, and steps.
CIAppPipelinesQueryFilter
object
The search and filter query settings.
3 properties
RUMEvent
object
Object description of a RUM event after being processed and stored by Datadog.
3 properties
RUMGroupByTotalString
string
A string to use as the key value for the total bucket.
DORAListDeploymentsRequestData
object
The JSON:API data.
2 properties
1 required
JSONAPIErrorItemSource
object
References to the source of the error.
3 properties
CIAppAggregateSortType
string
The type of sorting algorithm.
DORAListDeploymentsRequestAttributes
object
Attributes to get a list of deployments.
5 properties
DORADeploymentRequest
object
Request to create a DORA deployment event.
1 property
1 required
RUMAggregationBucketsResponse
object
The query results.
1 property
CIAppPipelineEventPreviousPipeline
object
If the pipeline is a retry, this should contain the details of the previous attempt.
2 properties
1 required
EventCreateRequest
object
Object representing an event creation request.
2 properties
ChangeEventCustomAttributesAuthor
object
Object representing the entity which made the change. Optional field but if provided should include type and name.
2 properties
2 required
RUMAggregateSort
object
A sort rule.
4 properties
CIAppGroupByMissingString
string
The missing value to use if there is a string valued facet.
CIAppPipelineEvent
object
Object description of a pipeline event after being processed and stored by Datadog.
3 properties
EventAttributes_2
object
The attributes of an event returned from the Events Explorer
11 properties
CIAppHostInfo
object
Contains information of the host running the pipeline, stage, job, or step.
4 properties
CIAppTestLevel
string
Test run level.
CIAppPipelineEventsRequest
object
The request for a pipelines search.
4 properties
CIAppCreatePipelineEventRequestAttributes
object
Attributes of the pipeline event to create.
4 properties
1 required
DORAIncidentType
string
JSON:API type for DORA incident events.
LogsGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
AuditLogsSearchEventsRequest
object
The request for a Audit Logs events list.
4 properties
AuditLogsEventsResponse
object
Response object with all events matching the request and pagination information.
3 properties
LogsGroupByMissingString
string
The missing value to use if there is string valued facet.
LogsAggregateBucketValueSingleNumber
number
A single number value
EventCreateResponse
object
Object containing an event response.
2 properties
AuditLogsQueryOptions
object
Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.
2 properties
ChangeEventCustomAttributesChangedResource
object
Object representing a uniquely identified resource.
2 properties
2 required
CIAppAggregateBucketValueTimeseries
array
A timeseries array.
CIAppGroupByTotalString
string
A string to use as the key value for the total bucket.
LogsAggregateResponseStatus
string
The status of the response
CIAppPipelineEventAttributes
object
JSON object containing all event attributes and their associated values.
3 properties
DORAListFailuresRequestAttributes
object
Attributes to get a list of failures.
5 properties
CIAppAggregateBucketValue
A bucket value, can either be a timeseries or a single value.
LogsResponseMetadata
object
The metadata associated with a request
5 properties
DORADeploymentResponse
object
Response after receiving a DORA deployment event.
1 property
1 required
LogsAggregateBucketValue
A bucket value, can be either a timeseries or a single value
RUMBucketResponse
object
Bucket values.
2 properties
EventsWarning
object
A warning message indicating something is wrong with the query.
3 properties
CIAppGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
Event
object
The metadata associated with a request.
4 properties
APIErrorResponse
object
API error response.
1 property
1 required
CIAppTestsBucketResponse
object
Bucket values.
2 properties
CIAppPipelinesAnalyticsAggregateResponse
object
The response object for the pipeline events aggregate API endpoint.
3 properties
EventsQueryOptions
object
The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.
2 properties
RUMGroupByMissingString
string
The missing value to use if there is string valued facet.
DORAListDeploymentsRequest
object
Request to get a list of deployments.
1 property
1 required
AuditLogsQueryPageOptions
object
Paging attributes for listing events.
2 properties
EventResponse
object
The object description of an event after being processed and stored by Datadog.
3 properties
RUMEventType
string
Type of the event.
CIAppPipelineLevel
string
Pipeline execution level.
CIAppAggregationFunction
string
An aggregation function.
RUMGroupByMissing
The value to use for logs that don't have the facet used to group by.
EventAttributes
object
Object description of attributes from your event.
19 properties
DORAListFailuresRequest
object
Request to get a list of failures.
1 property
1 required
LogsSortOrder
string
The order to use, ascending or descending
DORAIncidentRequestData
object
The JSON:API data.
1 property
1 required
CIAppTestsAnalyticsAggregateResponse
object
The response object for the test events aggregate API endpoint.
3 properties
HTTPCIAppError
object
List of errors.
3 properties
CIAppPipelineEventFinishedPipeline
object
Details of a finished pipeline.
20 properties
8 required
LogsAggregationFunction
string
An aggregation function
EventCreateResponseAttributesAttributes
object
JSON object of attributes from your events.
1 property
LogsComputeType
string
The type of compute
TagsEventAttribute
array
Array of tags associated with your event.
CIAppAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
CIAppQueryOptions
object
Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.
2 properties
RUMAggregateSortType
string
The type of sorting algorithm.
EventsListRequest
object
The object sent with the request to retrieve a list of events from your organization.
4 properties
RUMGroupBy
object
A group-by rule.
6 properties
1 required
LogsAggregateBucketValueTimeseries
array
A timeseries array
CIAppResponseMetadataWithPagination
object
The metadata associated with a request.
5 properties
RUMSort
string
Sort parameters when querying events.
CIAppCIErrorDomain
string
Error category used to differentiate between issues related to the developer or provider environments.
LogsGroupByMissing
The value to use for logs that don't have the facet used to group by
DORADeploymentResponseData
object
The JSON:API data.
2 properties
1 required
GitRepositoryURL
string
Git Repository URL
LogsAggregateResponseData
object
The query results
1 property
CIAppPipelineEventPipelineLevel
string
Used to distinguish between pipelines, stages, jobs, and steps.
RUMComputeType
string
The type of compute.
CIAppCreatePipelineEventRequestData
object
Data of the pipeline event to create.
2 properties
CIAppPipelineEventStageLevel
string
Used to distinguish between pipelines, stages, jobs and steps.
EventCategory
string
Event category to identify the type of event. Only the value change is supported. Support for other categories are coming. please reach out to datadog support…
RUMSortOrder
string
The order to use, ascending or descending.
LogsQueryOptions
object
Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results.
2 properties
AuditLogsSort
string
Sort parameters when querying events.
LogsQueryFilter
object
The search and filter query settings
5 properties
EventsResponseMetadata
object
The metadata associated with a request.
5 properties
AuditLogsResponseLinks
object
Links attributes.
1 property
RUMResponseLinks
object
Links attributes.
1 property
AuditLogsResponseStatus
string
The status of the response.
ChangeEventCustomAttributesImpactedResourcesItemsType
string
Resource's type.
CIAppTestsAggregationBucketsResponse
object
The query results.
1 property
CIAppCreatePipelineEventRequestDataType
string
Type of the event.
DORAListFailuresRequestDataType
string
The definition of DORAListFailuresRequestDataType object.
CIAppTestEventTypeName
string
Type of the event.
EventType
string
Type of the event.
CIAppQueryPageOptions
object
Paging attributes for listing events.
2 properties
RUMAggregateBucketValueSingleNumber
number
A single number value.
CIAppEventAttributes
object
JSON object containing all event attributes and their associated values.
3 properties
AuditLogsQueryFilter
object
Search and filter query settings.
3 properties
EventResponse_2
object
Response wrapper for a single event
1 property
EventsQueryFilter
object
The search and filter query settings.
3 properties
DORAEvent
object
A DORA event.
3 properties
CIAppPipelineEventParentPipeline
object
If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.
2 properties
1 required
CIAppResponsePage
object
Paging attributes.
1 property
CIAppPipelinesAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of pipeline events from your organization.
4 properties
CIAppSort
string
Sort parameters when querying events.
CIAppPipelineEventStep
object
Details of a CI step.
19 properties
8 required
LogsWarning
object
A warning message indicating something that went wrong with the query
3 properties
DORAListFailuresRequestData
object
The JSON:API data.
2 properties
1 required
RUMEventsResponse
object
Response object with all events matching the request and pagination information.
3 properties
EventCreateRequestType
string
Entity type.
DORAIncidentResponse
object
Response after receiving a DORA incident event.
1 property
1 required
DORADeploymentRequestData
object
The JSON:API data.
1 property
1 required
RUMAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
DORAListResponse
object
Response for the DORA list endpoints.
1 property
EventsListResponseLinks
object
Links attributes.
1 property
MonitorType
object
Attributes from the monitor that triggered the event.
11 properties
LogsGroupByTotal
A resulting object to put the given computes in over all the matching records.
LogsAggregateRequest
object
The object sent with the request to retrieve a list of logs from your organization.
5 properties
RUMWarning
object
A warning message indicating something that went wrong with the query.
3 properties
CIAppPipelineEventPipeline
Details of the top level pipeline, build, or workflow of your CI.
LogsCompute
object
A compute rule to compute metrics or timeseries
4 properties
1 required
CIAppResponseLinks
object
Links attributes.
1 property
CIAppPipelineEventStepStatus
string
The final status of the step.
CIAppPipelineEventJobStatus
string
The final status of the job.
CIAppSortOrder
string
The order to use, ascending or descending.
CIAppResponseMetadata
object
The metadata associated with a request.
4 properties
CIAppGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
DORAFetchResponse
object
Response for the DORA fetch endpoints.
1 property
RUMResponsePage
object
Paging attributes.
1 property
EventCreateResponseAttributesAttributesEvt
object
JSON object of event system attributes.
1 property
HTTPCIAppErrors
object
Errors occurred.
1 property
RUMAggregationFunction
string
An aggregation function.
RUMGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
LogsAggregateBucket
object
A bucket values
2 properties
LogsAggregateSortType
string
The type of sorting algorithm
LogsGroupByTotalNumber
number
A number to use as the key value for the total bucket
RUMGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
LogsGroupBy
object
A group by rule
6 properties
1 required
RUMCompute
object
A compute rule to compute metrics or timeseries.
4 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Datadog 12
Other APIs Datadog publishes across the network.
Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
#Event
Where this information came from
This is an independent, third-party profile of Datadog Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.