hourly_usage
Creates, updates, deletes, gets or lists an hourly_usage resource.
Overview
| Name | hourly_usage |
| Type | Resource |
| Id | datadog.organization.hourly_usage |
Fields
The following fields are returned by SELECT queries:
- get_hourly_usage
| Name | Datatype | Description |
|---|---|---|
id | string | Unique ID of the response. |
attributes | object | Attributes of hourly usage for a product family for an org for a time period. |
type | string | Type of usage data. (default: usage_timeseries, example: usage_timeseries) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_hourly_usage | select | filter[timestamp][start], filter[product_families], region | filter[timestamp][end], filter[include_descendants], filter[include_connected_accounts], filter[include_breakdown], filter[versions], page[limit], page[next_record_id] | Get hourly usage by product family. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
filter[product_families] | string | 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, llm_observability, logs, network_flows, network_hosts, network_monitoring, observability_pipelines, online_archive, profiling, product_analytics, 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][start] | string (date-time) | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. |
region | string | (default: datadoghq.com) |
filter[include_breakdown] | boolean | Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false. |
filter[include_connected_accounts] | boolean | 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] | boolean | Include child org usage in the response. Defaults to false. |
filter[timestamp][end] | string (date-time) | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. |
filter[versions] | string | 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] | integer (int32) | Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified. |
page[next_record_id] | string | List following results with a next_record_id provided in the previous query. |
SELECT examples
- get_hourly_usage
Get hourly usage by product family.
SELECT
id,
attributes,
type
FROM datadog.organization.hourly_usage
WHERE filter[timestamp][start] = '{{ filter[timestamp][start] }}' -- required
AND filter[product_families] = '{{ filter[product_families] }}' -- required
AND region = '{{ region }}' -- required
AND filter[timestamp][end] = '{{ filter[timestamp][end] }}'
AND filter[include_descendants] = '{{ filter[include_descendants] }}'
AND filter[include_connected_accounts] = '{{ filter[include_connected_accounts] }}'
AND filter[include_breakdown] = '{{ filter[include_breakdown] }}'
AND filter[versions] = '{{ filter[versions] }}'
AND page[limit] = '{{ page[limit] }}'
AND page[next_record_id] = '{{ page[next_record_id] }}'
;