--- title: Get hourly usage by product family description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Usage Metering --- # Get hourly usage by product family{% #get-hourly-usage-by-product-family %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/usage/hourly_usage | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/usage/hourly_usage | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/usage/hourly_usage | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/usage/hourly_usage | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/usage/hourly_usage | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/usage/hourly_usage | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/usage/hourly_usage | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/usage/hourly_usage | ### Overview Get hourly usage by product family. This endpoint requires the `usage_read` permission. OAuth apps require the `usage_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#usage-metering) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | ------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | filter[timestamp][start] [*required*] | string | 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] [*required*] | string | Comma separated list of product families to retrieve. Available families are `all`, `ai`, `analyzed_logs`, `application_performance_monitoring`, `application_security`, `audit_trail`, `bits_ai`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`, `csm_container_enterprise`, `csm_host_enterprise`, `csm_host_pro`, `cspm`, `custom_events`, `cws`, `data_observability`, `dbm`, `digital_experience_management`, `error_tracking`, `fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `infrastructure_monitoring`, `ingested_spans`, `iot`, `lambda_traced_invocations`, `llm_observability`, `log_management`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`, `observability_pipelines`, `online_archive`, `platform_capabilities`, `product_analytics`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `security`, `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[include_descendants] | boolean | Include child org usage in the response. 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_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] | integer | 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. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Hourly usage response. | Parent field | Field | Type | Description | | ------------ | ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | | | data | [object] | Response containing hourly usage. | | data | attributes | object | Attributes of hourly usage for a product family for an org for a time period. | | attributes | account_name | string | The account name. | | attributes | account_public_id | string | The account public ID. | | attributes | measurements | [object] | List of the measured usage values for the product family for the org for the time period. | | measurements | usage_type | string | Type of usage. | | measurements | value | int64 | Contains the number measured for the given usage_type during the hour. | | attributes | org_name | string | The organization name. | | attributes | product_family | string | The product for which usage is being reported. | | attributes | public_id | string | The organization public ID. | | attributes | region | string | The region of the Datadog instance that the organization belongs to. | | attributes | timestamp | date-time | Datetime in ISO-8601 format, UTC. The hour for the usage. | | data | id | string | Unique ID of the response. | | data | type | enum | Type of usage data. Allowed enum values: `usage_timeseries` | | | meta | object | The object containing document metadata. | | meta | pagination | object | The metadata for the current pagination. | | pagination | next_record_id | string | The cursor to get the next results (if any). To make the next request, use the same parameters and add `next_record_id`. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "account_name": "string", "account_public_id": "string", "measurements": [ { "usage_type": "string", "value": "integer" } ], "org_name": "string", "product_family": "string", "public_id": "string", "region": "string", "timestamp": "2019-09-19T10:00:00.000Z" }, "id": "string", "type": "usage_timeseries" } ], "meta": { "pagination": { "next_record_id": "string" } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden - User is not authorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Required query arguments export filter[timestamp][start]="CHANGE_ME" export filter[product_families]="CHANGE_ME" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/usage/hourly_usage?filter[timestamp][start]=${filter[timestamp][start]}&filter[product_families]=${filter[product_families]}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get hourly usage by product family returns "OK" response """ from datetime import datetime from dateutil.relativedelta import relativedelta from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = UsageMeteringApi(api_client) response = api_instance.get_hourly_usage( filter_timestamp_start=(datetime.now() + relativedelta(days=-3)), filter_product_families="infra_hosts", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get hourly usage by product family returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new p api_instance.get_hourly_usage((Time.now + -3 * 86400), "infra_hosts") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get hourly usage by product family returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "time" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewUsageMeteringApi(apiClient) resp, r, err := api.GetHourlyUsage(ctx, time.Now().AddDate(0, 0, -3), "infra_hosts", *datadogV2.NewGetHourlyUsageOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsageMeteringApi.GetHourlyUsage`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `UsageMeteringApi.GetHourlyUsage`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get hourly usage by product family returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.UsageMeteringApi; import com.datadog.api.client.v2.model.HourlyUsageResponse; import java.time.OffsetDateTime; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); UsageMeteringApi apiInstance = new UsageMeteringApi(defaultClient); try { HourlyUsageResponse result = apiInstance.getHourlyUsage(OffsetDateTime.now().plusDays(-3), "infra_hosts"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling UsageMeteringApi#getHourlyUsage"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get hourly usage by product family returns "OK" response use chrono::{DateTime, Utc}; use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_usage_metering::GetHourlyUsageOptionalParams; use datadog_api_client::datadogV2::api_usage_metering::UsageMeteringAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = UsageMeteringAPI::with_config(configuration); let resp = api .get_hourly_usage( DateTime::parse_from_rfc3339("2021-11-08T11:11:11+00:00") .expect("Failed to parse datetime") .with_timezone(&Utc), "infra_hosts".to_string(), GetHourlyUsageOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get hourly usage by product family returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.UsageMeteringApi(configuration); const params: v2.UsageMeteringApiGetHourlyUsageRequest = { filterTimestampStart: new Date(new Date().getTime() + -3 * 86400 * 1000), filterProductFamilies: "infra_hosts", }; apiInstance .getHourlyUsage(params) .then((data: v2.HourlyUsageResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}