{ "opencollection": "1.0.0", "info": { "name": "Datadog Account Events API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Datadog Get a List of Audit Logs Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/audit/events", "params": [ { "name": "filter[query]", "value": "@type:session @application_id:xxxx", "type": "query", "description": "Search query following Audit Logs syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ] }, "docs": "List endpoint returns events that match a Audit Logs search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest Audit Logs events.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination" }, { "info": { "name": "Datadog Search Audit Logs Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/audit/events/search", "body": { "type": "json", "data": "{}" } }, "docs": "List endpoint returns Audit Logs events that match an Audit search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex Audit Logs events filtering and search.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination" }, { "info": { "name": "Datadog Send Pipeline Event", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipeline", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).\n\nPipeline events can be submitted with a timestamp that is up to 18 hours in the past." }, { "info": { "name": "Datadog Aggregate Pipelines Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Get a List of Pipelines Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events", "params": [ { "name": "filter[query]", "value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest pipeline events." }, { "info": { "name": "Datadog Search Pipelines Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search." }, { "info": { "name": "Datadog Aggregate Tests Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/tests/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Get a List of Tests Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/tests/events", "params": [ { "name": "filter[query]", "value": "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest test events." }, { "info": { "name": "Datadog Search Tests Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/tests/events/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search." }, { "info": { "name": "Datadog Send a Deployment Event for Dora Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/deployment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate" }, { "info": { "name": "Datadog Get a List of Deployment Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/deployments", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a list of deployment events." }, { "info": { "name": "Datadog Get a Deployment Event", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/dora/deployments/:deployment_id", "params": [ { "name": "deployment_id", "value": "abc-123-def", "type": "path", "description": "The ID of the deployment event." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a deployment event." }, { "info": { "name": "Datadog Get a List of Failure Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/failures", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a list of failure events." }, { "info": { "name": "Datadog Get a Failure Event", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/dora/failures/:failure_id", "params": [ { "name": "failure_id", "value": "abc-123-def", "type": "path", "description": "The ID of the failure event." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to get a failure event." }, { "info": { "name": "Datadog Send an Incident Event for Dora Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/dora/incident", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore" }, { "info": { "name": "Datadog Get a List of Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/events", "params": [ { "name": "filter[query]", "value": "avg:system.cpu.user{*}", "type": "query", "description": "Search query following events syntax." }, { "name": "filter[from]", "value": "example_value", "type": "query", "description": "Minimum timestamp for requested events, in milliseconds." }, { "name": "filter[to]", "value": "example_value", "type": "query", "description": "Maximum timestamp for requested events, in milliseconds." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns events that match an events search query.\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest events." }, { "info": { "name": "Datadog Post an Event", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "This endpoint allows you to post events.\n\n✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details.\n\n❌ For use cases involving other event categories, please use the V1 endpoint." }, { "info": { "name": "Datadog Search Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/events/search", "body": { "type": "json", "data": "{}" } }, "docs": "List endpoint returns events that match an events search query.\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search." }, { "info": { "name": "Datadog Aggregate Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/logs/analytics/aggregate", "body": { "type": "json", "data": "{}" } }, "docs": "The API endpoint to aggregate events into buckets and compute metrics and timeseries." }, { "info": { "name": "Datadog Aggregate Rum Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Get a List of Rum Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/rum/events", "params": [ { "name": "filter[query]", "value": "@type:session @application_id:xxxx", "type": "query", "description": "Search query following RUM syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns events that match a RUM search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest RUM events.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination" }, { "info": { "name": "Datadog Search Rum Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/rum/events/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns RUM events that match a RUM search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex RUM events filtering and search.\n\n[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination" }, { "info": { "name": "Datadog Get an Event", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/events/:event_id", "params": [ { "name": "event_id", "value": "", "type": "path", "description": "The unique string identifier of the event to retrieve" } ] }, "docs": "Returns the full details of a specific event identified by its unique event ID. Includes the event title, text, timestamp, source, tags, alert type, priority, and associated hosts. The event ID is returned when creating events or from list event responses." } ] } ], "bundled": true }