GetHourlyUsage
Retrieve hourly usage data for specific Datadog product families by specifying start and end timestamps, product families, and optional breakdowns to monitor and analyze usage trends effectively.
Instructions
Get hourly usage by product family.
Query Parameters:
filter[timestamp][start] (Required): Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.
filter[timestamp][end]: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.
filter[product_families] (Required): 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, andworkflow_executions. The following product family has been deprecated:audit_logs.filter[include_descendants]: Include child org usage in the response. Defaults to false.
filter[include_connected_accounts]: Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false.
filter[include_breakdown]: Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false.
filter[versions]: 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 version1.0.0.page[limit]: Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified.
page[next_record_id]: List following results with a next_record_id provided in the previous query.
Responses:
200 (Success): OK
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
data: Response containing hourly usage.
Example:
{
"data": [
"unknown_type"
],
"meta": "unknown_type"
}400: Bad Request
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}403: Forbidden - User is not authorized
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}429: Too many requests
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter[include_breakdown] | No | Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false. | |
| filter[include_connected_accounts] | No | Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to false. | |
| filter[include_descendants] | No | Include child org usage in the response. Defaults to false. | |
| filter[product_families] | Yes | 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`. | |
| filter[timestamp][end] | No | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | |
| filter[timestamp][start] | Yes | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | |
| filter[versions] | No | 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`. | |
| page[limit] | No | Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified. | |
| page[next_record_id] | No | List following results with a next_record_id provided in the previous query. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Response containing hourly usage. | |
| meta | No |