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 Family 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: Family
paths:
/api/v2/usage/hourly_usage:
get:
description: Get hourly usage by product family.
operationId: GetHourlyUsage
parameters:
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.'
in: query
name: filter[timestamp][start]
required: true
schema:
format: date-time
type: string
example: '2026-04-17T12:00:00Z'
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour.'
in: query
name: filter[timestamp][end]
required: false
schema:
format: date-time
type: string
example: '2026-04-17T12:00:00Z'
- description: 'Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`,
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`,
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`,
`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`,
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`, `observability_pipelines`,
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`,
`synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management`,
and `workflow_executions`.
The following product family has been **deprecated**: `audit_logs`.'
in: query
name: filter[product_families]
required: true
schema:
type: string
example: example_value
- description: Include child org usage in the response. Defaults to false.
in: query
name: filter[include_descendants]
required: false
schema:
default: false
type: boolean
example: true
- description: Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false.
in: query
name: filter[include_connected_accounts]
required: false
schema:
default: false
type: boolean
example: true
- description: Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false.
in: query
name: filter[include_breakdown]
required: false
schema:
default: false
type: boolean
example: true
- description: 'Comma separated list of product family versions to use in the format `product_family:version`. For example,
`infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested
product family. Currently all families have one version `1.0.0`.'
in: query
name: filter[versions]
required: false
schema:
type: string
example: example_value
- description: Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified.
in: query
name: page[limit]
required: false
schema:
default: 500
format: int32
maximum: 500
minimum: 1
type: integer
example: 42
- description: List following results with a next_record_id provided in the previous query.
in: query
name: page[next_record_id]
required: false
schema:
type: string
example: abc-123-def
responses:
'200':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/HourlyUsageResponse'
description: OK
'400':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
'429':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- usage_read
summary: Datadog Get Hourly Usage by Product Family
tags:
- Family
x-menu-order: 1
x-permission:
operator: OR
permissions:
- usage_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
HourlyUsageMetadata:
description: The object containing document metadata.
properties:
pagination:
$ref: '#/components/schemas/HourlyUsagePagination'
type: object
HourlyUsageResponse:
description: Hourly usage response.
properties:
data:
description: Response containing hourly usage.
items:
$ref: '#/components/schemas/HourlyUsage'
type: array
meta:
$ref: '#/components/schemas/HourlyUsageMetadata'
type: object
HourlyUsage:
description: Hourly usage for a product family for an org.
properties:
attributes:
$ref: '#/components/schemas/HourlyUsageAttributes'
id:
description: Unique ID of the response.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/UsageTimeSeriesType'
type: object
UsageTimeSeriesType:
default: usage_timeseries
description: Type of usage data.
enum:
- usage_timeseries
example: usage_timeseries
type: string
x-enum-varnames:
- USAGE_TIMESERIES
HourlyUsageMeasurement:
description: Usage amount for a given usage type.
properties:
usage_type:
description: Type of usage.
type: string
example: metric alert
value:
description: Contains the number measured for the given usage_type during the hour.
format: int64
nullable: true
type: integer
example: 42
type: object
HourlyUsageAttributes:
description: Attributes of hourly usage for a product family for an org for a time period.
properties:
account_name:
description: The account name.
type: string
example: Example Monitor
account_public_id:
description: The account public ID.
type: string
example: abc-123-def
measurements:
description: List of the measured usage values for the product family for the org for the time period.
items:
$ref: '#/components/schemas/HourlyUsageMeasurement'
type: array
org_name:
description: The organization name.
type: string
example: Example Monitor
product_family:
description: The product for which usage is being reported.
type: string
example: example_value
public_id:
description: The organization public ID.
type: string
example: abc-123-def
region:
description: The region of the Datadog instance that the organization belongs to.
type: string
example: example_value
timestamp:
description: Datetime in ISO-8601 format, UTC. The hour for the usage.
format: date-time
type: string
example: '2026-04-17T12:00:00Z'
type: object
HourlyUsagePagination:
description: The metadata for the current pagination.
properties:
next_record_id:
description: The cursor to get the next results (if any). To make the next request, use the same parameters and add `next_record_id`.
nullable: true
type: string
example: abc-123-def
type: object
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