openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Log Aggregation API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- name: Log Aggregation
description: Aggregate and analyze log data
paths:
/api/v2/logs/analytics/aggregate:
post:
operationId: aggregateLogs
summary: Datadog Aggregate Logs
description: Computes aggregations over log events matching a search query within a specified time range. Supports count, sum, avg, min, max, and percentile aggregations grouped by one or more facets. Results can be used for building analytics charts, dashboards, and reports. Useful for answering questions like "how many errors per service per hour?" or "what is the p99 latency by endpoint?".
tags:
- Log Aggregation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LogsAggregateRequest'
responses:
'200':
description: Successful response with aggregated log analytics
content:
application/json:
schema:
$ref: '#/components/schemas/LogsAggregateResponse'
'400':
description: Bad request - invalid aggregation query or parameters
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'401':
description: Unauthorized - missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions for this operation
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
APIErrorResponse:
type: object
description: Standard API error response returned for failed requests
required:
- errors
properties:
errors:
type: array
description: List of error messages describing the failure
items:
type: string
LogsAggregateResponse:
type: object
description: Response containing aggregated log analytics results
properties:
data:
type: object
description: The aggregation response data
properties:
attributes:
type: object
description: The aggregation result attributes
properties:
buckets:
type: array
description: List of aggregation buckets, each representing a group-by combination
items:
$ref: '#/components/schemas/LogsAggregateBucket'
LogsQueryFilter:
type: object
description: Filter criteria for log search queries
properties:
query:
type: string
description: A Datadog log search query string to filter log events (e.g., service:web status:error)
example: avg:system.cpu.user{*}
indexes:
type: array
description: List of log index names to search; if empty, all indexes are searched
items:
type: string
from:
type: string
description: The start of the time range for the search in ISO 8601 format or relative format (e.g., now-15m)
example: example_value
to:
type: string
description: The end of the time range for the search in ISO 8601 format or relative format (e.g., now)
example: example_value
LogsAggregateBucket:
type: object
description: A single aggregation bucket representing one group-by combination
properties:
by:
type: object
description: The facet values that define this bucket
additionalProperties:
type: string
computes:
type: object
description: The computed aggregation values for this bucket, keyed by computation index
additionalProperties: true
LogsAggregateRequest:
type: object
description: Request body for aggregating log events
properties:
filter:
$ref: '#/components/schemas/LogsQueryFilter'
compute:
type: array
description: List of aggregation computations to perform on the filtered log set
items:
$ref: '#/components/schemas/LogsCompute'
group_by:
type: array
description: List of facets to group results by, enabling breakdown by log attribute
items:
$ref: '#/components/schemas/LogsGroupBy'
options:
type: object
description: Options for the aggregation query
properties:
timezone:
type: string
description: The timezone to use for time-based group-by operations (IANA timezone name)
LogsGroupBy:
type: object
description: A group-by configuration for aggregating log results by facet values
required:
- facet
properties:
facet:
type: string
description: The log attribute or tag to group results by
example: example_value
limit:
type: integer
description: The maximum number of unique facet values to return in results
default: 10
example: 42
sort:
type: object
description: Sort configuration for group-by results
properties:
aggregation:
type: string
description: The aggregation metric to sort by
enum:
- count
- cardinality
- pc75
- pc90
- pc95
- pc98
- pc99
- sum
- avg
- min
- max
order:
type: string
description: The sort direction for group-by results
enum:
- asc
- desc
LogsCompute:
type: object
description: A computation to perform over the filtered log set
required:
- aggregation
- type
properties:
aggregation:
type: string
description: The type of aggregation to compute over log events
enum:
- count
- cardinality
- pc75
- pc90
- pc95
- pc98
- pc99
- sum
- avg
- min
- max
example: count
metric:
type: string
description: The log attribute to aggregate (required for all aggregations except count)
example: example_value
type:
type: string
description: Whether this is a total aggregation or a timeseries
enum:
- total
- timeseries
example: total
interval:
type: string
description: The time interval for timeseries computations (e.g., 1m, 1h, 1d)
example: example_value
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
test_optimization_read: View Test Optimization.
timeseries_query: Query Timeseries data.
usage_read: View your organization's usage and usage attribution.
user_access_invite: Invite other users to your organization.
user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
user_access_read: View users and their roles and settings.
workflows_read: View workflows.
workflows_run: Run workflows.
workflows_write: Create, edit, and delete workflows.
tokenUrl: /oauth2/v1/token
type: oauth2
apiKeyAuth:
description: Your Datadog API Key.
in: header
name: DD-API-KEY
type: apiKey
x-env-name: DD_API_KEY
appKeyAuth:
description: Your Datadog APP Key.
in: header
name: DD-APPLICATION-KEY
type: apiKey
x-env-name: DD_APP_KEY
bearerAuth:
scheme: bearer
type: http
x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
paths: false