Get hourly usage by product family
GET {{baseUrl}}/api/v2/usage/hourly_usage?filter[timestamp][start]=<dateTime>&filter[timestamp][end]=<dateTime>&filter[product_families]=<string>&filter[include_descendants]=false&filter[include_breakdown]=false&filter[versions]=<string>&page[limit]=500&page[next_record_id]=<string>
Get hourly usage by product family.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter[timestamp][start] | string | (Required) Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | |
filter[timestamp][end] | string | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. | |
filter[product_families] | string | (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, | |||
csm_container_enterprise, csm_host_enterprise, cspm, custom_events, cws, dbm, fargate, | |||
infra_hosts, incident_management, indexed_logs, indexed_spans, ingested_spans, iot, | |||
lambda_traced_invocations, logs, network_flows, network_hosts, netflow_monitoring, observability_pipelines, | |||
online_archive, profiling, rum, rum_browser_sessions, rum_mobile_sessions, sds, snmp, | |||
synthetics_api, synthetics_browser, synthetics_mobile, synthetics_parallel_testing, and timeseries. | |||
The following product family has been deprecated: audit_logs. | |||
filter[include_descendants] | boolean | Include child org usage in the response. Defaults to false. | |
filter[include_breakdown] | boolean | Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false. | |
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] | number | 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"measurements":[{"usage_type":"\u003cstring\u003e","value":"\u003clong\u003e"},{"usage_type":"\u003cstring\u003e","value":"\u003clong\u003e"}],"org_name":"\u003cstring\u003e","product_family":"\u003cstring\u003e","public_id":"\u003cstring\u003e","region":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},"id":"\u003cstring\u003e","type":"usage_timeseries"},{"attributes":{"measurements":[{"usage_type":"\u003cstring\u003e","value":"\u003clong\u003e"},{"usage_type":"\u003cstring\u003e","value":"\u003clong\u003e"}],"org_name":"\u003cstring\u003e","product_family":"\u003cstring\u003e","public_id":"\u003cstring\u003e","region":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e"},"id":"\u003cstring\u003e","type":"usage_timeseries"}],"meta":{"pagination":{"next_record_id":"\u003cstring\u003e"}}}