Datadog · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Datadog Events API
15 actions
15 updates
phrasing
extends
openapi/datadog-events-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Datadog's API. It is a proposal applied on top of the contract, not a document Datadog publishes.
What the actions change
x-apievangelist-phrasing
Targets 15
$.info
$.paths['/api/v2/ci/pipeline'].post
$.paths['/api/v2/ci/pipelines/events'].get
$.paths['/api/v2/ci/pipelines/events/search'].post
$.paths['/api/v2/ci/tests/events'].get
$.paths['/api/v2/ci/tests/events/search'].post
$.paths['/api/v2/dora/failures'].post
$.paths['/api/v2/dora/failures/{failure_id}'].get
$.paths['/api/v2/dora/incident'].post
$.paths['/api/v2/events'].get
$.paths['/api/v2/events'].post
$.paths['/api/v2/events/search'].post
$.paths['/api/v2/rum/events'].get
$.paths['/api/v2/rum/events/search'].post
$.paths['/api/v2/events/{event_id}'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Datadog Events API
version: 1.0.0
extends: openapi/datadog-events-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 14
- target: $.paths['/api/v2/ci/pipeline'].post
update:
x-apievangelist-phrasing:
intent: Send a CI pipeline event
effect: write
questions:
- How do I report a pipeline run from an unsupported CI provider to CI Visibility?
- Can I send pipeline execution data over HTTP?
instructions:
- text: 'Send this CI pipeline event to CI Visibility: {data}.'
slots:
data: requestBody.data
- text: Report a finished pipeline run with {data}.
slots:
data: requestBody.data
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/ci/pipelines/events'].get
update:
x-apievangelist-phrasing:
intent: List CI pipeline events
effect: read
questions:
- Which CI pipelines ran in the last hour?
- Can I page through pipeline events with a cursor?
instructions:
- text: List my latest CI pipeline events.
- text: List pipeline events matching {query} between {from} and {to}.
slots:
query: query.filter[query]
from: query.filter[from]
to: query.filter[to]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/ci/pipelines/events/search'].post
update:
x-apievangelist-phrasing:
intent: Search CI pipeline events with complex filters
effect: read
questions:
- How do I run a complex search across CI pipeline events?
- Can I search pipeline events with a timezone offset and custom sort?
instructions:
- text: Search CI pipeline events with filter {filter}.
slots:
filter: requestBody.filter
- text: Run a pipeline event search using {filter} sorted by {sort}.
slots:
filter: requestBody.filter
sort: requestBody.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/ci/tests/events'].get
update:
x-apievangelist-phrasing:
intent: List CI test events
effect: read
questions:
- Which tests ran in my CI recently?
- Can I list test events from a specific time window?
instructions:
- text: List my latest CI test events.
- text: List test events matching {query} between {from} and {to}.
slots:
query: query.filter[query]
from: query.filter[from]
to: query.filter[to]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/ci/tests/events/search'].post
update:
x-apievangelist-phrasing:
intent: Search CI test events with complex filters
effect: read
questions:
- How can I search CI test events, for example to find flaky failures?
- Is there a POST search for test events that supports paging options?
instructions:
- text: Search CI test events with filter {filter}.
slots:
filter: requestBody.filter
- text: Run a test event search using {filter} and paging {page}.
slots:
filter: requestBody.filter
page: requestBody.page
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/dora/failures'].post
update:
x-apievangelist-phrasing:
intent: List DORA failure events
effect: read
questions:
- Which DORA failure events have been recorded for my services?
- Can I query failure events used for change failure rate?
instructions:
- text: List DORA failure events matching {data}.
slots:
data: requestBody.data
- text: Get DORA failures for the query {data}.
slots:
data: requestBody.data
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/dora/failures/{failure_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a DORA failure event
effect: read
questions:
- How can I look up one DORA failure event by ID?
- What details does a single failure event include?
instructions:
- text: Get DORA failure event {failure_id}.
slots:
failure_id: path.failure_id
- text: Show the failure event {failure_id}.
slots:
failure_id: path.failure_id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/dora/incident'].post
update:
x-apievangelist-phrasing:
intent: Send an incident event for DORA metrics
effect: write
questions:
- How do I feed incident data into DORA change failure rate and time to restore?
- Can I report a production failure for DORA metrics?
instructions:
- text: Send a DORA incident event with {data}.
slots:
data: requestBody.data
- text: Record a failure for DORA metrics using {data}.
slots:
data: requestBody.data
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/events'].get
update:
x-apievangelist-phrasing:
intent: List recent events
effect: read
questions:
- What events happened in my Datadog org in the last 24 hours?
- Can I filter the event stream by a search query and millisecond timestamps?
instructions:
- text: List my latest events.
- text: List events matching {query} from {from} to {to}.
slots:
query: query.filter[query]
from: query.filter[from]
to: query.filter[to]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/events'].post
update:
x-apievangelist-phrasing:
intent: Post a change event
effect: write
questions:
- How do I post a deployment or config change event for Change Tracking?
- Which event categories are generally available when posting events?
instructions:
- text: 'Post this change event: {data}.'
slots:
data: requestBody.data
- text: Record a change event for Change Tracking with {data}.
slots:
data: requestBody.data
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/events/search'].post
update:
x-apievangelist-phrasing:
intent: Search events with complex filters
effect: read
questions:
- How can I build a complex event search with custom sorting?
- Can I search events using a timezone instead of a time offset?
instructions:
- text: Search events with filter {filter}.
slots:
filter: requestBody.filter
- text: Run an event search using {filter} sorted by {sort}.
slots:
filter: requestBody.filter
sort: requestBody.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/rum/events'].get
update:
x-apievangelist-phrasing:
intent: List RUM events
effect: read
questions:
- What are the latest real user sessions and views captured by RUM?
- Can I list RUM events with a RUM search query?
instructions:
- text: List my latest RUM events.
- text: List RUM events matching {query} between {from} and {to}.
slots:
query: query.filter[query]
from: query.filter[from]
to: query.filter[to]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/rum/events/search'].post
update:
x-apievangelist-phrasing:
intent: Search RUM events with complex filters
effect: read
questions:
- How do I run a complex search over RUM events?
- Is there a POST endpoint for filtering RUM events with paging?
instructions:
- text: Search RUM events with filter {filter}.
slots:
filter: requestBody.filter
- text: Run a RUM event search using {filter} and paging {page}.
slots:
filter: requestBody.filter
page: requestBody.page
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/events/{event_id}'].get
update:
x-apievangelist-phrasing:
intent: Get an event by ID
effect: read
questions:
- How can I see the full details of one event, including tags and hosts?
- Can I fetch an event using the ID returned when I posted it?
instructions:
- text: Get event {event_id}.
slots:
event_id: path.event_id
- text: Show full details for event {event_id}.
slots:
event_id: path.event_id
method: generated
generated: '2026-10-01'