components: callbacks: {} examples: {} headers: {} links: {} parameters: SignalID: description: The ID of the signal. in: path name: signal_id required: true schema: type: string SlackAccountNamePathParameter: description: Your Slack account name. in: path name: account_name required: true schema: type: string SlackChannelNamePathParameter: description: The name of the Slack channel being operated on. in: path name: channel_name required: true schema: type: string requestBodies: {} responses: TooManyRequestsResponse: content: "application/json": schema: $ref: "#/components/schemas/APIErrorResponse" description: Too many requests schemas: APIErrorResponse: description: Error response object. properties: errors: description: Array of errors returned by the API. example: - "Bad Request" items: description: Error description. example: "Bad Request" type: string type: array required: - errors type: object AWSAccount: description: Returns the AWS account associated with this integration. properties: access_key_id: description: Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. type: string account_id: description: Your AWS Account ID without dashes. example: "123456789012" type: string account_specific_namespace_rules: additionalProperties: description: A list of additional properties. type: boolean description: |- An object (in the form `{"namespace1":true/false, "namespace2":true/false}`) containing user-supplied overrides for AWS namespace metric collection. **Important**: This field only contains namespaces explicitly configured through API calls, not the comprehensive enabled or disabled status of all namespaces. If a namespace is absent from this field, it uses Datadog's internal defaults (all namespaces enabled by default, except `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage`). For a complete view of all namespace statuses, use the V2 AWS Integration API instead. example: {"auto_scaling": false, "opswork": false} type: object cspm_resource_collection_enabled: default: false description: Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`. example: true type: boolean excluded_regions: description: |- An array of [AWS regions](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) to exclude from metrics collection. example: ["us-east-1", "us-west-2"] items: description: Regions to exclude. type: string type: array extended_resource_collection_enabled: default: false description: Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`. example: true type: boolean filter_tags: description: |- The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `*` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1.*,!region:us-east-1` example: ["$KEY:$VALUE"] items: description: The list of the filter_tags. type: string type: array host_tags: description: |- Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. example: ["$KEY:$VALUE"] items: description: The list of the host_tags. type: string type: array metrics_collection_enabled: default: true description: Whether Datadog collects metrics for this AWS account. example: false type: boolean resource_collection_enabled: default: false deprecated: true description: Deprecated in favor of 'extended_resource_collection_enabled'. Whether Datadog collects a standard set of resources from your AWS account. example: true type: boolean role_name: description: Your Datadog role delegation name. example: "DatadogAWSIntegrationRole" type: string secret_access_key: description: Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. type: string type: object AWSAccountAndLambdaRequest: description: AWS account ID and Lambda ARN. properties: account_id: description: >- Your AWS Account ID without dashes. example: "1234567" type: string lambda_arn: description: >- ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. example: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" type: string required: - account_id - lambda_arn type: object AWSAccountCreateResponse: description: The Response returned by the AWS Create Account call. properties: external_id: description: AWS external_id. type: string type: object AWSAccountDeleteRequest: description: List of AWS accounts to delete. properties: access_key_id: description: Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. type: string account_id: description: Your AWS Account ID without dashes. example: "123456789012" type: string role_name: description: Your Datadog role delegation name. example: "DatadogAWSIntegrationRole" type: string type: object AWSAccountListResponse: description: List of enabled AWS accounts. properties: accounts: description: List of enabled AWS accounts. items: $ref: "#/components/schemas/AWSAccount" type: array type: object AWSEventBridgeAccountConfiguration: description: The EventBridge configuration for one AWS account. properties: accountId: description: Your AWS Account ID without dashes. example: "123456789012" type: string eventHubs: description: Array of AWS event sources associated with this account. items: $ref: "#/components/schemas/AWSEventBridgeSource" type: array tags: description: |- Array of tags (in the form `key:value`) which are added to all hosts and metrics reporting through the main AWS integration. example: ["$KEY:$VALUE"] items: description: The list of the host_tags. type: string type: array type: object AWSEventBridgeCreateRequest: description: An object used to create an EventBridge source. properties: account_id: description: Your AWS Account ID without dashes. example: "123456789012" type: string create_event_bus: description: |- True if Datadog should create the event bus in addition to the event source. Requires the `events:CreateEventBus` permission. example: true type: boolean event_generator_name: description: |- The given part of the event source name, which is then combined with an assigned suffix to form the full name. example: app-alerts type: string region: description: The event source's [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). example: us-east-1 type: string type: object AWSEventBridgeCreateResponse: description: A created EventBridge source. properties: event_source_name: description: The event source name. example: app-alerts-zyxw3210 type: string has_bus: description: True if the event bus was created in addition to the source. example: true type: boolean region: description: The event source's [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). example: us-east-1 type: string status: $ref: "#/components/schemas/AWSEventBridgeCreateStatus" type: object AWSEventBridgeCreateStatus: description: The event source status "created". enum: ["created"] example: created type: string x-enum-varnames: ["CREATED"] AWSEventBridgeDeleteRequest: description: An object used to delete an EventBridge source. properties: account_id: description: Your AWS Account ID without dashes. example: "123456789012" type: string event_generator_name: description: The event source name. example: app-alerts-zyxw3210 type: string region: description: The event source's [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). example: us-east-1 type: string type: object AWSEventBridgeDeleteResponse: description: An indicator of the successful deletion of an EventBridge source. properties: status: $ref: "#/components/schemas/AWSEventBridgeDeleteStatus" type: object AWSEventBridgeDeleteStatus: description: The event source status "empty". enum: ["empty"] example: empty type: string x-enum-varnames: ["EMPTY"] AWSEventBridgeListResponse: description: An object describing the EventBridge configuration for multiple accounts. properties: accounts: description: List of accounts with their event sources. items: $ref: "#/components/schemas/AWSEventBridgeAccountConfiguration" type: array isInstalled: description: True if the EventBridge sub-integration is enabled for your organization. type: boolean type: object AWSEventBridgeSource: description: An EventBridge source. properties: name: description: The event source name. type: string region: description: The event source's [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). type: string type: object AWSLogsAsyncError: description: Description of errors. properties: code: description: Code properties example: "no_such_config" type: string message: description: Message content. example: "AWS account 12345 has no Lambda config to update" type: string type: object AWSLogsAsyncResponse: description: A list of all Datadog-AWS logs integrations available in your Datadog organization. properties: errors: description: List of errors. items: $ref: "#/components/schemas/AWSLogsAsyncError" type: array status: description: Status of the properties. example: "created" type: string type: object AWSLogsLambda: description: Description of the Lambdas. properties: arn: description: Available ARN IDs. type: string type: object AWSLogsListResponse: description: A list of all Datadog-AWS logs integrations available in your Datadog organization. properties: account_id: description: >- Your AWS Account ID without dashes. example: "1234567" type: string lambdas: description: >- List of ARNs configured in your Datadog account. example: ["arn": "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest"] items: $ref: "#/components/schemas/AWSLogsLambda" type: array services: description: >- Array of services IDs. example: ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"] items: description: Description of the services. type: string type: array type: object AWSLogsListServicesResponse: description: The list of current AWS services for which Datadog offers automatic log collection. properties: id: description: >- Key value in returned object. example: "s3" type: string label: description: >- Name of service available for configuration with Datadog logs. example: "S3 Access Logs" type: string type: object AWSLogsServicesRequest: description: A list of current AWS services for which Datadog offers automatic log collection. properties: account_id: description: >- Your AWS Account ID without dashes. example: "1234567" type: string services: description: >- Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint. example: ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"] items: description: Description of services. type: string type: array required: - account_id - services type: object AWSNamespace: description: The namespace associated with the tag filter entry. enum: [elb, application_elb, sqs, rds, custom, network_elb, lambda, step_functions] type: string x-enum-varnames: ["ELB", "APPLICATION_ELB", "SQS", "RDS", "CUSTOM", "NETWORK_ELB", "LAMBDA", "STEP_FUNCTIONS"] AWSTagFilter: description: A tag filter. properties: namespace: $ref: "#/components/schemas/AWSNamespace" tag_filter_str: description: The tag filter string. example: "prod*" type: string type: object AWSTagFilterCreateRequest: description: The objects used to set an AWS tag filter. properties: account_id: description: Your AWS Account ID without dashes. example: "123456789012" type: string namespace: $ref: "#/components/schemas/AWSNamespace" tag_filter_str: description: The tag filter string. example: "prod*" type: string type: object AWSTagFilterDeleteRequest: description: The objects used to delete an AWS tag filter entry. properties: account_id: description: The unique identifier of your AWS account. example: "FAKEAC0FAKEAC2FAKEAC" type: string namespace: $ref: "#/components/schemas/AWSNamespace" type: object AWSTagFilterListResponse: description: An array of tag filter rules by `namespace` and tag filter string. properties: filters: description: An array of tag filters. items: $ref: "#/components/schemas/AWSTagFilter" type: array type: object AccessRole: description: The access role of the user. Options are **st** (standard user), **adm** (admin user), or **ro** (read-only user). enum: - st - adm - ro - ERROR example: "ro" nullable: true type: string x-enum-varnames: - STANDARD - ADMIN - READ_ONLY - ERROR AddSignalToIncidentRequest: description: Attributes describing which incident to add the signal to. properties: add_to_signal_timeline: description: Whether to post the signal on the incident timeline. type: boolean incident_id: description: Public ID attribute of the incident to which the signal will be added. example: 2066 format: int64 type: integer version: $ref: "#/components/schemas/Version" required: - incident_id type: object AgentCheck: description: Array of strings. example: ["ntp", "ntp", "ntp:d884b5186b651429", "OK", "", ""] items: description: Agent check running on the host. type: array AlertGraphWidgetDefinition: description: Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. properties: alert_id: description: ID of the alert to use in the widget. example: "" type: string description: description: The description of the widget. type: string time: $ref: "#/components/schemas/WidgetTime" title: description: The title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/AlertGraphWidgetDefinitionType" viz_type: $ref: "#/components/schemas/WidgetVizType" required: - type - alert_id - viz_type type: object AlertGraphWidgetDefinitionType: default: alert_graph description: Type of the alert graph widget. enum: - alert_graph example: alert_graph type: string x-enum-varnames: - ALERT_GRAPH AlertValueWidgetDefinition: description: Alert values are query values showing the current value of the metric in any monitor defined on your system. properties: alert_id: description: ID of the alert to use in the widget. example: "" type: string description: description: The description of the widget. type: string precision: description: Number of decimal to show. If not defined, will use the raw value. format: int64 type: integer text_align: $ref: "#/components/schemas/WidgetTextAlign" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of value in the widget. type: string type: $ref: "#/components/schemas/AlertValueWidgetDefinitionType" unit: description: Unit to display with the value. type: string required: - type - alert_id type: object AlertValueWidgetDefinitionType: default: alert_value description: Type of the alert value widget. enum: - alert_value example: alert_value type: string x-enum-varnames: - ALERT_VALUE ApiKey: description: |- Datadog API key. properties: created: description: Date of creation of the API key. example: "2019-08-02 15:31:07" readOnly: true type: string created_by: description: Datadog user handle that created the API key. example: "john@example.com" readOnly: true type: string key: description: API key. example: "1234512345123456abcabc912349abcd" maxLength: 32 minLength: 32 readOnly: true type: string name: description: Name of your API key. example: "example user" type: string type: object ApiKeyListResponse: description: List of API and application keys available for a given organization. example: {"api_keys": [{"created_by": "test_user", "key": "1234512345123456abcabc912349abcd", "name": "app_key"}]} properties: api_keys: description: Array of API keys. items: $ref: "#/components/schemas/ApiKey" type: array type: object ApiKeyResponse: description: An API key with its associated metadata. example: {"api_key": {"created_by": "test_user", "key": "1234512345123456abcabc912349abcd", "name": "app_key"}} properties: api_key: $ref: "#/components/schemas/ApiKey" type: object ApmStatsQueryColumnType: description: Column properties. properties: alias: description: A user-assigned alias for the column. example: Requests type: string cell_display_mode: $ref: "#/components/schemas/TableWidgetCellDisplayMode" name: description: Column name. example: Reqs type: string order: $ref: "#/components/schemas/WidgetSort" required: - name type: object ApmStatsQueryDefinition: description: The APM stats query for table and distributions widgets. properties: columns: description: Column properties used by the front end for display. items: $ref: "#/components/schemas/ApmStatsQueryColumnType" type: array env: description: Environment name. example: prod type: string name: description: Operation name associated with service. example: "rack.request" type: string primary_tag: description: The organization's host group name and value. example: "datacenter:*" type: string resource: description: Resource name. example: CartsController type: string row_type: $ref: "#/components/schemas/ApmStatsQueryRowType" service: description: Service name. example: "web-store" type: string required: - service - env - name - primary_tag - row_type type: object ApmStatsQueryRowType: description: The level of detail for the request. enum: - service - resource - span example: "service" type: string x-enum-varnames: - SERVICE - RESOURCE - SPAN ApplicationKey: description: An application key with its associated metadata. properties: hash: description: Hash of an application key. example: "1234512345123459cda4eb9ced49a3d84fd0138c" maxLength: 40 minLength: 40 readOnly: true type: string name: description: Name of an application key. example: "example user" type: string owner: description: Owner of an application key. example: "example.com" readOnly: true type: string type: object ApplicationKeyListResponse: description: An application key response. example: {"application_keys": [{"hash": "1234512345123459cda4eb9ced49a3d84fd0138c", "name": "app_key", "owner": "test_user"}]} properties: application_keys: description: Array of application keys. items: $ref: "#/components/schemas/ApplicationKey" type: array type: object ApplicationKeyResponse: description: An application key response. example: {"application_key": {"hash": "1234512345123459cda4eb9ced49a3d84fd0138c", "name": "app_key", "owner": "test_user"}} properties: application_key: $ref: "#/components/schemas/ApplicationKey" type: object AuthenticationValidationResponse: description: Represent validation endpoint responses. properties: valid: description: Return `true` if the authentication response is valid. example: true readOnly: true type: boolean type: object AzureAccount: description: Datadog-Azure integrations configured for your organization. properties: app_service_plan_filters: description: |- Limit the Azure app service plans that are pulled into Datadog using tags. Only app service plans that match one of the defined tags are imported into Datadog. example: "key:value,filter:example" type: string automute: description: |- Silence monitors for expected Azure VM shutdowns. example: true type: boolean client_id: description: Your Azure web application ID. example: "testc7f6-1234-5678-9101-3fcbf464test" type: string client_secret: description: Your Azure web application secret key. example: "TestingRh2nx664kUy5dIApvM54T4AtO" type: string container_app_filters: description: |- Limit the Azure container apps that are pulled into Datadog using tags. Only container apps that match one of the defined tags are imported into Datadog. example: "key:value,filter:example" type: string cspm_enabled: description: |- When enabled, Datadog’s Cloud Security Management product scans resource configurations monitored by this app registration. Note: This requires resource_collection_enabled to be set to true. example: true type: boolean custom_metrics_enabled: description: |- Enable custom metrics for your organization. example: true type: boolean errors: description: Errors in your configuration. example: ["*"] items: description: List of errors. readOnly: true type: string type: array host_filters: description: |- Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. example: "key:value,filter:example" type: string metrics_enabled: description: |- Enable Azure metrics for your organization. example: true type: boolean metrics_enabled_default: description: |- Enable Azure metrics for your organization for resource providers where no resource provider config is specified. example: true type: boolean new_client_id: description: Your New Azure web application ID. example: "new1c7f6-1234-5678-9101-3fcbf464test" type: string new_tenant_name: description: Your New Azure Active Directory ID. example: "new1c44-1234-5678-9101-cc00736ftest" type: string resource_collection_enabled: description: |- When enabled, Datadog collects metadata and configuration info from cloud resources (compute instances, databases, load balancers, etc.) monitored by this app registration. example: true type: boolean resource_provider_configs: description: Configuration settings applied to resources from the specified Azure resource providers. items: $ref: "#/components/schemas/ResourceProviderConfig" type: array secretless_auth_enabled: description: |- (Preview) When enabled, Datadog authenticates with this app registration using federated workload identity credentials instead of a client secret. example: true type: boolean tenant_name: description: Your Azure Active Directory ID. example: "testc44-1234-5678-9101-cc00736ftest" type: string usage_metrics_enabled: description: |- Enable azure.usage metrics for your organization. example: true type: boolean type: object AzureAccountListResponse: description: Accounts configured for your organization. items: $ref: "#/components/schemas/AzureAccount" type: array BarChartWidgetDefinition: description: The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string requests: description: List of bar chart widget requests. example: ["q": "system.load.1"] items: $ref: "#/components/schemas/BarChartWidgetRequest" maxItems: 1 minItems: 1 type: array style: $ref: "#/components/schemas/BarChartWidgetStyle" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/BarChartWidgetDefinitionType" required: - type - requests type: object BarChartWidgetDefinitionType: default: bar_chart description: Type of the bar chart widget. enum: - bar_chart example: bar_chart type: string x-enum-varnames: - BAR_CHART BarChartWidgetDisplay: description: Bar chart widget display options. oneOf: - $ref: "#/components/schemas/BarChartWidgetStacked" - $ref: "#/components/schemas/BarChartWidgetFlat" BarChartWidgetFlat: description: Bar chart widget flat display. properties: type: $ref: "#/components/schemas/BarChartWidgetFlatType" required: - type type: object BarChartWidgetFlatType: default: flat description: Bar chart widget flat display type. enum: - flat example: flat type: string x-enum-varnames: - FLAT BarChartWidgetLegend: description: Bar chart widget stacked legend behavior. enum: - automatic - inline - none example: automatic type: string x-enum-varnames: - AUTOMATIC - INLINE - NONE BarChartWidgetRequest: description: Updated bar chart widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. conditional_formats: description: List of conditional formats. example: [{"comparator": ">=", "palette": "blue", "value": 1.0}] items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: $ref: "#/components/schemas/WidgetSortBy" style: $ref: "#/components/schemas/WidgetRequestStyle" type: object BarChartWidgetScaling: description: Bar chart widget scaling definition. enum: - absolute - relative type: string x-enum-varnames: - ABSOLUTE - RELATIVE BarChartWidgetStacked: description: Bar chart widget stacked display options. properties: legend: $ref: "#/components/schemas/BarChartWidgetLegend" type: $ref: "#/components/schemas/BarChartWidgetStackedType" required: - type type: object BarChartWidgetStackedType: default: stacked description: Bar chart widget stacked display type. enum: - stacked example: stacked type: string x-enum-varnames: - STACKED BarChartWidgetStyle: description: Style customization for a bar chart widget. properties: display: $ref: "#/components/schemas/BarChartWidgetDisplay" palette: description: Color palette to apply to the widget. type: string scaling: $ref: "#/components/schemas/BarChartWidgetScaling" type: object CalendarInterval: additionalProperties: false description: Calendar interval definition. properties: alignment: description: Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). example: "monday" type: string quantity: description: Quantity of the interval. example: 1 format: int64 type: integer timezone: description: Timezone for the interval. example: "UTC" type: string type: $ref: "#/components/schemas/CalendarIntervalType" required: - type type: object CalendarIntervalType: description: Type of calendar interval. enum: - day - week - month - year - quarter - minute - hour example: week type: string x-enum-varnames: - DAY - WEEK - MONTH - YEAR - QUARTER - MINUTE - HOUR CancelDowntimesByScopeRequest: description: Cancel downtimes according to scope. properties: scope: description: |- The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). example: "host:myserver" type: string required: - scope type: object CanceledDowntimesIds: description: Object containing array of IDs of canceled downtimes. properties: cancelled_ids: description: ID of downtimes that were canceled. example: [123456789, 123456790] items: description: Integer representation of one downtime ID. format: int64 type: integer type: array type: object ChangeWidgetDefinition: description: The Change graph shows you the change in a value over the time period chosen. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string requests: description: |- Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. example: ["q": "{}"] items: $ref: "#/components/schemas/ChangeWidgetRequest" maxItems: 1 minItems: 1 type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/ChangeWidgetDefinitionType" required: - type - requests type: object ChangeWidgetDefinitionType: default: change description: Type of the change widget. enum: - change example: change type: string x-enum-varnames: - CHANGE ChangeWidgetRequest: description: Updated change widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. change_type: $ref: "#/components/schemas/WidgetChangeType" compare_to: $ref: "#/components/schemas/WidgetCompareTo" event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array increase_good: description: Whether to show increase as good. type: boolean log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. order_by: $ref: "#/components/schemas/WidgetOrderBy" order_dir: $ref: "#/components/schemas/WidgetSort" process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Query definition. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. show_present: description: Whether to show the present value. type: boolean type: object CheckCanDeleteMonitorResponse: description: Response of monitor IDs that can or can't be safely deleted. properties: data: $ref: "#/components/schemas/CheckCanDeleteMonitorResponseData" errors: additionalProperties: description: Strings denoting where a monitor is used. items: description: Asset where a monitor is used. type: string type: array description: A mapping of Monitor ID to strings denoting where it's used. nullable: true type: object required: - data type: object CheckCanDeleteMonitorResponseData: description: Wrapper object with the list of monitor IDs. example: {} properties: ok: description: An array of Monitor IDs that can be safely deleted. items: description: ID of a monitor that can be safely deleted. format: int64 type: integer type: array type: object CheckCanDeleteSLOResponse: description: A service level objective response containing the requested object. properties: data: $ref: "#/components/schemas/CheckCanDeleteSLOResponseData" errors: additionalProperties: description: Description of the service level objective reference. type: string description: A mapping of SLO id to it's current usages. type: object type: object CheckCanDeleteSLOResponseData: description: An array of service level objective objects. properties: ok: description: An array of SLO IDs that can be safely deleted. items: description: An SLO ID. type: string type: array type: object CheckStatusWidgetDefinition: description: Check status shows the current status or number of results for any check performed. properties: check: description: Name of the check to use in the widget. example: "" type: string description: description: The description of the widget. type: string group: description: Group reporting a single check. type: string group_by: description: List of tag prefixes to group by in the case of a cluster check. items: description: Tag prefix. type: string type: array grouping: $ref: "#/components/schemas/WidgetGrouping" tags: description: List of tags used to filter the groups reporting a cluster check. items: description: Tag name. type: string type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/CheckStatusWidgetDefinitionType" required: - type - check - grouping type: object CheckStatusWidgetDefinitionType: default: check_status description: Type of the check status widget. enum: - check_status example: check_status type: string x-enum-varnames: - CHECK_STATUS CohortWidgetDefinition: additionalProperties: false description: The cohort widget visualizes user retention over time. properties: description: description: The description of the widget. type: string requests: description: List of Cohort widget requests. example: - query: compute: aggregation: count metric: __dd.retention_rate data_source: product_analytics_retention search: cohort_criteria: base_query: data_source: product_analytics search: query: "@type:view @view.name:/home" time_interval: type: calendar value: type: week retention_entity: "@usr.id" return_condition: conversion_on_or_after return_criteria: base_query: data_source: product_analytics search: query: "@type:view @view.name:/checkout" request_type: retention_grid items: $ref: "#/components/schemas/RetentionGridRequest" description: A cohort widget request. minItems: 1 type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/CohortWidgetDefinitionType" required: - type - requests type: object CohortWidgetDefinitionType: default: cohort description: Type of the Cohort widget. enum: - cohort example: cohort type: string x-enum-varnames: - COHORT ComparisonCustomTimeframe: description: Fixed time range for a `custom_timeframe` comparison. properties: from: description: Start time in milliseconds since epoch. example: 1779290190000 format: int64 type: integer to: description: End time in milliseconds since epoch. example: 1779894990000 format: int64 type: integer required: - from - to type: object ComparisonDuration: description: The comparison period. Use a preset `type` value or set `type` to `custom_timeframe` and provide `custom_timeframe` with explicit millisecond epoch bounds. properties: custom_timeframe: $ref: "#/components/schemas/ComparisonCustomTimeframe" description: Required when `type` is `custom_timeframe`. Fixed time range to compare against. type: $ref: "#/components/schemas/ComparisonDurationType" required: - type type: object ComparisonDurationType: description: "The comparison window type." enum: - previous_timeframe - custom_timeframe - previous_day - previous_week - previous_month example: previous_timeframe type: string x-enum-varnames: - PREVIOUS_TIMEFRAME - CUSTOM_TIMEFRAME - PREVIOUS_DAY - PREVIOUS_WEEK - PREVIOUS_MONTH ContentEncoding: description: HTTP header used to compress the media-type. enum: - gzip - deflate type: string x-enum-varnames: - GZIP - DEFLATE Creator: description: Object describing the creator of the shared element. properties: email: description: Email of the creator. type: string handle: description: Handle of the creator. type: string name: description: Name of the creator. nullable: true type: string readOnly: true type: object CrossOrgUuids: description: The source organization UUID for cross organization queries. Feature in Private Beta. example: ["6434abde-xxxx-yyyy-zzzz-da7ad0900001"] items: description: The source organization UUID. example: 6434abde-xxxx-yyyy-zzzz-da7ad0900001 type: string maxItems: 1 type: array Dashboard: description: |- A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure. properties: author_handle: description: Identifier of the dashboard author. example: test@datadoghq.com readOnly: true type: string author_name: description: Name of the dashboard author. example: John Doe nullable: true readOnly: true type: string created_at: description: Creation date of the dashboard. format: date-time readOnly: true type: string description: description: Description of the dashboard. nullable: true type: string id: description: ID of the dashboard. example: "123-abc-456" readOnly: true type: string is_read_only: deprecated: true description: |- Whether this dashboard is read-only. If True, only the author and admins can make changes to it. This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards. example: false type: boolean layout_type: $ref: "#/components/schemas/DashboardLayoutType" modified_at: description: Modification date of the dashboard. format: date-time readOnly: true type: string notify_list: description: List of handles of users to notify when changes are made to this dashboard. items: description: User handles. type: string nullable: true type: array reflow_type: $ref: "#/components/schemas/DashboardReflowType" restricted_roles: description: |- A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. items: description: A role UUID. type: string type: array tabs: description: List of tabs for organizing dashboard widgets into groups. items: $ref: "#/components/schemas/DashboardTab" maxItems: 100 nullable: true type: array tags: description: List of team names representing ownership of a dashboard. items: description: The name of a Datadog team of the form `team:` type: string maxItems: 5 nullable: true type: array template_variable_presets: description: Array of template variables saved views. items: $ref: "#/components/schemas/DashboardTemplateVariablePreset" nullable: true type: array template_variables: description: List of template variables for this dashboard. items: $ref: "#/components/schemas/DashboardTemplateVariable" nullable: true type: array title: description: Title of the dashboard. example: "" type: string url: description: The URL of the dashboard. example: /dashboard/123-abc-456/example-dashboard-title readOnly: true type: string widgets: description: List of widgets to display on the dashboard. example: ["definition": {"requests": {"fill": {"q": "avg:system.cpu.user{*}"}}, "type": "hostmap"}] items: $ref: "#/components/schemas/Widget" type: array required: - title - layout_type - widgets type: object DashboardBulkActionData: description: Dashboard bulk action request data. example: {"id": "123-abc-456", "type": "dashboard"} properties: id: $ref: "#/components/schemas/DashboardID" type: $ref: "#/components/schemas/DashboardResourceType" required: - type - id type: object DashboardBulkActionDataList: description: List of dashboard bulk action request data objects. example: [{"id": "123-abc-456", "type": "dashboard"}] items: $ref: "#/components/schemas/DashboardBulkActionData" type: array DashboardBulkDeleteRequest: description: Dashboard bulk delete request body. example: {"data": [{"id": "123-abc-456", "type": "dashboard"}]} properties: data: $ref: "#/components/schemas/DashboardBulkActionDataList" required: - data type: object DashboardDeleteResponse: description: Response from the delete dashboard call. properties: deleted_dashboard_id: description: ID of the deleted dashboard. type: string type: object DashboardGlobalTime: description: Object containing the live span selection for the dashboard. properties: live_span: $ref: "#/components/schemas/DashboardGlobalTimeLiveSpan" type: object DashboardGlobalTimeLiveSpan: description: Dashboard global time live_span selection enum: - 15m - 1h - 4h - 1d - 2d - 1w - 1mo - 3mo example: "1h" type: string x-enum-varnames: - PAST_FIFTEEN_MINUTES - PAST_ONE_HOUR - PAST_FOUR_HOURS - PAST_ONE_DAY - PAST_TWO_DAYS - PAST_ONE_WEEK - PAST_ONE_MONTH - PAST_THREE_MONTHS DashboardID: description: Dashboard resource ID. example: "123-abc-456" type: string DashboardInviteType: description: Type for shared dashboard invitation request body. enum: - public_dashboard_invitation example: public_dashboard_invitation type: string x-enum-varnames: - PUBLIC_DASHBOARD_INVITATION DashboardLayoutType: description: Layout type of the dashboard. enum: - ordered - free example: ordered type: string x-enum-varnames: - ORDERED - FREE DashboardList: description: Your Datadog Dashboards. properties: author: $ref: "#/components/schemas/Creator" created: description: Date of creation of the dashboard list. format: date-time readOnly: true type: string dashboard_count: description: The number of dashboards in the list. format: int64 readOnly: true type: integer id: description: The ID of the dashboard list. format: int64 readOnly: true type: integer is_favorite: description: Whether or not the list is in the favorites. readOnly: true type: boolean modified: description: Date of last edition of the dashboard list. format: date-time readOnly: true type: string name: description: The name of the dashboard list. example: My Dashboard type: string type: description: The type of dashboard list. example: "manual_dashboard_list" readOnly: true type: string required: - name type: object DashboardListDeleteResponse: description: Deleted dashboard details. properties: deleted_dashboard_list_id: description: ID of the deleted dashboard list. format: int64 type: integer type: object DashboardListListResponse: description: Information on your dashboard lists. properties: dashboard_lists: description: List of all your dashboard lists. items: $ref: "#/components/schemas/DashboardList" type: array type: object DashboardReflowType: description: |- Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. enum: - auto - fixed type: string x-enum-varnames: - AUTO - FIXED DashboardResourceType: default: dashboard description: Dashboard resource type. enum: - dashboard example: dashboard type: string x-enum-varnames: - DASHBOARD DashboardRestoreRequest: description: Dashboard restore request body. example: {"data": [{"id": "123-abc-456", "type": "dashboard"}]} properties: data: $ref: "#/components/schemas/DashboardBulkActionDataList" required: - data type: object DashboardShareType: description: Type of sharing access (either open to anyone who has the public URL or invite-only). enum: - open - invite - embed nullable: true type: string x-enum-varnames: - OPEN - INVITE - EMBED DashboardSummary: description: Dashboard summary response. properties: dashboards: description: List of dashboard definitions. items: $ref: "#/components/schemas/DashboardSummaryDefinition" type: array type: object DashboardSummaryDefinition: description: Dashboard definition. properties: author_handle: description: Identifier of the dashboard author. type: string created_at: description: Creation date of the dashboard. format: date-time type: string description: description: Description of the dashboard. nullable: true type: string id: description: Dashboard identifier. type: string is_read_only: deprecated: true description: |- Whether this dashboard is read-only. If True, only the author and admins can make changes to it. This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards. type: boolean layout_type: $ref: "#/components/schemas/DashboardLayoutType" modified_at: description: Modification date of the dashboard. format: date-time type: string title: description: Title of the dashboard. type: string url: description: URL of the dashboard. type: string type: object DashboardTab: description: Dashboard tab for organizing widgets. properties: id: description: UUID of the tab. example: "" format: uuid type: string name: description: Name of the tab. example: L maxLength: 100 minLength: 1 type: string widget_ids: description: >- List of widget IDs belonging to this tab. The backend also accepts positional references in @N format (1-indexed) as a convenience for Terraform and other declarative tools. example: - 0 items: description: Widget ID. format: int64 type: integer type: array required: - id - name - widget_ids type: object DashboardTemplateVariable: description: Template variable. properties: available_values: description: The list of values that the template variable drop-down is limited to. example: ["my-host", "host1", "host2"] items: description: Template variable value. type: string nullable: true type: array default: deprecated: true description: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. example: my-host nullable: true type: string defaults: description: One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`. example: ["my-host-1", "my-host-2"] items: description: One of many default values for the template variable on dashboard load. minLength: 1 type: string type: array name: description: The name of the variable. example: host1 type: string prefix: description: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. example: host nullable: true type: string type: description: The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). example: group nullable: true type: string required: - name type: object DashboardTemplateVariablePreset: description: Template variables saved views. properties: name: description: The name of the variable. type: string template_variables: description: List of variables. items: $ref: "#/components/schemas/DashboardTemplateVariablePresetValue" type: array type: object DashboardTemplateVariablePresetValue: description: Template variables saved views. properties: name: description: The name of the variable. type: string value: deprecated: true description: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. type: string values: description: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`. items: description: One or many values of the template variable within the saved view. minLength: 1 type: string minItems: 1 type: array type: object DashboardType: description: The type of the associated private dashboard. enum: - custom_timeboard - custom_screenboard example: "custom_timeboard" type: string x-enum-varnames: - CUSTOM_TIMEBOARD - CUSTOM_SCREENBOARD DataProjectionQuery: description: Query configuration for a data projection request. properties: data_source: description: Data source for the query. example: logs type: string indexes: description: List of indexes to query. items: description: Index name. type: string type: array query_string: description: The query string to filter events. example: "service:web-store" type: string storage: description: Storage location for the query. type: string required: - query_string - data_source type: object DataProjectionRequestType: description: Type of a data projection request. enum: - data_projection example: data_projection type: string x-enum-varnames: - DATA_PROJECTION DeleteSharedDashboardResponse: description: Response containing token of deleted shared dashboard. properties: deleted_public_dashboard_token: description: Token associated with the shared dashboard that was revoked. type: string type: object DeletedMonitor: description: Response from the delete monitor call. properties: deleted_monitor_id: description: ID of the deleted monitor. example: 666486743 format: int64 type: integer readOnly: true type: object DistributionPoint: description: Array of distribution points. example: [1575317847.0, [0.5, 1.0]] items: description: List of distribution point. oneOf: - $ref: "#/components/schemas/DistributionPointTimestamp" - $ref: "#/components/schemas/DistributionPointData" maxItems: 2 minItems: 2 type: array DistributionPointData: description: Distribution point data. items: description: List of distribution point data. format: double type: number type: array DistributionPointTimestamp: description: Distribution point timestamp. It should be in seconds and current. format: double type: number DistributionPointsContentEncoding: description: HTTP header used to compress the media-type. enum: - deflate type: string x-enum-varnames: - DEFLATE DistributionPointsPayload: description: The distribution points payload. properties: series: description: A list of distribution points series to submit to Datadog. example: - metric: "system.load.1" points: - [1475317847.0, [1.0, 2.0]] items: $ref: "#/components/schemas/DistributionPointsSeries" type: array required: - series type: object DistributionPointsSeries: description: A distribution points metric to submit to Datadog. properties: host: description: The name of the host that produced the distribution point metric. example: test.example.com type: string metric: description: The name of the distribution points metric. example: system.load.1 type: string points: description: Points relating to the distribution point metric. All points must be tuples with timestamp and a list of values (cannot be a string). Timestamps should be in POSIX time in seconds. example: - [1575317847.0, [0.5, 1.0]] items: $ref: "#/components/schemas/DistributionPoint" type: array tags: description: A list of tags associated with the distribution point metric. example: ["environment:test"] items: description: Individual tags. type: string type: array type: $ref: "#/components/schemas/DistributionPointsType" required: - metric - points type: object DistributionPointsType: default: distribution description: The type of the distribution point. enum: - distribution example: distribution type: string x-enum-varnames: - DISTRIBUTION DistributionWidgetDefinition: description: |- The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time. properties: custom_links: description: A list of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string legend_size: deprecated: true description: (Deprecated) The widget legend was replaced by a tooltip and sidebar. type: string markers: description: List of markers. example: [{"display_type": "percentile", "value": "90"}] items: $ref: "#/components/schemas/WidgetMarker" type: array requests: description: |- Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. items: $ref: "#/components/schemas/DistributionWidgetRequest" maxItems: 1 minItems: 1 type: array show_legend: deprecated: true description: (Deprecated) The widget legend was replaced by a tooltip and sidebar. type: boolean time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/DistributionWidgetDefinitionType" xaxis: $ref: "#/components/schemas/DistributionWidgetXAxis" yaxis: $ref: "#/components/schemas/DistributionWidgetYAxis" required: - type - requests type: object DistributionWidgetDefinitionType: default: distribution description: Type of the distribution widget. enum: - distribution example: distribution type: string x-enum-varnames: - DISTRIBUTION DistributionWidgetHistogramRequestQuery: description: Query definition for Distribution Widget Histogram Request example: {"data_source": "metrics", "name": "query1", "query": "histogram:trace.Load{*}"} oneOf: - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition" DistributionWidgetRequest: description: Updated distribution widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. apm_stats_query: $ref: "#/components/schemas/ApmStatsQueryDefinition" event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array query: $ref: "#/components/schemas/DistributionWidgetHistogramRequestQuery" request_type: $ref: "#/components/schemas/WidgetHistogramRequestType" description: Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" description: Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: $ref: "#/components/schemas/WidgetStyle" type: object DistributionWidgetXAxis: description: X Axis controls for the distribution widget. properties: include_zero: description: True includes zero. type: boolean max: default: auto description: Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. type: string min: default: auto description: Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. type: string num_buckets: description: Number of value buckets to target, also known as the resolution of the value bins. format: int64 minimum: 1 type: integer scale: default: linear description: Specifies the scale type. Possible values are `linear`. type: string type: object DistributionWidgetYAxis: description: Y Axis controls for the distribution widget. properties: include_zero: description: True includes zero. type: boolean label: description: The label of the axis to display on the graph. type: string max: default: auto description: Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. type: string min: default: auto description: Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. type: string scale: default: linear description: Specifies the scale type. Possible values are `linear` or `log`. type: string type: object Downtime: description: |- Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags. properties: active: description: If a scheduled downtime currently exists. example: true readOnly: true type: boolean active_child: $ref: "#/components/schemas/DowntimeChild" canceled: description: If a scheduled downtime is canceled. example: 1412799983 format: int64 nullable: true readOnly: true type: integer creator_id: description: User ID of the downtime creator. example: 123456 format: int32 maximum: 2147483647 readOnly: true type: integer disabled: description: If a downtime has been disabled. example: false type: boolean downtime_type: description: |- `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. example: 2 format: int32 maximum: 2147483647 readOnly: true type: integer end: description: |- POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. example: 1412793983 format: int64 nullable: true type: integer id: description: The downtime ID. example: 1625 format: int64 readOnly: true type: integer message: description: |- A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. example: "Message on the downtime" nullable: true type: string monitor_id: description: |- A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. example: 123456 format: int64 nullable: true type: integer monitor_tags: description: |- A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. example: ["*"] items: description: A monitor tag. type: string type: array mute_first_recovery_notification: description: If the first recovery notification during a downtime should be muted. example: false type: boolean notify_end_states: $ref: "#/components/schemas/NotifyEndStates" notify_end_types: $ref: "#/components/schemas/NotifyEndTypes" parent_id: description: ID of the parent Downtime. example: 123 format: int64 nullable: true type: integer recurrence: $ref: "#/components/schemas/DowntimeRecurrence" scope: description: |- The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). example: ["env:staging"] items: description: A scope. For example, `"env:staging"`. type: string type: array start: description: |- POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. example: 1412792983 format: int64 type: integer timezone: description: The timezone in which to display the downtime's start and end times in Datadog applications. example: "America/New_York" type: string updater_id: description: ID of the last user that updated the downtime. example: 123456 format: int32 maximum: 2147483647 nullable: true readOnly: true type: integer type: object DowntimeChild: description: |- The downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes. nullable: true properties: active: description: If a scheduled downtime currently exists. example: true readOnly: true type: boolean canceled: description: If a scheduled downtime is canceled. example: 1412799983 format: int64 nullable: true readOnly: true type: integer creator_id: description: User ID of the downtime creator. example: 123456 format: int32 maximum: 2147483647 readOnly: true type: integer disabled: description: If a downtime has been disabled. example: false type: boolean downtime_type: description: |- `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. example: 2 format: int32 maximum: 2147483647 readOnly: true type: integer end: description: |- POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. example: 1412793983 format: int64 nullable: true type: integer id: description: The downtime ID. example: 1626 format: int64 readOnly: true type: integer message: description: |- A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. example: "Message on the downtime" nullable: true type: string monitor_id: description: |- A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. example: 123456 format: int64 nullable: true type: integer monitor_tags: description: |- A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. example: ["*"] items: description: A monitor tag. type: string type: array mute_first_recovery_notification: description: If the first recovery notification during a downtime should be muted. example: false type: boolean notify_end_states: $ref: "#/components/schemas/NotifyEndStates" notify_end_types: $ref: "#/components/schemas/NotifyEndTypes" parent_id: description: ID of the parent Downtime. example: 123 format: int64 nullable: true type: integer recurrence: $ref: "#/components/schemas/DowntimeRecurrence" scope: description: |- The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). example: ["env:staging"] items: description: A scope. For example, `"env:staging"`. type: string type: array start: description: |- POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. example: 1412792983 format: int64 type: integer timezone: description: The timezone in which to display the downtime's start and end times in Datadog applications. example: "America/New_York" type: string updater_id: description: ID of the last user that updated the downtime. example: 123456 format: int32 maximum: 2147483647 nullable: true readOnly: true type: integer readOnly: true type: object DowntimeRecurrence: description: An object defining the recurrence of the downtime. nullable: true properties: period: description: |- How often to repeat as an integer. For example, to repeat every 3 days, select a type of `days` and a period of `3`. example: 1 format: int32 maximum: 2147483647 type: integer rrule: description: |- The `RRULE` standard for defining recurring events (**requires to set "type" to rrule**) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported. **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api) example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1 type: string type: description: The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. example: weeks type: string until_date: description: |- The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. example: 1447786293 format: int64 nullable: true type: integer until_occurrences: description: |- How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. example: 2 format: int32 maximum: 2147483647 nullable: true type: integer week_days: description: |- A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized. example: ["Mon", "Tue"] items: description: A day of the week, formatted as `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. type: string nullable: true type: array type: object Event: description: Object representing an event. properties: alert_type: $ref: "#/components/schemas/EventAlertType" date_happened: description: |- POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events up to 18 hours in the past and two hours in the future. format: int64 type: integer device_name: description: A device name. type: string host: description: |- Host name to associate with the event. Any tags associated with the host are also applied to this event. type: string id: description: Integer ID of the event. format: int64 readOnly: true type: integer id_str: description: |- Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy. readOnly: true type: string payload: description: Payload of the event. example: "{}" readOnly: true type: string priority: $ref: "#/components/schemas/EventPriority" source_type_name: description: |- The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. The list of standard source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). type: string tags: description: A list of tags to apply to the event. example: ["environment:test"] items: description: A tag. type: string type: array text: description: |- The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. Use `msg_text` with the Datadog Ruby library. example: "Oh boy!" maxLength: 4000 type: string title: description: The event title. example: "Did you hear the news today?" type: string url: description: URL of the event. readOnly: true type: string type: object EventAlertType: description: |- If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. enum: - error - warning - info - success - user_update - recommendation - snapshot example: "info" type: string x-enum-varnames: - ERROR - WARNING - INFO - SUCCESS - USER_UPDATE - RECOMMENDATION - SNAPSHOT EventCreateRequest: description: Object representing an event. properties: aggregation_key: description: |- An arbitrary string to use for aggregation. Limited to 100 characters. If you specify a key, all events using that key are grouped together in the Event Stream. maxLength: 100 type: string alert_type: $ref: "#/components/schemas/EventAlertType" date_happened: description: |- POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events no older than 18 hours format: int64 type: integer device_name: description: A device name. type: string host: description: |- Host name to associate with the event. Any tags associated with the host are also applied to this event. type: string priority: $ref: "#/components/schemas/EventPriority" related_event_id: description: ID of the parent event. Must be sent as an integer (that is no quotes). format: int64 type: integer source_type_name: description: |- The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). type: string tags: description: A list of tags to apply to the event. example: ["environment:test"] items: description: A tag. type: string type: array text: description: |- The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. Use `msg_text` with the Datadog Ruby library. example: "Oh boy!" maxLength: 4000 type: string title: description: The event title. example: "Did you hear the news today?" type: string required: - title - text type: object EventCreateResponse: description: Object containing an event response. properties: event: $ref: "#/components/schemas/Event" status: description: A status. type: string type: object EventListResponse: description: An event list response. properties: events: description: An array of events. items: $ref: "#/components/schemas/Event" type: array status: description: A status. type: string type: object EventPriority: description: The priority of the event. For example, `normal` or `low`. enum: - normal - low example: "normal" nullable: true type: string x-enum-varnames: - NORMAL - LOW EventQueryDefinition: description: The event query. properties: search: description: The query being made on the event. example: "" type: string tags_execution: description: The execution method for multi-value filters. Can be either and or or. example: "" type: string required: - search - tags_execution type: object EventResponse: description: Object containing an event response. properties: event: $ref: "#/components/schemas/Event" status: description: A status. type: string type: object EventStreamWidgetDefinition: description: |- The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. properties: description: description: The description of the widget. type: string event_size: $ref: "#/components/schemas/WidgetEventSize" query: description: Query to filter the event stream with. example: "" type: string tags_execution: description: The execution method for multi-value filters. Can be either and or or. type: string time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/EventStreamWidgetDefinitionType" required: - type - query type: object EventStreamWidgetDefinitionType: default: event_stream description: Type of the event stream widget. enum: - event_stream example: event_stream type: string x-enum-varnames: - EVENT_STREAM EventTimelineWidgetDefinition: description: The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards. properties: description: description: The description of the widget. type: string query: description: Query to filter the event timeline with. example: "" type: string tags_execution: description: The execution method for multi-value filters. Can be either and or or. type: string time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/EventTimelineWidgetDefinitionType" required: - type - query type: object EventTimelineWidgetDefinitionType: default: event_timeline description: Type of the event timeline widget. enum: - event_timeline example: event_timeline type: string x-enum-varnames: - EVENT_TIMELINE EventsAggregation: description: The type of aggregation that can be performed on events-based queries. example: avg oneOf: - $ref: "#/components/schemas/EventsAggregationValue" - $ref: "#/components/schemas/EventsAggregationPercentile" EventsAggregationPercentile: description: Percentile aggregation. pattern: '^pc[0-9]+(\.[0-9]+)?$' type: string EventsAggregationValue: description: Standard aggregation types for events-based queries. enum: - avg - cardinality - count - delta - earliest - latest - max - median - min - most_frequent - sum type: string x-enum-varnames: - AVG - CARDINALITY - COUNT - DELTA - EARLIEST - LATEST - MAX - MEDIAN - MIN - MOST_FREQUENT - SUM FormulaAndFunctionApmDependencyStatName: description: APM statistic. enum: - avg_duration - avg_root_duration - avg_spans_per_trace - error_rate - pct_exec_time - pct_of_traces - total_traces_count example: avg_duration type: string x-enum-varnames: - AVG_DURATION - AVG_ROOT_DURATION - AVG_SPANS_PER_TRACE - ERROR_RATE - PCT_EXEC_TIME - PCT_OF_TRACES - TOTAL_TRACES_COUNT FormulaAndFunctionApmDependencyStatsDataSource: description: Data source for APM dependency stats queries. enum: - apm_dependency_stats example: apm_dependency_stats type: string x-enum-varnames: - APM_DEPENDENCY_STATS FormulaAndFunctionApmDependencyStatsQueryDefinition: description: A formula and functions APM dependency stats query. properties: cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsDataSource" env: description: APM environment. example: "staging" type: string is_upstream: description: Determines whether stats for upstream or downstream dependencies should be queried. example: false type: boolean name: description: Name of query to use in formulas. example: "query_errors" type: string operation_name: description: Name of operation on service. example: "cassandra.query" type: string primary_tag_name: description: The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog. example: "datacenter" type: string primary_tag_value: description: Filter APM data by the second primary tag. `primary_tag_name` must also be specified. example: "staging" type: string resource_name: description: APM resource. example: "DELETE FROM foo WHERE baz = ?" type: string service: description: APM service. example: "cassandra" type: string stat: $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatName" required: - data_source - env - stat - operation_name - resource_name - service - name type: object FormulaAndFunctionApmMetricStatName: description: APM metric stat name. enum: - errors - error_rate - errors_per_second - latency_avg - latency_max - latency_p50 - latency_p75 - latency_p90 - latency_p95 - latency_p99 - latency_p999 - latency_distribution - hits - hits_per_second - total_time - apdex example: "hits" type: string x-enum-varnames: - ERRORS - ERROR_RATE - ERRORS_PER_SECOND - LATENCY_AVG - LATENCY_MAX - LATENCY_P50 - LATENCY_P75 - LATENCY_P90 - LATENCY_P95 - LATENCY_P99 - LATENCY_P999 - LATENCY_DISTRIBUTION - HITS - HITS_PER_SECOND - TOTAL_TIME - APDEX FormulaAndFunctionApmMetricsDataSource: description: Data source for APM metrics queries. enum: - apm_metrics example: apm_metrics type: string x-enum-varnames: - APM_METRICS FormulaAndFunctionApmMetricsQueryDefinition: description: A formula and functions APM metrics query. properties: data_source: $ref: "#/components/schemas/FormulaAndFunctionApmMetricsDataSource" group_by: description: Optional fields to group the query results by. items: description: A field to group results by. example: "resource_name" type: string type: array name: description: Name of this query to use in formulas. example: "query_errors" type: string operation_mode: description: Optional operation mode to aggregate across operation names. example: "primary" type: string operation_name: description: Name of operation on service. If not provided, the primary operation name is used. example: "web.request" type: string peer_tags: description: Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). items: description: "A tag identifying a specific downstream entity (for example: peer.service, peer.db_instance)." example: "peer.service:my-service" type: string type: array query_filter: description: Additional filters for the query using metrics query syntax (e.g., env, primary_tag). example: "env:prod" type: string resource_hash: description: The hash of a specific resource to filter by. example: "abc123" type: string resource_name: description: The full name of a specific resource to filter by. example: "GET /api/v1/users" type: string service: description: APM service name. example: "web-store" type: string span_kind: $ref: "#/components/schemas/FormulaAndFunctionApmMetricsSpanKind" stat: $ref: "#/components/schemas/FormulaAndFunctionApmMetricStatName" required: - data_source - name - stat type: object FormulaAndFunctionApmMetricsSpanKind: description: Describes the relationship between the span, its parents, and its children in a trace. enum: - consumer - server - client - producer - internal example: "server" type: string x-enum-varnames: - CONSUMER - SERVER - CLIENT - PRODUCER - INTERNAL FormulaAndFunctionApmResourceStatName: description: APM resource stat name. enum: - errors - error_rate - hits - latency_avg - latency_distribution - latency_max - latency_p50 - latency_p75 - latency_p90 - latency_p95 - latency_p99 example: "hits" type: string x-enum-varnames: - ERRORS - ERROR_RATE - HITS - LATENCY_AVG - LATENCY_DISTRIBUTION - LATENCY_MAX - LATENCY_P50 - LATENCY_P75 - LATENCY_P90 - LATENCY_P95 - LATENCY_P99 FormulaAndFunctionApmResourceStatsDataSource: description: Data source for APM resource stats queries. enum: - apm_resource_stats example: "apm_resource_stats" type: string x-enum-varnames: - APM_RESOURCE_STATS FormulaAndFunctionApmResourceStatsQueryDefinition: deprecated: true description: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. properties: cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsDataSource" env: description: APM environment. example: "staging" type: string group_by: description: Array of fields to group results by. items: description: Field to group results by. example: "resource_name" type: string type: array name: description: Name of this query to use in formulas. example: "query_errors" type: string operation_name: description: Name of operation on service. example: "cassandra.query" type: string primary_tag_name: description: Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog example: "datacenter" type: string primary_tag_value: description: Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. example: "us-east-az" type: string resource_name: description: APM resource name. example: "Admin::ProductsController#create" type: string service: description: APM service name. example: "web-store" type: string stat: $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatName" required: - data_source - env - name - service - stat type: object FormulaAndFunctionCloudCostDataSource: description: Data source for Cloud Cost queries. enum: - cloud_cost example: "cloud_cost" type: string x-enum-varnames: - CLOUD_COST FormulaAndFunctionCloudCostQueryDefinition: description: A formula and functions Cloud Cost query. example: data_source: "cloud_cost" name: "query1" query: "sum:aws.cost.amortized{*}" properties: aggregator: $ref: "#/components/schemas/WidgetAggregator" cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionCloudCostDataSource" name: description: Name of the query for use in formulas. example: "my_query" type: string query: description: Query for Cloud Cost data. example: "" type: string required: - data_source - query - name type: object FormulaAndFunctionEventAggregation: description: Aggregation methods for event platform queries. enum: - count - cardinality - median - pc75 - pc90 - pc95 - pc98 - pc99 - sum - min - max - avg example: avg type: string x-enum-varnames: - COUNT - CARDINALITY - MEDIAN - PC75 - PC90 - PC95 - PC98 - PC99 - SUM - MIN - MAX - AVG FormulaAndFunctionEventQueryDefinition: description: A formula and functions events query. properties: compute: $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinitionCompute" cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionEventsDataSource" group_by: $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig" indexes: description: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. example: ["days-3", "days-7"] items: description: A log index set up for your organization. For additional indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) documentation. type: string type: array name: description: Name of the query for use in formulas. example: "query_errors" type: string search: $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinitionSearch" storage: description: Option for storage location. Feature in Private Beta. example: "indexes" type: string required: - data_source - compute - name type: object FormulaAndFunctionEventQueryDefinitionCompute: description: Compute options. properties: aggregation: $ref: "#/components/schemas/FormulaAndFunctionEventAggregation" interval: description: A time interval in milliseconds. example: 60000 format: int64 type: integer metric: description: Measurable attribute to compute. example: "@duration" type: string required: - aggregation type: object FormulaAndFunctionEventQueryDefinitionSearch: description: Search options. properties: query: description: Events search string. example: "service:query" type: string required: - query type: object FormulaAndFunctionEventQueryGroupBy: description: List of objects used to group by. properties: facet: description: Event facet. example: status. type: string limit: description: Number of groups to return. example: 10 format: int64 type: integer sort: $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort" required: - facet type: object FormulaAndFunctionEventQueryGroupByConfig: description: Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. oneOf: - $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByList" - $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByFields" FormulaAndFunctionEventQueryGroupByFields: description: Flat group by configuration using multiple event facet fields. properties: fields: description: List of event facets to group by. example: ["hostname", "service"] items: description: Event facet. type: string type: array limit: description: Number of groups to return. example: 10 format: int64 type: integer sort: $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort" required: - fields type: object FormulaAndFunctionEventQueryGroupByList: description: List of objects used to group by. items: $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBy" type: array FormulaAndFunctionEventQueryGroupBySort: description: Options for sorting group by results. properties: aggregation: $ref: "#/components/schemas/FormulaAndFunctionEventAggregation" metric: description: Metric used for sorting group by results. type: string order: $ref: "#/components/schemas/QuerySortOrder" required: - aggregation type: object FormulaAndFunctionEventsDataSource: description: Data source for event platform-based queries. enum: - logs - spans - network - rum - security_signals - profiles - audit - events - ci_tests - ci_pipelines - incident_analytics - product_analytics - on_call_events - errors - llm_observability example: "logs" type: string x-enum-varnames: - LOGS - SPANS - NETWORK - RUM - SECURITY_SIGNALS - PROFILES - AUDIT - EVENTS - CI_TESTS - CI_PIPELINES - INCIDENT_ANALYTICS - PRODUCT_ANALYTICS - ON_CALL_EVENTS - ERRORS - LLM_OBSERVABILITY FormulaAndFunctionMetricAggregation: description: The aggregation methods available for metrics queries. enum: - avg - min - max - sum - last - area - l2norm - percentile example: avg type: string x-enum-varnames: - AVG - MIN - MAX - SUM - LAST - AREA - L2NORM - PERCENTILE FormulaAndFunctionMetricDataSource: description: Data source for metrics queries. enum: - metrics example: "metrics" type: string x-enum-varnames: - METRICS FormulaAndFunctionMetricQueryDefinition: description: A formula and functions metrics query. example: data_source: "metrics" name: "my_query" query: "avg:system.cpu.user{*}" properties: aggregator: $ref: "#/components/schemas/FormulaAndFunctionMetricAggregation" cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionMetricDataSource" name: description: Name of the query for use in formulas. example: "my_query" type: string query: description: Metrics query definition. example: "avg:system.cpu.user{*}" type: string semantic_mode: $ref: "#/components/schemas/FormulaAndFunctionMetricSemanticMode" required: - data_source - query - name type: object FormulaAndFunctionMetricSemanticMode: description: Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. enum: - combined - native example: "combined" type: string x-enum-varnames: - COMBINED - NATIVE FormulaAndFunctionProcessQueryDataSource: description: Data sources that rely on the process backend. enum: - process - container example: "process" type: string x-enum-varnames: - PROCESS - CONTAINER FormulaAndFunctionProcessQueryDefinition: description: Process query using formulas and functions. properties: aggregator: $ref: "#/components/schemas/FormulaAndFunctionMetricAggregation" cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDataSource" is_normalized_cpu: description: Whether to normalize the CPU percentages. type: boolean limit: description: Number of hits to return. format: int64 type: integer metric: description: Process metric name. example: "avg:system.cpu.user{*}" type: string name: description: Name of query for use in formulas. example: "query_errors" type: string sort: $ref: "#/components/schemas/QuerySortOrder" tag_filters: description: An array of tags to filter by. items: description: One of the tags to filter by. type: string type: array text_filter: description: Text to use as filter. type: string required: - data_source - metric - name type: object FormulaAndFunctionProductAnalyticsExtendedDataSource: description: Data source for Product Analytics Extended queries. enum: - product_analytics_extended example: product_analytics_extended type: string x-enum-varnames: - PRODUCT_ANALYTICS_EXTENDED FormulaAndFunctionProductAnalyticsExtendedQueryDefinition: description: A formula and functions Product Analytics Extended query for advanced analytics features. properties: audience_filters: $ref: "#/components/schemas/ProductAnalyticsAudienceFilters" compute: $ref: "#/components/schemas/ProductAnalyticsExtendedCompute" data_source: $ref: "#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedDataSource" group_by: description: Group by configuration. items: $ref: "#/components/schemas/ProductAnalyticsExtendedGroupBy" description: A Product Analytics Extended group by configuration. type: array indexes: description: Event indexes to query. example: ["*"] items: $ref: "#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedQueryDefinitionIndexesItems" type: array name: description: Name of the query for use in formulas. example: "query1" type: string query: $ref: "#/components/schemas/ProductAnalyticsBaseQuery" required: - data_source - name - query - compute type: object FormulaAndFunctionProductAnalyticsExtendedQueryDefinitionIndexesItems: description: Use `"*"` to query all indexes. enum: - "*" type: string x-enum-varnames: - ALL FormulaAndFunctionQueryDefinition: description: A formula and function query. oneOf: - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionSLOQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionUserJourneyQueryDefinition" - $ref: "#/components/schemas/FormulaAndFunctionRetentionQueryDefinition" FormulaAndFunctionResponseFormat: description: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. enum: - timeseries - scalar - event_list example: timeseries type: string x-enum-varnames: - TIMESERIES - SCALAR - EVENT_LIST FormulaAndFunctionRetentionQueryDefinition: description: A formula and functions Retention query for defining timeseries and scalar visualizations. properties: compute: $ref: "#/components/schemas/RetentionCompute" data_source: $ref: "#/components/schemas/RetentionDataSource" group_by: description: Group by configuration. items: $ref: "#/components/schemas/RetentionGroupBy" description: A Retention group by configuration. type: array name: description: Name of the query for use in formulas. example: "query1" type: string search: $ref: "#/components/schemas/RetentionSearch" required: - data_source - name - search - compute type: object FormulaAndFunctionSLODataSource: description: Data source for SLO measures queries. enum: - slo example: "slo" type: string x-enum-varnames: - SLO FormulaAndFunctionSLOGroupMode: description: Group mode to query measures. enum: - overall - components example: "overall" type: string x-enum-varnames: - OVERALL - COMPONENTS FormulaAndFunctionSLOMeasure: description: SLO measures queries. enum: - good_events - bad_events - good_minutes - bad_minutes - slo_status - error_budget_remaining - burn_rate - error_budget_burndown example: "slo_status" type: string x-enum-varnames: - GOOD_EVENTS - BAD_EVENTS - GOOD_MINUTES - BAD_MINUTES - SLO_STATUS - ERROR_BUDGET_REMAINING - BURN_RATE - ERROR_BUDGET_BURNDOWN FormulaAndFunctionSLOQueryDefinition: description: A formula and functions metrics query. example: additional_query_filters: "*" data_source: "slo" group_mode: "overall" measure: "good_events" name: "my_slo" slo_id: "12345678910" slo_query_type: "metric" properties: additional_query_filters: description: Additional filters applied to the SLO query. example: "host:host_a,env:prod" type: string cross_org_uuids: $ref: "#/components/schemas/CrossOrgUuids" data_source: $ref: "#/components/schemas/FormulaAndFunctionSLODataSource" group_mode: $ref: "#/components/schemas/FormulaAndFunctionSLOGroupMode" measure: $ref: "#/components/schemas/FormulaAndFunctionSLOMeasure" name: description: Name of the query for use in formulas. example: "my_slo" type: string slo_id: description: ID of an SLO to query measures. example: "12345678910" type: string slo_query_type: $ref: "#/components/schemas/FormulaAndFunctionSLOQueryType" required: - data_source - slo_id - measure type: object FormulaAndFunctionSLOQueryType: description: Name of the query for use in formulas. enum: - metric - monitor - time_slice example: "metric" type: string x-enum-varnames: - METRIC - MONITOR - TIME_SLICE FormulaAndFunctionUserJourneyQueryDefinition: description: A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. properties: compute: $ref: "#/components/schemas/UserJourneyFormulaCompute" data_source: $ref: "#/components/schemas/ProductAnalyticsFunnelDataSource" group_by: description: Group by configuration. items: $ref: "#/components/schemas/UserJourneyFormulaGroupBy" description: A User Journey group by configuration. type: array name: description: Name of the query for use in formulas. example: "query1" type: string search: $ref: "#/components/schemas/UserJourneySearch" required: - data_source - name - search - compute type: object FormulaType: description: Set the sort type to formula. enum: ["formula"] example: "formula" type: string x-enum-varnames: - FORMULA FreeTextWidgetDefinition: description: Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. properties: background_color: $ref: "#/components/schemas/WidgetBackgroundColor" color: description: Color of the text. type: string font_size: description: Size of the text. type: string text: description: Text to display. example: "" type: string text_align: $ref: "#/components/schemas/WidgetTextAlign" type: $ref: "#/components/schemas/FreeTextWidgetDefinitionType" required: - type - text type: object FreeTextWidgetDefinitionType: default: free_text description: Type of the free text widget. enum: - free_text example: free_text type: string x-enum-varnames: - FREE_TEXT FunnelComparisonCustomTimeframe: additionalProperties: false description: Custom timeframe for funnel comparison. properties: from: description: Start of the custom timeframe. example: 0.0 format: double type: number to: description: End of the custom timeframe. example: 0.0 format: double type: number required: - from - to type: object FunnelComparisonDuration: additionalProperties: false description: Comparison time configuration for funnel widgets. properties: custom_timeframe: $ref: "#/components/schemas/FunnelComparisonCustomTimeframe" type: $ref: "#/components/schemas/FunnelComparisonDurationType" required: - type type: object FunnelComparisonDurationType: description: Type of comparison duration. enum: - previous_timeframe - custom_timeframe - previous_day - previous_week - previous_month example: previous_timeframe type: string x-enum-varnames: - PREVIOUS_TIMEFRAME - CUSTOM_TIMEFRAME - PREVIOUS_DAY - PREVIOUS_WEEK - PREVIOUS_MONTH FunnelGroupedDisplay: description: Display mode for grouped funnel results. enum: - stacked - side_by_side example: stacked type: string x-enum-varnames: - STACKED - SIDE_BY_SIDE FunnelQuery: description: Updated funnel widget. properties: data_source: $ref: "#/components/schemas/FunnelSource" query_string: description: The widget query. example: "@browser.name:Chrome" type: string steps: description: List of funnel steps. items: $ref: "#/components/schemas/FunnelStep" type: array required: - query_string - data_source - steps type: object FunnelRequestType: description: Widget request type. enum: - funnel example: funnel type: string x-enum-varnames: - FUNNEL FunnelSource: default: rum description: Source from which to query items to display in the funnel. enum: - rum example: rum type: string x-enum-varnames: - RUM FunnelStep: description: The funnel step. properties: facet: description: The facet of the step. example: "@view.name" type: string value: description: The value of the step. example: "/apm/home" type: string required: - facet - value type: object FunnelWidgetDefinition: description: |- The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. properties: description: description: The description of the widget. type: string grouped_display: $ref: "#/components/schemas/FunnelGroupedDisplay" requests: description: Request payload used to query items. example: [{"query": {"data_source": "rum", "query_string": "@browser.name:Chrome", "steps": [{"facet": "@view.name", "value": "/logs"}, {"facet": "@view.name", "value": "/apm/home"}]}, "request_type": "funnel"}] items: $ref: "#/components/schemas/FunnelWidgetRequest" minItems: 1 type: array time: $ref: "#/components/schemas/WidgetTime" title: description: The title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: The size of the title. type: string type: $ref: "#/components/schemas/FunnelWidgetDefinitionType" required: - type - requests type: object FunnelWidgetDefinitionType: default: funnel description: Type of funnel widget. enum: - funnel example: funnel type: string x-enum-varnames: - FUNNEL FunnelWidgetRequest: description: Updated funnel widget. properties: query: $ref: "#/components/schemas/FunnelQuery" request_type: $ref: "#/components/schemas/FunnelRequestType" required: - query - request_type type: object GCPAccount: description: Your Google Cloud Platform Account. properties: auth_provider_x509_cert_url: description: |- Should be `https://www.googleapis.com/oauth2/v1/certs`. example: "https://www.googleapis.com/oauth2/v1/certs" type: string auth_uri: description: |- Should be `https://accounts.google.com/o/oauth2/auth`. example: "https://accounts.google.com/o/oauth2/auth" type: string automute: description: |- Silence monitors for expected GCE instance shutdowns. type: boolean client_email: description: |- Your email found in your JSON service account key. example: "api-dev@datadog-sandbox.iam.gserviceaccount.com" type: string client_id: description: |- Your ID found in your JSON service account key. example: "123456712345671234567" type: string client_x509_cert_url: description: |- Should be `https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL` where `$CLIENT_EMAIL` is the email found in your JSON service account key. example: "https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL" type: string cloud_run_revision_filters: deprecated: true description: |- List of filters to limit the Cloud Run revisions that are pulled into Datadog by using tags. Only Cloud Run revision resources that apply to specified filters are imported into Datadog. **Note:** This field is deprecated. Instead, use `monitored_resource_configs` with `type=cloud_run_revision` example: ["$KEY:$VALUE"] items: description: Cloud Run revision filters type: string type: array errors: description: An array of errors. example: ["*"] items: description: String representation of one error. readOnly: true type: string type: array host_filters: deprecated: true description: |- A comma-separated list of filters to limit the VM instances that are pulled into Datadog by using tags. Only VM instance resources that apply to specified filters are imported into Datadog. **Note:** This field is deprecated. Instead, use `monitored_resource_configs` with `type=gce_instance` example: "$KEY1:$VALUE1,$KEY2:$VALUE2" type: string is_cspm_enabled: description: |- When enabled, Datadog will activate the Cloud Security Monitoring product for this service account. Note: This requires resource_collection_enabled to be set to true. example: true type: boolean is_resource_change_collection_enabled: default: false description: |- When enabled, Datadog scans for all resource change data in your Google Cloud environment. example: true type: boolean is_security_command_center_enabled: default: false description: |- When enabled, Datadog will attempt to collect Security Command Center Findings. Note: This requires additional permissions on the service account. example: true type: boolean monitored_resource_configs: description: Configurations for GCP monitored resources. example: [{"filters": ["$KEY:$VALUE"], "type": "gce_instance"}] items: $ref: "#/components/schemas/GCPMonitoredResourceConfig" type: array private_key: description: |- Your private key name found in your JSON service account key. example: "private_key" type: string private_key_id: description: |- Your private key ID found in your JSON service account key. example: "123456789abcdefghi123456789abcdefghijklm" type: string project_id: description: |- Your Google Cloud project ID found in your JSON service account key. example: "datadog-apitest" type: string resource_collection_enabled: description: |- When enabled, Datadog scans for all resources in your GCP environment. example: true type: boolean token_uri: description: |- Should be `https://accounts.google.com/o/oauth2/token`. example: "https://accounts.google.com/o/oauth2/token" type: string type: description: |- The value for service_account found in your JSON service account key. example: "service_account" type: string type: object GCPAccountListResponse: description: Array of GCP account responses. items: $ref: "#/components/schemas/GCPAccount" type: array GCPMonitoredResourceConfig: description: Configuration for a GCP monitored resource. properties: filters: description: |- List of filters to limit the monitored resources that are pulled into Datadog by using tags. Only monitored resources that apply to specified filters are imported into Datadog. example: ["$KEY:$VALUE"] items: description: A monitored resource filter type: string type: array type: $ref: "#/components/schemas/GCPMonitoredResourceConfigType" type: object GCPMonitoredResourceConfigType: description: The GCP monitored resource type. Only a subset of resource types are supported. enum: ["cloud_function", "cloud_run_revision", "gce_instance"] example: "gce_instance" type: string x-enum-varnames: - CLOUD_FUNCTION - CLOUD_RUN_REVISION - GCE_INSTANCE GeomapWidgetDefinition: description: This visualization displays a series of values by country on a world map. properties: custom_links: description: A list of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string requests: description: |- Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`. example: ["rum_query": {"search": {"query": "{}"}}] items: $ref: "#/components/schemas/GeomapWidgetRequest" maxItems: 2 minItems: 1 type: array style: $ref: "#/components/schemas/GeomapWidgetDefinitionStyle" time: $ref: "#/components/schemas/WidgetTime" title: description: The title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: The size of the title. type: string type: $ref: "#/components/schemas/GeomapWidgetDefinitionType" view: $ref: "#/components/schemas/GeomapWidgetDefinitionView" required: - type - requests - style - view type: object GeomapWidgetDefinitionStyle: description: The style to apply to the widget. example: {palette: "hostmap_blues", palette_flip: false} properties: palette: description: The color palette to apply to the widget. example: hostmap_blues type: string palette_flip: description: Whether to flip the palette tones. example: false type: boolean required: - palette - palette_flip type: object GeomapWidgetDefinitionType: default: geomap description: Type of the geomap widget. enum: - geomap example: geomap type: string x-enum-varnames: - GEOMAP GeomapWidgetDefinitionView: description: The view of the world that the map should render. example: {focus: "WORLD"} properties: focus: description: The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`). example: "WORLD" type: string required: - focus type: object GeomapWidgetRequest: description: An updated geomap widget. properties: columns: description: Widget columns. example: [{"field": "timestamp", "width": "auto"}, {"field": "content", "width": "full"}] items: $ref: "#/components/schemas/ListStreamColumn" type: array conditional_formats: description: Threshold (numeric) conditional formatting rules may be used by a regions layer. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array query: $ref: "#/components/schemas/ListStreamQuery" response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: $ref: "#/components/schemas/WidgetSortBy" style: $ref: "#/components/schemas/GeomapWidgetRequestStyle" text_formats: description: Text formatting rules may be used by a points layer. items: $ref: "#/components/schemas/TableWidgetTextFormatRule" type: array type: object GeomapWidgetRequestStyle: description: The style to apply to the request for points layer. example: {color_by: "status"} properties: color_by: description: The category to color the points by. example: status type: string type: object GraphSnapshot: description: Object representing a graph snapshot. properties: graph_def: description: |- A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. type: string metric_query: description: The metric query. One of `metric_query` or `graph_def` is required. type: string snapshot_url: description: URL of your [graph snapshot](https://docs.datadoghq.com/metrics/explorer/#snapshot). example: https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc type: string type: object GroupType: description: Set the sort type to group. enum: ["group"] example: "group" type: string x-enum-varnames: - GROUP GroupWidgetDefinition: description: The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible. properties: background_color: $ref: "#/components/schemas/WidgetBackgroundColor" banner_img: description: URL of image to display as a banner for the group. type: string layout_type: $ref: "#/components/schemas/WidgetLayoutType" show_title: default: true description: Whether to show the title or not. type: boolean title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" type: $ref: "#/components/schemas/GroupWidgetDefinitionType" widgets: description: List of widget groups. example: ["definition": {"requests": {"fill": {"q": "avg:system.cpu.user{*}"}}, "type": "hostmap"}] items: $ref: "#/components/schemas/Widget" type: array required: - type - layout_type - widgets type: object GroupWidgetDefinitionType: default: group description: Type of the group widget. enum: - group example: group type: string x-enum-varnames: - GROUP HTTPLog: description: Structured log message. items: $ref: "#/components/schemas/HTTPLogItem" type: array HTTPLogError: description: Invalid query performed. properties: code: description: Error code. example: 0 format: int32 maximum: 2147483647 type: integer message: description: Error message. example: "Your browser sent an invalid request." type: string required: - code - message type: object HTTPLogItem: additionalProperties: description: Additional log attributes. type: string description: Logs that are sent over HTTP. properties: ddsource: description: |- The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). example: nginx type: string ddtags: description: Tags associated with your logs. example: env:staging,version:5.1 type: string hostname: description: The name of the originating host of the log. example: i-012345678 type: string message: description: |- The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. example: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World type: string service: description: |- The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). example: payment type: string required: - message type: object HeatMapWidgetDefinition: description: The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string events: deprecated: true description: List of widget events. Deprecated - Use `overlay` request type instead. items: $ref: "#/components/schemas/WidgetEvent" type: array legend_size: $ref: "#/components/schemas/WidgetLegendSize" markers: description: List of markers. example: [{"display_type": "percentile", "value": "90"}] items: $ref: "#/components/schemas/WidgetMarker" type: array requests: description: List of widget types. example: ["q": "jvm.heap.memory"] items: $ref: "#/components/schemas/HeatMapWidgetRequest" maxItems: 1 minItems: 1 type: array show_legend: description: Whether or not to display the legend on this widget. type: boolean time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/HeatMapWidgetDefinitionType" xaxis: $ref: "#/components/schemas/HeatMapWidgetXAxis" yaxis: $ref: "#/components/schemas/WidgetAxis" required: - type - requests type: object HeatMapWidgetDefinitionType: default: heatmap description: Type of the heat map widget. enum: - heatmap example: heatmap type: string x-enum-varnames: - HEATMAP HeatMapWidgetRequest: description: Updated heat map widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: $ref: "#/components/schemas/EventQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array query: $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" request_type: $ref: "#/components/schemas/WidgetHistogramRequestType" description: Applicable only for distribution of point values for distribution metrics. response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" description: Applicable only for distribution of aggregated grouped queries. rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: $ref: "#/components/schemas/WidgetStyle" type: object HeatMapWidgetXAxis: description: X Axis controls for the heat map widget. properties: num_buckets: description: |- Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier). format: int64 type: integer type: object Host: description: Object representing a host. properties: aliases: description: Host aliases collected by Datadog. items: description: A host alias. example: "mycoolhost-1" type: string type: array apps: description: The Datadog integrations reporting metrics for the host. items: description: Name of an app. example: "agent" type: string type: array aws_name: description: AWS name of your host. example: "mycoolhost-1" type: string host_name: description: The host name. example: "i-deadbeef" type: string id: description: The host ID. example: 123456 format: int64 type: integer is_muted: description: If a host is muted or unmuted. example: false type: boolean last_reported_time: description: Last time the host reported a metric data point. example: 1565000000 format: int64 type: integer meta: $ref: "#/components/schemas/HostMeta" metrics: $ref: "#/components/schemas/HostMetrics" mute_timeout: description: Timeout of the mute applied to your host. format: int64 nullable: true type: integer name: description: The host name. example: "i-hostname" type: string sources: description: Source or cloud provider associated with your host. items: description: A source or cloud provider name. example: "aws" type: string type: array tags_by_source: additionalProperties: description: Array of tags for a single source. items: description: A tag. example: "test.example.com.host" type: string type: array description: List of tags for each source (AWS, Datadog Agent, Chef..). type: object up: description: Displays UP when the expected metrics are received and displays `???` if no metrics are received. example: true type: boolean type: object HostListResponse: description: Response with Host information from Datadog. properties: host_list: description: Array of hosts. items: $ref: "#/components/schemas/Host" type: array total_matching: description: Number of host matching the query. example: 1 format: int64 type: integer total_returned: description: Number of host returned. example: 1 format: int64 type: integer type: object HostMapRequest: description: Updated host map. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: description: Query definition. type: string rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. type: object HostMapWidgetDefinition: description: The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string group: description: List of tag prefixes to group by. items: description: Tag prefixes. type: string type: array no_group_hosts: description: Whether to show the hosts that don’t fit in a group. type: boolean no_metric_hosts: description: Whether to show the hosts with no metrics. type: boolean node_type: $ref: "#/components/schemas/WidgetNodeType" notes: description: Notes on the title. type: string requests: $ref: "#/components/schemas/HostMapWidgetDefinitionRequests" scope: description: List of tags used to filter the map. items: description: Tags. type: string type: array style: $ref: "#/components/schemas/HostMapWidgetDefinitionStyle" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/HostMapWidgetDefinitionType" required: - type - requests type: object HostMapWidgetDefinitionRequests: description: >- Query definition for the host map widget. Supports two mutually exclusive formats distinguished by the presence of `request_type`: the legacy metric-based format (`fill`/`size`) and the infrastructure-backed format (`request_type`, `node_type`, `enrichments`). example: {} properties: child: $ref: "#/components/schemas/HostMapWidgetInfrastructureRequest" conditional_formats: description: List of conditional formatting rules applied to fill values. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array enrichments: description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension. example: - formulas: - dimension: fill formula: "query1" queries: - data_source: metrics name: "query1" query: "avg:system.cpu.user{*} by {host}" response_format: scalar items: $ref: "#/components/schemas/HostMapWidgetScalarRequest" type: array fill: $ref: "#/components/schemas/HostMapRequest" filter: description: Filter string for the entity set in tag format (for example, `env:prod`). example: "env:prod" type: string group_by: description: |- Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. items: $ref: "#/components/schemas/HostMapWidgetGroupBy" type: array no_group_hosts: description: Whether to hide entities that have no group assignment. type: boolean no_metric_hosts: description: Whether to hide entities that have no enrichment data. type: boolean node_type: $ref: "#/components/schemas/HostMapWidgetNodeType" request_type: $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType" size: $ref: "#/components/schemas/HostMapRequest" style: $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle" type: object HostMapWidgetDefinitionStyle: description: The style to apply to the widget. properties: fill_max: description: Max value to use to color the map. type: string fill_min: description: Min value to use to color the map. type: string palette: description: Color palette to apply to the widget. type: string palette_flip: description: Whether to flip the palette tones. type: boolean type: object HostMapWidgetDefinitionType: default: hostmap description: Type of the host map widget. enum: - hostmap example: hostmap type: string x-enum-varnames: - HOSTMAP HostMapWidgetDimension: description: Visual dimension driven by a formula in the infrastructure host map widget. enum: - node - fill - size example: node type: string x-enum-varnames: - NODE - FILL - SIZE HostMapWidgetFormula: description: |- Formula for the infrastructure host map widget that specifies both the expression and the visual dimension it populates. properties: alias: description: Expression alias. example: "my-metric" type: string dimension: $ref: "#/components/schemas/HostMapWidgetDimension" formula: description: String expression built from queries, formulas, and functions. example: "query1" type: string number_format: $ref: "#/components/schemas/WidgetNumberFormat" required: - formula - dimension type: object HostMapWidgetGroupBy: description: Defines a grouping dimension for the infrastructure host map. properties: column: description: Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`). example: tags type: string key: description: Key within the column for nested attribute types (for example, `service` within `tags`). example: service type: string required: - column type: object HostMapWidgetInfrastructureRequest: description: |- Infrastructure-backed request for the host map widget. Supports entity-based visualization with metric query enrichments, tag-based filtering, flexible grouping, and hierarchical views. properties: child: $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestLeaf" description: |- Optional child request for hierarchical visualization (for example, hosts containing containers). Maximum one level of nesting. conditional_formats: description: List of conditional formatting rules applied to fill values. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array enrichments: description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension. example: - formulas: - dimension: fill formula: "query1" queries: - data_source: metrics name: "query1" query: "avg:system.cpu.user{*} by {host}" response_format: scalar items: $ref: "#/components/schemas/HostMapWidgetScalarRequest" type: array filter: description: Filter string for the entity set in tag format (for example, `env:prod`). example: "env:prod" type: string group_by: description: |- Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. items: $ref: "#/components/schemas/HostMapWidgetGroupBy" type: array no_group_hosts: description: Whether to hide entities that have no group assignment. type: boolean no_metric_hosts: description: Whether to hide entities that have no enrichment data. type: boolean node_type: $ref: "#/components/schemas/HostMapWidgetNodeType" request_type: $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType" style: $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle" required: - request_type - node_type - enrichments type: object HostMapWidgetInfrastructureRequestLeaf: description: Infrastructure-backed host map child request (leaf node, no further nesting supported). properties: conditional_formats: description: List of conditional formatting rules applied to fill values. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array enrichments: description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension. example: - formulas: - dimension: fill formula: "query1" queries: - data_source: metrics name: "query1" query: "avg:system.cpu.user{*} by {host}" response_format: scalar items: $ref: "#/components/schemas/HostMapWidgetScalarRequest" type: array filter: description: Filter string for the entity set in tag format (for example, `env:prod`). example: "env:prod" type: string group_by: description: |- Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. items: $ref: "#/components/schemas/HostMapWidgetGroupBy" type: array no_group_hosts: description: Whether to hide entities that have no group assignment. type: boolean no_metric_hosts: description: Whether to hide entities that have no enrichment data. type: boolean node_type: $ref: "#/components/schemas/HostMapWidgetNodeType" request_type: $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType" style: $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle" required: - request_type - node_type - enrichments type: object HostMapWidgetInfrastructureRequestRequestType: description: Identifies this as an infrastructure-backed host map request. enum: - infrastructure_hostmap example: infrastructure_hostmap type: string x-enum-varnames: - INFRASTRUCTURE_HOSTMAP HostMapWidgetInfrastructureStyle: description: Style configuration for the infrastructure host map. properties: fill_max: description: Maximum value for the fill color scale. Omit to use automatic scaling. format: double type: number fill_min: description: Minimum value for the fill color scale. Omit to use automatic scaling. format: double type: number palette: description: Color palette name or alias. example: hostmap_blues type: string palette_flip: description: Whether to invert the color palette. type: boolean type: object HostMapWidgetNodeType: description: Which type of infrastructure entity to visualize in the host map. enum: - host - container - pod - cluster example: host type: string x-enum-varnames: - HOST - CONTAINER - POD - CLUSTER HostMapWidgetScalarRequest: description: |- Scalar formula request for the infrastructure host map widget. Each formula specifies which visual dimension it drives. properties: formulas: description: List of formulas that operate on queries, each assigned to a visual dimension. example: - dimension: fill formula: "query1" items: $ref: "#/components/schemas/HostMapWidgetFormula" type: array queries: description: List of queries that can be returned directly or used in formulas. example: - data_source: "metrics" name: "my_query" query: "avg:system.cpu.user{*}" items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/HostMapWidgetScalarRequestResponseFormat" required: - response_format - queries - formulas type: object HostMapWidgetScalarRequestResponseFormat: description: Response format for the scalar formula request. Only `scalar` is supported. enum: - scalar example: scalar type: string x-enum-varnames: - SCALAR HostMeta: description: Metadata associated with your host. properties: agent_checks: description: A list of Agent checks running on the host. items: $ref: "#/components/schemas/AgentCheck" type: array agent_version: description: The Datadog Agent version. example: "7.32.3" type: string cpuCores: description: The number of cores. example: 1 format: int64 type: integer fbsdV: description: An array of Mac versions. items: description: The version name. example: "FreeBSD" type: array gohai: description: JSON string containing system information. example: '{"cpu":{"cache_size":"8192 KB","cpu_cores":"1","cpu_logical_processors":"1","family":"6","mhz":"2712.000","model":"142","model_name":"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz","stepping":"10","vendor_id":"GenuineIntel"},"filesystem":[{"kb_size":"3966896","mounted_on":"/dev","name":"udev"},{"kb_size":"797396","mounted_on":"/run","name":"tmpfs"},{"kb_size":"64800356","mounted_on":"/","name":"/dev/mapper/vagrant--vg-root"},{"kb_size":"3986972","mounted_on":"/dev/shm","name":"tmpfs"},{"kb_size":"5120","mounted_on":"/run/lock","name":"tmpfs"},{"kb_size":"3986972","mounted_on":"/sys/fs/cgroup","name":"tmpfs"},{"kb_size":"488245288","mounted_on":"/vagrant","name":"vagrant"},{"kb_size":"797392","mounted_on":"/run/user/1000","name":"tmpfs"}],"memory":{"swap_total":"1003516kB","total":"7973944kB"},"network":{"interfaces":[{"ipv4":"10.0.2.15","ipv4-network":"10.0.2.0/24","ipv6":"fe80::a00:27ff:fec2:be11","ipv6-network":"fe80::/64","macaddress":"08:00:27:c2:be:11","name":"eth0"},{"ipv4":"192.168.122.1","ipv4-network":"192.168.122.0/24","macaddress":"52:54:00:6f:1c:bf","name":"virbr0"}],"ipaddress":"10.0.2.15","ipaddressv6":"fe80::a00:27ff:fec2:be11","macaddress":"08:00:27:c2:be:11"},"platform":{"GOOARCH":"amd64","GOOS":"linux","goV":"1.16.7","hardware_platform":"x86_64","hostname":"vagrant","kernel_name":"Linux","kernel_release":"4.15.0-29-generic","kernel_version":"#31-Ubuntu SMP Tue Jul 17 15:39:52 UTC 2018","machine":"x86_64","os":"GNU/Linux","processor":"x86_64","pythonV":"2.7.15rc1"}}' type: string install_method: $ref: "#/components/schemas/HostMetaInstallMethod" macV: description: An array of Mac versions. items: description: Version name. example: "Mac" type: array machine: description: The machine architecture. example: "amd64" type: string nixV: description: Array of Unix versions. items: description: Version name. example: "Ubuntu" type: array platform: description: The OS platform. example: "linux" type: string processor: description: The processor. example: "Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz" type: string pythonV: description: The Python version. example: "3.8.11" type: string socket-fqdn: description: The socket fqdn. example: "vagrant.vm." type: string socket-hostname: description: The socket hostname. example: "vagrant" type: string winV: description: An array of Windows versions. items: description: Version name. example: "Windows" type: array type: object HostMetaInstallMethod: description: Agent install method. properties: installer_version: description: The installer version. example: "install_script-1.7.1" type: string tool: description: Tool used to install the agent. example: "install_script" type: string tool_version: description: The tool version. example: "install_script" type: string type: object HostMetrics: description: Host Metrics collected. properties: cpu: description: The percent of CPU used (everything but idle). example: 99.0 format: double type: number iowait: description: The percent of CPU spent waiting on the IO (not reported for all platforms). example: 3.2 format: double type: number load: description: The system load over the last 15 minutes. example: 0.5 format: double type: number type: object HostMuteResponse: description: Response with the list of muted host for your organization. properties: action: description: Action applied to the hosts. example: "Muted" type: string end: description: POSIX timestamp in seconds when the host is unmuted. example: 1579098130 format: int64 type: integer hostname: description: The host name. example: "test.host" type: string message: description: Message associated with the mute. example: "Muting this host for a test!" type: string type: object HostMuteSettings: description: Combination of settings to mute a host. properties: end: description: POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. example: 1579098130 format: int64 type: integer message: description: Message to associate with the muting of this host. example: "Muting this host for a test!" type: string override: description: If true and the host is already muted, replaces existing host mute settings. example: false type: boolean type: object HostTags: description: Host name and an array of its tags properties: host: description: Your host name. example: "test.host" type: string tags: description: A list of tags associated with a host. items: description: A given tag in a list. example: "environment:production" type: string type: array type: object HostTotals: description: Total number of host currently monitored by Datadog. properties: total_active: description: Total number of active host (UP and ???) reporting to Datadog. format: int64 type: integer total_up: description: Number of host that are UP and reporting to Datadog. format: int64 type: integer type: object HourlyUsageAttributionBody: description: The usage for one set of tags for one hour. properties: hour: description: The hour for the usage. format: date-time type: string org_name: description: The name of the organization. type: string public_id: description: The organization public ID. type: string region: description: The region of the Datadog instance that the organization belongs to. type: string tag_config_source: description: The source of the usage attribution tag configuration and the selected tags in the format of `::://////`. type: string tags: $ref: "#/components/schemas/UsageAttributionTagNames" total_usage_sum: description: Total product usage for the given tags within the hour. format: double type: number updated_at: description: Shows the most recent hour in the current month for all organizations where usages are calculated. type: string usage_type: $ref: "#/components/schemas/HourlyUsageAttributionUsageType" type: object HourlyUsageAttributionMetadata: description: The object containing document metadata. properties: pagination: $ref: "#/components/schemas/HourlyUsageAttributionPagination" type: object HourlyUsageAttributionPagination: 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 type: object HourlyUsageAttributionResponse: description: Response containing the hourly usage attribution by tag(s). properties: metadata: $ref: "#/components/schemas/HourlyUsageAttributionMetadata" usage: description: Get the hourly usage attribution by tag(s). items: $ref: "#/components/schemas/HourlyUsageAttributionBody" type: array type: object HourlyUsageAttributionUsageType: description: |- Supported products for hourly usage attribution requests. Usage types are in the format `_usage`. To obtain the complete list of valid usage types, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). enum: - api_usage - apm_fargate_usage - apm_host_usage - apm_usm_usage - appsec_fargate_usage - appsec_usage - asm_serverless_traced_invocations_usage - asm_serverless_traced_invocations_percentage - bits_ai_investigations_usage - browser_usage - ci_code_coverage_committers_percentage - ci_code_coverage_committers_usage - ci_pipeline_indexed_spans_usage - ci_test_indexed_spans_usage - ci_visibility_itr_usage - cloud_siem_usage - code_security_host_usage - container_excl_agent_usage - container_usage - cspm_containers_usage - cspm_hosts_usage - custom_event_usage - custom_ingested_timeseries_usage - custom_timeseries_usage - cws_containers_usage - cws_fargate_task_usage - cws_hosts_usage - data_jobs_monitoring_usage - data_stream_monitoring_usage - dbm_hosts_usage - dbm_queries_usage - error_tracking_usage - error_tracking_percentage - estimated_indexed_spans_usage - estimated_ingested_spans_usage - fargate_usage - flex_logs_starter - flex_stored_logs - functions_usage - incident_management_monthly_active_users_usage - indexed_spans_usage - infra_host_usage - infra_host_basic_usage - ingested_logs_bytes_usage - ingested_spans_bytes_usage - invocations_usage - lambda_traced_invocations_usage - llm_observability_usage - llm_spans_usage - logs_indexed_15day_usage - logs_indexed_180day_usage - logs_indexed_1day_usage - logs_indexed_30day_usage - logs_indexed_360day_usage - logs_indexed_3day_usage - logs_indexed_45day_usage - logs_indexed_60day_usage - logs_indexed_7day_usage - logs_indexed_90day_usage - logs_indexed_custom_retention_usage - mobile_app_testing_usage - ndm_netflow_usage - npm_host_usage - network_device_wireless_usage - obs_pipeline_bytes_usage - obs_pipelines_vcpu_usage - online_archive_usage - product_analytics_session_usage - profiled_container_usage - profiled_fargate_usage - profiled_host_usage - published_app - rum_browser_mobile_sessions_usage - rum_ingested_usage - rum_investigate_usage - rum_replay_sessions_usage - rum_session_replay_add_on_usage - sca_fargate_usage - sds_scanned_bytes_usage - serverless_apps_usage - serverless_apps_apm_usage - siem_12mo_retention_usage - siem_6mo_retention_usage - siem_analyzed_logs_add_on_usage - siem_ingested_bytes_usage - snmp_usage - universal_service_monitoring_usage - vuln_management_hosts_usage - workflow_executions_usage type: string x-enum-varnames: - API_USAGE - APM_FARGATE_USAGE - APM_HOST_USAGE - APM_USM_USAGE - APPSEC_FARGATE_USAGE - APPSEC_USAGE - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE - BITS_AI_INVESTIGATIONS_USAGE - BROWSER_USAGE - CI_CODE_COVERAGE_COMMITTERS_PERCENTAGE - CI_CODE_COVERAGE_COMMITTERS_USAGE - CI_PIPELINE_INDEXED_SPANS_USAGE - CI_TEST_INDEXED_SPANS_USAGE - CI_VISIBILITY_ITR_USAGE - CLOUD_SIEM_USAGE - CODE_SECURITY_HOST_USAGE - CONTAINER_EXCL_AGENT_USAGE - CONTAINER_USAGE - CSPM_CONTAINERS_USAGE - CSPM_HOSTS_USAGE - CUSTOM_EVENT_USAGE - CUSTOM_INGESTED_TIMESERIES_USAGE - CUSTOM_TIMESERIES_USAGE - CWS_CONTAINERS_USAGE - CWS_FARGATE_TASK_USAGE - CWS_HOSTS_USAGE - DATA_JOBS_MONITORING_USAGE - DATA_STREAM_MONITORING_USAGE - DBM_HOSTS_USAGE - DBM_QUERIES_USAGE - ERROR_TRACKING_USAGE - ERROR_TRACKING_PERCENTAGE - ESTIMATED_INDEXED_SPANS_USAGE - ESTIMATED_INGESTED_SPANS_USAGE - FARGATE_USAGE - FLEX_LOGS_STARTER - FLEX_STORED_LOGS - FUNCTIONS_USAGE - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE - INDEXED_SPANS_USAGE - INFRA_HOST_USAGE - INFRA_HOST_BASIC_USAGE - INGESTED_LOGS_BYTES_USAGE - INGESTED_SPANS_BYTES_USAGE - INVOCATIONS_USAGE - LAMBDA_TRACED_INVOCATIONS_USAGE - LLM_OBSERVABILITY_USAGE - LLM_SPANS_USAGE - LOGS_INDEXED_15DAY_USAGE - LOGS_INDEXED_180DAY_USAGE - LOGS_INDEXED_1DAY_USAGE - LOGS_INDEXED_30DAY_USAGE - LOGS_INDEXED_360DAY_USAGE - LOGS_INDEXED_3DAY_USAGE - LOGS_INDEXED_45DAY_USAGE - LOGS_INDEXED_60DAY_USAGE - LOGS_INDEXED_7DAY_USAGE - LOGS_INDEXED_90DAY_USAGE - LOGS_INDEXED_CUSTOM_RETENTION_USAGE - MOBILE_APP_TESTING_USAGE - NDM_NETFLOW_USAGE - NETWORK_DEVICE_WIRELESS_USAGE - NPM_HOST_USAGE - OBS_PIPELINE_BYTES_USAGE - OBS_PIPELINE_VCPU_USAGE - ONLINE_ARCHIVE_USAGE - PRODUCT_ANALYTICS_SESSION_USAGE - PROFILED_CONTAINER_USAGE - PROFILED_FARGATE_USAGE - PROFILED_HOST_USAGE - PUBLISHED_APP_USAGE - RUM_BROWSER_MOBILE_SESSIONS_USAGE - RUM_INGESTED_USAGE - RUM_INVESTIGATE_USAGE - RUM_REPLAY_SESSIONS_USAGE - RUM_SESSION_REPLAY_ADD_ON_USAGE - SCA_FARGATE_USAGE - SDS_SCANNED_BYTES_USAGE - SERVERLESS_APPS_USAGE - SERVERLESS_APPS_APM_USAGE - SIEM_12MO_RETENTION_USAGE - SIEM_6MO_RETENTION_USAGE - SIEM_ANALYZED_LOGS_ADD_ON_USAGE - SIEM_INGESTED_BYTES_USAGE - SNMP_USAGE - UNIVERSAL_SERVICE_MONITORING_USAGE - VULN_MANAGEMENT_HOSTS_USAGE - WORKFLOW_EXECUTIONS_USAGE IFrameWidgetDefinition: description: The iframe widget allows you to embed a portion of any other web page on your dashboard. properties: type: $ref: "#/components/schemas/IFrameWidgetDefinitionType" url: description: URL of the iframe. example: "" type: string required: - type - url type: object IFrameWidgetDefinitionType: default: iframe description: Type of the iframe widget. enum: - iframe example: iframe type: string x-enum-varnames: - IFRAME IPPrefixesAPI: description: Available prefix information for the API endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesAPM: description: Available prefix information for the APM endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesAgents: description: Available prefix information for the Agent endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesGlobal: description: Available prefix information for all Datadog endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesLogs: description: Available prefix information for the Logs endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesOrchestrator: description: Available prefix information for the Orchestrator endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesProcess: description: Available prefix information for the Process endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesRemoteConfiguration: description: Available prefix information for the Remote Configuration endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesSynthetics: description: Available prefix information for the Synthetics endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv4_by_location: additionalProperties: description: List of IPv4 prefixes. items: description: IPv4 prefix. type: string type: array description: List of IPv4 prefixes by location. type: object prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array prefixes_ipv6_by_location: additionalProperties: description: List of IPv6 prefixes. items: description: IPv6 prefix. type: string type: array description: List of IPv6 prefixes by location. type: object type: object IPPrefixesSyntheticsPrivateLocations: description: Available prefix information for the Synthetics Private Locations endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPPrefixesWebhooks: description: Available prefix information for the Webhook endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. items: description: IPv4 prefix type: string type: array prefixes_ipv6: description: List of IPv6 prefixes. items: description: IPv6 prefix type: string type: array type: object IPRanges: description: IP ranges. properties: agents: $ref: "#/components/schemas/IPPrefixesAgents" api: $ref: "#/components/schemas/IPPrefixesAPI" apm: $ref: "#/components/schemas/IPPrefixesAPM" global: $ref: "#/components/schemas/IPPrefixesGlobal" logs: $ref: "#/components/schemas/IPPrefixesLogs" modified: description: Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. example: 2019-10-31-20-00-00 type: string orchestrator: $ref: "#/components/schemas/IPPrefixesOrchestrator" process: $ref: "#/components/schemas/IPPrefixesProcess" remote-configuration: $ref: "#/components/schemas/IPPrefixesRemoteConfiguration" synthetics: $ref: "#/components/schemas/IPPrefixesSynthetics" synthetics-private-locations: $ref: "#/components/schemas/IPPrefixesSyntheticsPrivateLocations" version: description: Version of the IP list. example: 11 format: int64 type: integer webhooks: $ref: "#/components/schemas/IPPrefixesWebhooks" type: object IdpFormData: description: Object describing the IdP configuration. properties: idp_file: description: The path to the XML metadata file you wish to upload. example: "" format: binary type: string required: - idp_file type: object IdpResponse: description: The IdP response object. properties: message: description: Identity provider response. example: "IdP metadata successfully uploaded for example org" type: string required: - message type: object ImageWidgetDefinition: description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. properties: has_background: default: true description: Whether to display a background or not. example: true type: boolean has_border: default: true description: Whether to display a border or not. example: true type: boolean horizontal_align: $ref: "#/components/schemas/WidgetHorizontalAlign" margin: $ref: "#/components/schemas/WidgetMargin" sizing: $ref: "#/components/schemas/WidgetImageSizing" type: $ref: "#/components/schemas/ImageWidgetDefinitionType" url: description: URL of the image. example: "https://example.com/image.png" type: string url_dark_theme: description: URL of the image in dark mode. example: "https://example.com/image-dark-mode.png" type: string vertical_align: $ref: "#/components/schemas/WidgetVerticalAlign" required: - type - url type: object ImageWidgetDefinitionType: default: image description: Type of the image widget. enum: - image example: image type: string x-enum-varnames: - IMAGE IntakePayloadAccepted: description: The payload accepted for intake. properties: status: description: The status of the intake payload. example: ok type: string type: object ListStreamColumn: description: Widget column. example: {"field": "timestamp", "width": "auto"} properties: field: description: Widget column field. example: "content" type: string width: $ref: "#/components/schemas/ListStreamColumnWidth" required: - width - field type: object ListStreamColumnWidth: description: Widget column width. enum: - auto - compact - full example: compact type: string x-enum-varnames: - AUTO - COMPACT - FULL ListStreamComputeAggregation: description: Aggregation value. enum: - count - cardinality - median - pc75 - pc90 - pc95 - pc98 - pc99 - sum - min - max - avg - earliest - latest - most_frequent example: count type: string x-enum-varnames: - COUNT - CARDINALITY - MEDIAN - PC75 - PC90 - PC95 - PC98 - PC99 - SUM - MIN - MAX - AVG - EARLIEST - LATEST - MOST_FREQUENT ListStreamComputeItems: description: List of facets and aggregations which to compute. properties: aggregation: $ref: "#/components/schemas/ListStreamComputeAggregation" facet: description: Facet name. example: resource_name type: string required: - aggregation type: object ListStreamGroupByItems: description: List of facets on which to group. properties: facet: description: Facet name. example: resource_name type: string required: - facet type: object ListStreamIssuePersona: description: Persona filter for the `issue_stream` data source. enum: - all - browser - mobile - backend type: string x-enum-varnames: - ALL - BROWSER - MOBILE - BACKEND ListStreamIssueState: description: Issue state filter for the `issue_stream` data source. enum: - OPEN - IGNORED - ACKNOWLEDGED - RESOLVED type: string x-enum-varnames: - OPEN - IGNORED - ACKNOWLEDGED - RESOLVED ListStreamQuery: description: Updated list stream widget. properties: assignee_uuids: description: Filter by assignee UUIDs. Usable only with `issue_stream`. items: description: Assignee UUID. type: string type: array clustering_pattern_field_path: description: Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. example: "message" type: string compute: description: Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source. items: $ref: "#/components/schemas/ListStreamComputeItems" maxItems: 5 minItems: 1 type: array data_source: $ref: "#/components/schemas/ListStreamSource" event_size: $ref: "#/components/schemas/WidgetEventSize" group_by: description: Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source. items: $ref: "#/components/schemas/ListStreamGroupByItems" maxItems: 4 type: array indexes: description: List of indexes. items: description: Index. type: string type: array persona: $ref: "#/components/schemas/ListStreamIssuePersona" query_string: description: Widget query. example: "@service:app" type: string sort: $ref: "#/components/schemas/WidgetFieldSort" states: description: Filter by issue states. Usable only with `issue_stream`. items: $ref: "#/components/schemas/ListStreamIssueState" type: array storage: description: Option for storage location. Feature in Private Beta. example: "indexes" type: string suspected_causes: description: Filter by suspected causes. Usable only with `issue_stream`. items: description: Suspected cause. type: string type: array team_handles: description: Filter by team handles. Usable only with `issue_stream`. items: description: Team handle. type: string type: array required: - query_string - data_source type: object ListStreamResponseFormat: description: Widget response format. enum: - event_list example: event_list type: string x-enum-varnames: - EVENT_LIST ListStreamSource: default: logs_stream description: Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. enum: - logs_stream - audit_stream - ci_pipeline_stream - ci_test_stream - rum_issue_stream - apm_issue_stream - trace_stream - logs_issue_stream - logs_pattern_stream - logs_transaction_stream - event_stream - rum_stream - llm_observability_stream - issue_stream example: logs_stream type: string x-enum-varnames: - LOGS_STREAM - AUDIT_STREAM - CI_PIPELINE_STREAM - CI_TEST_STREAM - RUM_ISSUE_STREAM - APM_ISSUE_STREAM - TRACE_STREAM - LOGS_ISSUE_STREAM - LOGS_PATTERN_STREAM - LOGS_TRANSACTION_STREAM - EVENT_STREAM - RUM_STREAM - LLM_OBSERVABILITY_STREAM - ISSUE_STREAM ListStreamWidgetDefinition: description: |- The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. properties: description: description: The description of the widget. type: string legend_size: $ref: "#/components/schemas/WidgetLegendSize" requests: description: Request payload used to query items. example: [{"columns": [{"field": "timestamp", "width": "auto"}], "query": {"data_source": "apm_issue_stream", "query_string": "@data_source:APM"}, "response_format": "event_list"}] items: $ref: "#/components/schemas/ListStreamWidgetRequest" maxItems: 1 minItems: 1 type: array show_legend: description: Whether or not to display the legend on this widget. type: boolean time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/ListStreamWidgetDefinitionType" required: - type - requests type: object ListStreamWidgetDefinitionType: default: list_stream description: Type of the list stream widget. enum: - list_stream example: list_stream type: string x-enum-varnames: - LIST_STREAM ListStreamWidgetRequest: description: Updated list stream widget. properties: columns: description: Widget columns. example: [{"field": "timestamp", "width": "auto"}, {"field": "content", "width": "full"}] items: $ref: "#/components/schemas/ListStreamColumn" type: array query: $ref: "#/components/schemas/ListStreamQuery" response_format: $ref: "#/components/schemas/ListStreamResponseFormat" required: - columns - query - response_format type: object Log: description: Object describing a log after being processed and stored by Datadog. properties: content: $ref: "#/components/schemas/LogContent" id: description: ID of the Log. example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: object LogContent: description: JSON object containing all log attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from your log. example: {"customAttribute": 123, "duration": 2345} type: object host: description: |- Name of the machine from where the logs are being sent. example: i-0123 type: string message: description: |- The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. example: Host connected to remote type: string service: description: |- The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. example: agent type: string tags: description: Array of tags associated with your log. example: ["team:A"] items: description: Tag associated with your log. type: string type: array timestamp: description: Timestamp of your log. example: "2020-05-26T13:36:14Z" format: date-time type: string type: object LogQueryDefinition: description: The log query. properties: compute: $ref: "#/components/schemas/LogsQueryCompute" group_by: description: List of tag prefixes to group by in the case of a cluster check. items: $ref: "#/components/schemas/LogQueryDefinitionGroupBy" type: array index: description: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) example: "days-3,days-7" type: string multi_compute: description: This field is mutually exclusive with `compute`. items: $ref: "#/components/schemas/LogsQueryCompute" type: array search: $ref: "#/components/schemas/LogQueryDefinitionSearch" type: object LogQueryDefinitionGroupBy: description: Defined items in the group. properties: facet: description: Facet name. example: resource_name type: string limit: description: Maximum number of items in the group. example: 50 format: int64 type: integer sort: $ref: "#/components/schemas/LogQueryDefinitionGroupBySort" required: - facet type: object LogQueryDefinitionGroupBySort: description: Define a sorting method. properties: aggregation: description: The aggregation method. example: avg type: string facet: description: Facet name. example: "@string_query.interval" type: string order: $ref: "#/components/schemas/WidgetSort" required: - aggregation - order type: object LogQueryDefinitionSearch: description: The query being made on the logs. properties: query: description: Search value to apply. example: "" type: string required: - query type: object LogStreamWidgetDefinition: description: The Log Stream displays a log flow matching the defined query. properties: columns: description: Which columns to display on the widget. items: description: Column name. type: string type: array description: description: The description of the widget. type: string indexes: description: An array of index names to query in the stream. Use [] to query all indexes at once. example: ["days-3", "days-7"] items: description: One of the log indexes set up for your organization. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) type: string type: array logset: deprecated: true description: ID of the log set to use. type: string message_display: $ref: "#/components/schemas/WidgetMessageDisplay" query: description: Query to filter the log stream with. type: string show_date_column: description: Whether to show the date column or not type: boolean show_message_column: description: Whether to show the message column or not type: boolean sort: $ref: "#/components/schemas/WidgetFieldSort" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/LogStreamWidgetDefinitionType" required: - type type: object LogStreamWidgetDefinitionType: default: log_stream description: Type of the log stream widget. enum: - log_stream example: log_stream type: string x-enum-varnames: - LOG_STREAM LogsAPIError: description: Error returned by the Logs API properties: code: description: Code identifying the error type: string details: description: Additional error details items: $ref: "#/components/schemas/LogsAPIError" type: array message: description: Error message type: string type: object LogsAPIErrorResponse: description: Response returned by the Logs API when errors occur. properties: error: $ref: "#/components/schemas/LogsAPIError" type: object LogsAPILimitReachedResponse: description: Response returned by the Logs API when the max limit has been reached. properties: error: $ref: "#/components/schemas/LogsAPIError" type: object LogsArithmeticProcessor: description: |- Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators `-`, `+`, `*`, `/`. By default, the calculation is skipped if an attribute is missing. Select “Replace missing attribute by 0” to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. *Notes*: - The operator `-` needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is `0.1234567891`, the actual value stored for the attribute is `0.123456789`. - If you need to scale a unit of measure, see [Scale Filter](https://docs.datadoghq.com/logs/log_configuration/parsing/?tab=filter#matcher-and-filter). properties: expression: description: Arithmetic operation between one or more log attributes. example: "" type: string is_enabled: default: false description: Whether or not the processor is enabled. type: boolean is_replace_missing: default: false description: |- If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. type: boolean name: description: Name of the processor. type: string target: description: Name of the attribute that contains the result of the arithmetic operation. example: "" type: string type: $ref: "#/components/schemas/LogsArithmeticProcessorType" required: - target - expression - type type: object LogsArithmeticProcessorType: default: arithmetic-processor description: Type of logs arithmetic processor. enum: - arithmetic-processor example: arithmetic-processor type: string x-enum-varnames: - ARITHMETIC_PROCESSOR LogsArrayProcessor: description: |- A processor for extracting, aggregating, or transforming values from JSON arrays within your logs. Supported operations are: - Select value from matching element - Compute array length - Append a value to an array properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string operation: $ref: "#/components/schemas/LogsArrayProcessorOperation" type: $ref: "#/components/schemas/LogsArrayProcessorType" required: - operation - type type: object LogsArrayProcessorOperation: description: Configuration of the array processor operation to perform. oneOf: - $ref: "#/components/schemas/LogsArrayProcessorOperationAppend" - $ref: "#/components/schemas/LogsArrayProcessorOperationLength" - $ref: "#/components/schemas/LogsArrayProcessorOperationSelect" LogsArrayProcessorOperationAppend: description: Operation that appends a value to a target array attribute. properties: preserve_source: default: true description: Remove or preserve the remapped source element. type: boolean source: description: Attribute path containing the value to append. example: network.client.ip type: string target: description: Attribute path of the array to append to. example: sourceIps type: string type: $ref: "#/components/schemas/LogsArrayProcessorOperationAppendType" required: - type - source - target type: object LogsArrayProcessorOperationAppendType: description: Operation type. enum: [append] example: append type: string x-enum-varnames: - APPEND LogsArrayProcessorOperationLength: description: Operation that computes the length of a `source` array and stores the result in the `target` attribute. properties: source: description: Attribute path of the array to measure. example: tags type: string target: description: Attribute that receives the computed length. example: tagCount type: string type: $ref: "#/components/schemas/LogsArrayProcessorOperationLengthType" required: - type - source - target type: object LogsArrayProcessorOperationLengthType: description: Operation type. enum: [length] example: length type: string x-enum-varnames: - LENGTH LogsArrayProcessorOperationSelect: description: Operation that finds an object in a `source` array using a `filter`, and then extracts a specific value into the `target` attribute. properties: filter: description: Filter condition expressed as `key:value` used to find the matching element. example: name:Referrer type: string source: description: Attribute path of the array to search into. example: httpRequest.headers type: string target: description: Attribute that receives the extracted value. example: referrer type: string type: $ref: "#/components/schemas/LogsArrayProcessorOperationSelectType" value_to_extract: description: Key of the value to extract from the matching element. example: value type: string required: - type - source - target - filter - value_to_extract type: object LogsArrayProcessorOperationSelectType: description: Operation type. enum: [select] example: select type: string x-enum-varnames: - SELECT LogsArrayProcessorType: default: array-processor description: Type of logs array processor. enum: - array-processor example: array-processor type: string x-enum-varnames: - ARRAY_PROCESSOR LogsAttributeRemapper: description: |- The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the [Tag Best Practice documentation](https://docs.datadoghq.com/logs/guide/log-parsing-best-practice). Some additional constraints are applied as `:` or `,` are not allowed in the target tag/attribute name. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string override_on_conflict: default: false description: Override or not the target element if already set, type: boolean preserve_source: default: false description: Remove or preserve the remapped source element. type: boolean source_type: default: attribute description: Defines if the sources are from log `attribute` or `tag`. type: string sources: description: Array of source attributes. example: ["web", "gateway"] items: description: Attribute used as a source to remap its value to the target attribute. type: string type: array target: description: Final attribute or tag name to remap the sources to. example: operation_id type: string target_format: $ref: "#/components/schemas/TargetFormatType" target_type: default: attribute description: Defines if the final attribute or tag name is from log `attribute` or `tag`. type: string type: $ref: "#/components/schemas/LogsAttributeRemapperType" required: - sources - target - type type: object LogsAttributeRemapperType: default: attribute-remapper description: Type of logs attribute remapper. enum: - attribute-remapper example: attribute-remapper type: string x-enum-varnames: - ATTRIBUTE_REMAPPER LogsByRetention: description: Object containing logs usage data broken down by retention period. properties: orgs: $ref: "#/components/schemas/LogsByRetentionOrgs" usage: description: Aggregated index logs usage for each retention period with usage. items: $ref: "#/components/schemas/LogsRetentionAggSumUsage" type: array usage_by_month: $ref: "#/components/schemas/LogsByRetentionMonthlyUsage" type: object LogsByRetentionMonthlyUsage: description: Object containing a summary of indexed logs usage by retention period for a single month. properties: date: description: The month for the usage. format: date-time type: string usage: description: Indexed logs usage for each active retention for the month. items: $ref: "#/components/schemas/LogsRetentionSumUsage" type: array type: object LogsByRetentionOrgUsage: description: Indexed logs usage by retention for a single organization. properties: usage: description: Indexed logs usage for each active retention for the organization. items: $ref: "#/components/schemas/LogsRetentionSumUsage" type: array type: object LogsByRetentionOrgs: description: Indexed logs usage summary for each organization for each retention period with usage. properties: usage: description: Indexed logs usage summary for each organization. items: $ref: "#/components/schemas/LogsByRetentionOrgUsage" type: array type: object LogsCategoryProcessor: description: |- Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. **Notes**: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper. properties: categories: description: |- Array of filters to match or not a log and their corresponding `name` to assign a custom value to the log. example: [] items: $ref: "#/components/schemas/LogsCategoryProcessorCategory" type: array is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string target: description: Name of the target attribute which value is defined by the matching category. example: "" type: string type: $ref: "#/components/schemas/LogsCategoryProcessorType" required: - categories - target - type type: object LogsCategoryProcessorCategory: description: Object describing the logs filter. properties: filter: $ref: "#/components/schemas/LogsFilter" name: description: Value to assign to the target attribute. type: string type: object LogsCategoryProcessorType: default: category-processor description: Type of logs category processor. enum: - category-processor example: category-processor type: string x-enum-varnames: - CATEGORY_PROCESSOR LogsDailyLimitReset: description: Object containing options to override the default daily limit reset time. properties: reset_time: description: String in `HH:00` format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive). example: "14:00" type: string reset_utc_offset: description: String in `(-|+)HH:00` format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive). example: "+02:00" type: string type: object LogsDateRemapper: description: |- As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - `timestamp` - `date` - `_timestamp` - `Timestamp` - `eventTime` - `published_date` If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. **Note:** If your logs don’t contain any of the default attributes and you haven’t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: description: Array of source attributes. example: ["web", "gateway"] items: description: Attribute used as a source to define the log associated date. type: string type: array type: $ref: "#/components/schemas/LogsDateRemapperType" required: - sources - type type: object LogsDateRemapperType: default: date-remapper description: Type of logs date remapper. enum: - date-remapper example: date-remapper type: string x-enum-varnames: - DATE_REMAPPER LogsDecoderProcessor: description: |- The decoder processor decodes any source attribute containing a base64/base16-encoded UTF-8/ASCII string back to its original value, storing the result in a target attribute. properties: binary_to_text_encoding: $ref: "#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding" input_representation: $ref: "#/components/schemas/LogsDecoderProcessorInputRepresentation" is_enabled: default: false description: Whether the processor is enabled. type: boolean name: description: Name of the processor. type: string source: description: Name of the log attribute with the encoded data. example: encoded.field type: string target: description: Name of the log attribute that contains the decoded data. example: decoded.field type: string type: $ref: "#/components/schemas/LogsDecoderProcessorType" required: - source - target - binary_to_text_encoding - input_representation - type type: object LogsDecoderProcessorBinaryToTextEncoding: description: The encoding used to represent the binary data. enum: - base64 - base16 example: base64 type: string x-enum-varnames: - BASE64 - BASE16 LogsDecoderProcessorInputRepresentation: description: The original representation of input string. enum: - utf_8 - integer example: utf_8 type: string x-enum-varnames: - UTF_8 - INTEGER LogsDecoderProcessorType: default: decoder-processor description: Type of logs decoder processor. enum: - decoder-processor example: decoder-processor type: string x-enum-varnames: - DECODER_PROCESSOR LogsExcludeAttributeProcessor: description: |- Use this processor to remove an attribute from a log during processing. The processor strips the specified attribute from the log event, which is useful when the attribute contains sensitive data or is no longer needed downstream. properties: attribute_to_exclude: description: Name of the log attribute to remove from the log event. example: foo type: string is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string type: $ref: "#/components/schemas/LogsExcludeAttributeProcessorType" required: - type - attribute_to_exclude type: object LogsExcludeAttributeProcessorType: default: exclude-attribute description: Type of logs exclude attribute processor. enum: - exclude-attribute example: exclude-attribute type: string x-enum-varnames: - EXCLUDE_ATTRIBUTE LogsExclusion: description: Represents the index exclusion filter object from configuration API. properties: filter: $ref: "#/components/schemas/LogsExclusionFilter" is_enabled: description: Whether or not the exclusion filter is active. type: boolean name: description: Name of the index exclusion filter. example: payment type: string required: - name type: object LogsExclusionFilter: description: Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle. properties: query: description: |- Default query is `*`, meaning all logs flowing in the index would be excluded. Scope down exclusion filter to only a subset of logs with a log query. example: "*" type: string sample_attribute: description: |- Sample attribute to use for the sampling of logs going through this exclusion filter. When set, only the logs with the specified attribute are sampled. example: "@ci.job_id" type: string sample_rate: description: |- Sample rate to apply to logs going through this exclusion filter, a value of 1.0 excludes all logs matching the query. example: 1.0 format: double type: number required: - sample_rate type: object LogsFilter: description: Filter for logs. properties: query: description: The filter query. example: source:python type: string type: object LogsGeoIPParser: description: |- The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: default: ["network.client.ip"] description: Array of source attributes. example: ["network.client.ip"] items: description: Attribute to geo-localize the IP from. type: string type: array target: default: network.client.geoip description: Name of the parent attribute that contains all the extracted details from the `sources`. example: network.client.geoip type: string type: $ref: "#/components/schemas/LogsGeoIPParserType" required: - sources - target - type type: object LogsGeoIPParserType: default: geo-ip-parser description: Type of GeoIP parser. enum: - geo-ip-parser example: geo-ip-parser type: string x-enum-varnames: - GEO_IP_PARSER LogsGrokParser: description: |- Create custom grok rules to parse the full message or [a specific attribute of your raw event](https://docs.datadoghq.com/logs/log_configuration/parsing/#advanced-settings). For more information, see the [parsing section](https://docs.datadoghq.com/logs/log_configuration/parsing). properties: grok: $ref: "#/components/schemas/LogsGrokParserRules" is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string samples: description: List of sample logs to test this grok parser. items: description: A log sample that is used to test the grok parser. maxLength: 5000 type: string maxItems: 5 type: array source: default: message description: Name of the log attribute to parse. example: message type: string type: $ref: "#/components/schemas/LogsGrokParserType" required: - source - grok - type type: object LogsGrokParserRules: description: Set of rules for the grok parser. properties: match_rules: description: List of match rules for the grok parser, separated by a new line. example: |- rule_name_1 foo rule_name_2 bar type: string support_rules: default: "" description: List of support rules for the grok parser, separated by a new line. example: |- rule_name_1 foo rule_name_2 bar type: string required: - match_rules type: object LogsGrokParserType: default: grok-parser description: Type of logs grok parser. enum: - grok-parser example: grok-parser type: string x-enum-varnames: - GROK_PARSER LogsIndex: description: Object describing a Datadog Log index. properties: daily_limit: description: The number of log events you can send in this index per day before you are rate-limited. example: 300000000 format: int64 type: integer daily_limit_reset: $ref: "#/components/schemas/LogsDailyLimitReset" daily_limit_warning_threshold_percentage: description: A percentage threshold of the daily quota at which a Datadog warning event is generated. example: 70 format: double maximum: 99.99 minimum: 50 type: number exclusion_filters: description: |- An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. items: $ref: "#/components/schemas/LogsExclusion" type: array filter: $ref: "#/components/schemas/LogsFilter" is_rate_limited: description: |- A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC. example: false readOnly: true type: boolean name: description: The name of the index. example: "main" type: string num_flex_logs_retention_days: description: |- The total number of days logs are stored in Standard and Flex Tier before being deleted from the index. If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through `num_retention_days`, and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` is reached. The available values depend on retention plans specified in your organization's contract/subscriptions. example: 360 format: int64 type: integer num_retention_days: description: |- The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index. The available values depend on retention plans specified in your organization's contract/subscriptions. example: 15 format: int64 type: integer tags: description: A list of tags associated with the index. Tags must be in `key:value` format. example: ["team:backend", "env:production"] items: description: A single tag using the format `key:value`. type: string type: array required: - name - filter type: object LogsIndexListResponse: description: Object with all Index configurations for a given organization. properties: indexes: description: Array of Log index configurations. items: $ref: "#/components/schemas/LogsIndex" type: array type: object LogsIndexUpdateRequest: description: Object for updating a Datadog Log index. properties: daily_limit: description: The number of log events you can send in this index per day before you are rate-limited. example: 300000000 format: int64 type: integer daily_limit_reset: $ref: "#/components/schemas/LogsDailyLimitReset" daily_limit_warning_threshold_percentage: description: A percentage threshold of the daily quota at which a Datadog warning event is generated. example: 70 format: double maximum: 99.99 minimum: 50 type: number disable_daily_limit: description: |- If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any specified `daily_limit` value in the request is ignored). If false or omitted, the index's current `daily_limit` is maintained. example: false type: boolean exclusion_filters: description: |- An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. items: $ref: "#/components/schemas/LogsExclusion" type: array filter: $ref: "#/components/schemas/LogsFilter" num_flex_logs_retention_days: description: |- The total number of days logs are stored in Standard and Flex Tier before being deleted from the index. If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through `num_retention_days`, and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` is reached. The available values depend on retention plans specified in your organization's contract/subscriptions. **Note**: Changing this value affects all logs already in this index. It may also affect billing. example: 360 format: int64 type: integer num_retention_days: description: |- The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index. The available values depend on retention plans specified in your organization's contract/subscriptions. **Note**: Changing this value affects all logs already in this index. It may also affect billing. example: 15 format: int64 type: integer tags: description: A list of tags associated with the index. Tags must be in `key:value` format. example: ["team:backend", "env:production"] items: description: A single tag using the format `key:value`. type: string type: array required: - filter type: object LogsIndexesOrder: description: Object containing the ordered list of log index names. properties: index_names: description: |- Array of strings identifying by their name(s) the index(es) of your organization. Logs are tested against the query filter of each index one by one, following the order of the array. Logs are eventually stored in the first matching index. example: ["main", "payments", "web"] items: description: An index name. type: string type: array required: - index_names type: object LogsListRequest: description: Object to send with the request to retrieve a list of logs from your Organization. properties: index: description: |- The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified. example: "retention-3,retention-15" type: string limit: description: Number of logs return in the response. format: int32 maximum: 1000 type: integer query: description: The search query - following the log search syntax. example: "service:web* AND @http.status_code:[200 TO 299]" type: string sort: $ref: "#/components/schemas/LogsSort" startAt: description: |- Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. **Note**: This parameter is ignored if the corresponding log is out of the scope of the specified time window. type: string time: $ref: "#/components/schemas/LogsListRequestTime" required: - time type: object LogsListRequestTime: description: Timeframe to retrieve the log from. properties: from: description: Minimum timestamp for requested logs. example: "2020-02-02T02:02:02.202Z" format: date-time type: string timezone: description: |- Timezone can be specified both as an offset (for example "UTC+03:00") or a regional zone (for example "Europe/Paris"). type: string to: description: Maximum timestamp for requested logs. example: "2020-02-20T02:02:02.202Z" format: date-time type: string required: - from - to type: object LogsListResponse: description: Response object with all logs matching the request and pagination information. properties: logs: description: Array of logs matching the request and the `nextLogId` if sent. items: $ref: "#/components/schemas/Log" type: array nextLogId: description: |- Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. nullable: true type: string status: description: Status of the response. type: string type: object LogsLookupProcessor: description: |- Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines. properties: default_lookup: description: Value to set the target attribute if the source value is not found in the list. type: string is_enabled: default: false description: Whether or not the processor is enabled. type: boolean lookup_table: description: |- Mapping table of values for the source attribute and their associated target attribute values, formatted as `["source_key1,target_value1", "source_key2,target_value2"]` example: ["source_key1,target_value1", "source_key2,target_value2"] items: description: Mapping between a source and a value, it should follow the format `","`. type: string type: array name: description: Name of the processor. type: string source: description: Source attribute used to perform the lookup. example: service_id type: string target: description: |- Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. example: service type: string type: $ref: "#/components/schemas/LogsLookupProcessorType" required: - source - target - lookup_table - type type: object LogsLookupProcessorType: default: lookup-processor description: Type of logs lookup processor. enum: - lookup-processor example: lookup-processor type: string x-enum-varnames: - LOOKUP_PROCESSOR LogsMessageRemapper: description: |- The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. **Note:** If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: default: ["msg"] description: Array of source attributes. example: ["msg"] items: description: Attribute used as a source to define the log associated message. type: string type: array type: $ref: "#/components/schemas/LogsMessageRemapperType" required: - sources - type type: object LogsMessageRemapperType: default: message-remapper description: Type of logs message remapper. enum: - message-remapper example: message-remapper type: string x-enum-varnames: - MESSAGE_REMAPPER LogsPipeline: description: |- Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. **Note**: These endpoints are only available for admin users. Make sure to use an application key created by an admin. properties: description: description: A description of the pipeline. type: string filter: $ref: "#/components/schemas/LogsFilter" id: description: ID of the pipeline. readOnly: true type: string is_enabled: description: Whether or not the pipeline is enabled. type: boolean is_read_only: description: Whether or not the pipeline can be edited. readOnly: true type: boolean name: description: Name of the pipeline. example: "" type: string processors: description: Ordered list of processors in this pipeline. items: $ref: "#/components/schemas/LogsProcessor" type: array tags: description: A list of tags associated with the pipeline. items: description: A single tag using the format `key:value`. type: string type: array type: description: Type of pipeline. example: pipeline readOnly: true type: string required: - name type: object LogsPipelineList: description: Array of all log pipeline objects configured for the organization. items: $ref: "#/components/schemas/LogsPipeline" type: array LogsPipelineProcessor: description: |- Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors. properties: description: description: A description of the pipeline. type: string filter: $ref: "#/components/schemas/LogsFilter" is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string processors: description: Ordered list of processors in this pipeline. items: $ref: "#/components/schemas/LogsProcessor" type: array tags: description: A list of tags associated with the pipeline. items: description: A single tag using the format `key:value`. type: string type: array type: $ref: "#/components/schemas/LogsPipelineProcessorType" required: - type type: object LogsPipelineProcessorType: default: pipeline description: Type of logs pipeline processor. enum: - pipeline example: pipeline type: string x-enum-varnames: - PIPELINE LogsPipelinesOrder: description: Object containing the ordered list of pipeline IDs. properties: pipeline_ids: description: |- Ordered Array of `` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. example: ["tags", "org_ids", "products"] items: description: A given pipeline ID. type: string type: array required: - pipeline_ids type: object LogsProcessor: description: Definition of a logs processor. oneOf: - $ref: "#/components/schemas/LogsGrokParser" - $ref: "#/components/schemas/LogsDateRemapper" - $ref: "#/components/schemas/LogsStatusRemapper" - $ref: "#/components/schemas/LogsServiceRemapper" - $ref: "#/components/schemas/LogsMessageRemapper" - $ref: "#/components/schemas/LogsAttributeRemapper" - $ref: "#/components/schemas/LogsURLParser" - $ref: "#/components/schemas/LogsUserAgentParser" - $ref: "#/components/schemas/LogsCategoryProcessor" - $ref: "#/components/schemas/LogsArithmeticProcessor" - $ref: "#/components/schemas/LogsStringBuilderProcessor" - $ref: "#/components/schemas/LogsPipelineProcessor" - $ref: "#/components/schemas/LogsGeoIPParser" - $ref: "#/components/schemas/LogsLookupProcessor" - $ref: "#/components/schemas/ReferenceTableLogsLookupProcessor" - $ref: "#/components/schemas/LogsTraceRemapper" - $ref: "#/components/schemas/LogsSpanRemapper" - $ref: "#/components/schemas/LogsArrayProcessor" - $ref: "#/components/schemas/LogsDecoderProcessor" - $ref: "#/components/schemas/LogsSchemaProcessor" - $ref: "#/components/schemas/LogsExcludeAttributeProcessor" LogsQueryCompute: description: Define computation for a log query. properties: aggregation: description: The aggregation method. example: avg type: string facet: description: Facet name. example: "@duration" type: string interval: description: Define a time interval in seconds. example: 5000 format: int64 type: integer required: - aggregation type: object LogsRetentionAggSumUsage: description: Object containing indexed logs usage aggregated across organizations and months for a retention period. properties: logs_indexed_logs_usage_agg_sum: description: Total indexed logs for this retention period. format: int64 type: integer logs_live_indexed_logs_usage_agg_sum: description: Live indexed logs for this retention period. format: int64 type: integer logs_rehydrated_indexed_logs_usage_agg_sum: description: Rehydrated indexed logs for this retention period. format: int64 type: integer retention: description: The retention period in days or "custom" for all custom retention periods. type: string type: object LogsRetentionSumUsage: description: Object containing indexed logs usage grouped by retention period and summed. properties: logs_indexed_logs_usage_sum: description: Total indexed logs for this retention period. format: int64 type: integer logs_live_indexed_logs_usage_sum: description: Live indexed logs for this retention period. format: int64 type: integer logs_rehydrated_indexed_logs_usage_sum: description: Rehydrated indexed logs for this retention period. format: int64 type: integer retention: description: The retention period in days or "custom" for all custom retention periods. type: string type: object LogsSchemaCategoryMapper: description: |- Use the Schema Category Mapper to categorize log event into enum fields. In the case of OCSF, they can be used to map sibling fields which are composed of an ID and a name. **Notes**: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Categories are executed in order and processing stops at the first match. Make sure categories are properly ordered in case a log could match multiple queries. - Sibling fields always have a numerical ID field and a human-readable string name. - A fallback section handles cases where the name or ID value matches a specific value. If the name matches "Other" or the ID matches 99, the value of the sibling name field will be pulled from a source field from the original log. properties: categories: description: |- Array of filters to match or not a log and their corresponding `name` to assign a custom value to the log. example: - filter: query: "@eventName:(ConsoleLogin OR ExternalIdPDirectoryLogin OR UserAuthentication OR Authenticate)" id: 1 name: "Logon" - filter: query: "@eventName:*" id: 99 name: "Other" items: $ref: "#/components/schemas/LogsSchemaCategoryMapperCategory" type: array fallback: $ref: "#/components/schemas/LogsSchemaCategoryMapperFallback" name: description: Name of the logs schema category mapper. example: "activity_id and activity_name" type: string targets: $ref: "#/components/schemas/LogsSchemaCategoryMapperTargets" type: $ref: "#/components/schemas/LogsSchemaCategoryMapperType" required: - categories - targets - type - name type: object LogsSchemaCategoryMapperCategory: description: Object describing the logs filter with corresponding category ID and name assignment. properties: filter: $ref: "#/components/schemas/LogsFilter" id: description: ID to inject into the category. example: 1 format: int64 type: integer name: description: Value to assign to target schema field. example: "Password Change" type: string required: - filter - id - name type: object LogsSchemaCategoryMapperFallback: description: Used to override hardcoded category values with a value pulled from a source attribute on the log. properties: sources: additionalProperties: items: description: A fallback source attribute name. type: string type: array description: Fallback sources used to populate value of field. example: {} type: object values: additionalProperties: type: string description: Values that define when the fallback is used. example: {} type: object type: object LogsSchemaCategoryMapperTargets: description: Name of the target attributes which value is defined by the matching category. properties: id: description: ID of the field to map log attributes to. example: ocsf.activity_id type: string name: description: Name of the field to map log attributes to. example: ocsf.activity_name type: string type: object LogsSchemaCategoryMapperType: description: Type of logs schema category mapper. enum: - schema-category-mapper example: schema-category-mapper type: string x-enum-varnames: - SCHEMA_CATEGORY_MAPPER LogsSchemaData: description: Configuration of the schema data to use. properties: class_name: description: Class name of the schema to use. example: Account Change type: string class_uid: description: Class UID of the schema to use. example: 3001 format: int64 type: integer profiles: description: Optional list of profiles to modify the schema. example: ["security_control", "host"] items: description: A profile name that modifies the schema behavior. type: string type: array schema_type: description: Type of schema to use. example: ocsf type: string version: description: Version of the schema to use. example: 1.5.0 type: string required: - schema_type - version - class_uid - class_name type: object LogsSchemaMapper: description: Configuration of the schema processor mapper to use. oneOf: - $ref: "#/components/schemas/LogsSchemaRemapper" - $ref: "#/components/schemas/LogsSchemaCategoryMapper" LogsSchemaProcessor: description: |- A processor that has additional validations and checks for a given schema. Currently supported schema types include OCSF. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean mappers: description: The `LogsSchemaProcessor` `mappers`. example: - name: Map userIdentity to ocsf.user.uid sources: - userIdentity.principalId target: ocsf.user.uid type: schema-remapper items: $ref: "#/components/schemas/LogsSchemaMapper" type: array name: description: Name of the processor. example: "Map additionalEventData.LoginTo to ocsf.dst_endpoint.svc_name" type: string schema: $ref: "#/components/schemas/LogsSchemaData" type: $ref: "#/components/schemas/LogsSchemaProcessorType" required: - name - mappers - type - schema type: object LogsSchemaProcessorType: default: schema-processor description: Type of logs schema processor. enum: - schema-processor example: schema-processor type: string x-enum-varnames: - SCHEMA_PROCESSOR LogsSchemaRemapper: description: The schema remapper maps source log fields to their correct fields. properties: name: description: Name of the logs schema remapper. example: "Map userIdentity.principalId, responseElements.role.roleId, responseElements.user.userId to ocsf.user.uid" type: string override_on_conflict: default: false description: Override or not the target element if already set. type: boolean preserve_source: default: false description: Remove or preserve the remapped source element. type: boolean sources: description: Array of source attributes. example: ["userIdentity.principalId", "responseElements.role.roleId", "responseElements.user.userId"] items: description: Attribute used as a source to remap its value to the target attribute. type: string type: array target: description: Target field to map log source field to. example: ocsf.user.uid type: string target_format: $ref: "#/components/schemas/TargetFormatType" type: $ref: "#/components/schemas/LogsSchemaRemapperType" required: - name - sources - target - type type: object LogsSchemaRemapperType: description: Type of logs schema remapper. enum: - schema-remapper example: schema-remapper type: string x-enum-varnames: - SCHEMA_REMAPPER LogsServiceRemapper: description: |- Use this processor if you want to assign one or more attributes as the official service. **Note:** If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: description: Array of source attributes. example: ["web", "gateway"] items: description: Attribute used as a source to define the log associated service. type: string type: array type: $ref: "#/components/schemas/LogsServiceRemapperType" required: - sources - type type: object LogsServiceRemapperType: default: service-remapper description: Type of logs service remapper. enum: - service-remapper example: service-remapper type: string x-enum-varnames: - SERVICE_REMAPPER LogsSort: description: Time-ascending `asc` or time-descending `desc` results. enum: - asc - desc type: string x-enum-varnames: - TIME_ASCENDING - TIME_DESCENDING LogsSpanRemapper: description: |- There are two ways to define correlation between application spans and logs: 1. Follow the documentation on [how to inject a span ID in the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces). Log integrations automatically handle all remaining setup steps by default. 2. Use the span remapper processor to define a log attribute as its associated span ID. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: default: ["dd.span_id"] description: Array of source attributes. items: description: Attribute to extract the span ID from. type: string type: array type: $ref: "#/components/schemas/LogsSpanRemapperType" required: - type type: object LogsSpanRemapperType: default: span-id-remapper description: Type of logs span remapper. enum: - span-id-remapper example: span-id-remapper type: string x-enum-varnames: - SPAN_ID_REMAPPER LogsStatusRemapper: description: |- Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with `emerg` or f (case-insensitive) map to `emerg` (0) - Strings beginning with `a` (case-insensitive) map to `alert` (1) - Strings beginning with `c` (case-insensitive) map to `critical` (2) - Strings beginning with `err` (case-insensitive) map to `error` (3) - Strings beginning with `w` (case-insensitive) map to `warning` (4) - Strings beginning with `n` (case-insensitive) map to `notice` (5) - Strings beginning with `i` (case-insensitive) map to `info` (6) - Strings beginning with `d`, `trace` or `verbose` (case-insensitive) map to `debug` (7) - Strings beginning with `o` or matching `OK` or `Success` (case-insensitive) map to OK - All others map to `info` (6) **Note:** If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: description: Array of source attributes. example: [] items: description: Attribute used as a source to define the log associated status. type: string type: array type: $ref: "#/components/schemas/LogsStatusRemapperType" required: - sources - type type: object LogsStatusRemapperType: default: status-remapper description: Type of logs status remapper. enum: - status-remapper example: status-remapper type: string x-enum-varnames: - STATUS_REMAPPER LogsStringBuilderProcessor: description: |- Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax `%{attribute_path}`. **Notes**: - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean is_replace_missing: default: false description: |- If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. type: boolean name: description: Name of the processor. type: string target: description: The name of the attribute that contains the result of the template. example: "" type: string template: description: A formula with one or more attributes and raw text. example: "" type: string type: $ref: "#/components/schemas/LogsStringBuilderProcessorType" required: - target - template - type type: object LogsStringBuilderProcessorType: default: string-builder-processor description: Type of logs string builder processor. enum: - string-builder-processor example: string-builder-processor type: string x-enum-varnames: - STRING_BUILDER_PROCESSOR LogsTraceRemapper: description: |- There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on [how to inject a trace ID in the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces) and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string sources: default: ["dd.trace_id"] description: Array of source attributes. items: description: Attribute to extract the trace ID from. type: string type: array type: $ref: "#/components/schemas/LogsTraceRemapperType" required: - type type: object LogsTraceRemapperType: default: trace-id-remapper description: Type of logs trace remapper. enum: - trace-id-remapper example: trace-id-remapper type: string x-enum-varnames: - TRACE_ID_REMAPPER LogsURLParser: description: This processor extracts query parameters and other important parameters from a URL. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean name: description: Name of the processor. type: string normalize_ending_slashes: default: false description: Normalize the ending slashes or not. nullable: true type: boolean sources: default: ["http.url"] description: Array of source attributes. example: ["http.url"] items: description: Attribute to extract the URL from. type: string type: array target: default: "http.url_details" description: Name of the parent attribute that contains all the extracted details from the `sources`. example: "http.url_details" type: string type: $ref: "#/components/schemas/LogsURLParserType" required: - sources - target - type type: object LogsURLParserType: default: url-parser description: Type of logs URL parser. enum: - url-parser example: url-parser type: string x-enum-varnames: - URL_PARSER LogsUserAgentParser: description: |- The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean is_encoded: default: false description: Define if the source attribute is URL encoded or not. type: boolean name: description: Name of the processor. type: string sources: default: ["http.useragent"] description: Array of source attributes. example: ["http.useragent"] items: description: Attribute to extract the User-Agent from. type: string type: array target: default: http.useragent_details description: Name of the parent attribute that contains all the extracted details from the `sources`. example: http.useragent_details type: string type: $ref: "#/components/schemas/LogsUserAgentParserType" required: - sources - target - type type: object LogsUserAgentParserType: default: user-agent-parser description: Type of logs User-Agent parser. enum: - user-agent-parser example: user-agent-parser type: string x-enum-varnames: - USER_AGENT_PARSER MatchingDowntime: description: Object describing a downtime that matches this monitor. properties: end: description: POSIX timestamp to end the downtime. example: 1412792983 format: int64 nullable: true type: integer id: description: The downtime ID. example: 1625 format: int64 readOnly: true type: integer scope: description: |- The scope(s) to which the downtime applies. Must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). example: ["env:staging"] items: description: A scope. For example, `"env:staging"`. type: string type: array start: description: POSIX timestamp to start the downtime. example: 1412792983 format: int64 type: integer required: - id type: object MetricContentEncoding: default: deflate description: HTTP header used to compress the media-type. enum: - deflate - gzip example: deflate type: string x-enum-varnames: - DEFLATE - GZIP MetricMetadata: description: Object with all metric related metadata. properties: description: description: Metric description. type: string integration: description: Name of the integration that sent the metric if applicable. readOnly: true type: string per_unit: description: Per unit of the metric such as `second` in `bytes per second`. example: second type: string short_name: description: A more human-readable and abbreviated version of the metric name. type: string statsd_interval: description: StatsD flush interval of the metric in seconds if applicable. format: int64 type: integer type: description: Metric type such as `gauge` or `rate`. example: count type: string unit: description: Primary unit of the metric such as `byte` or `operation`. example: byte type: string type: object MetricSearchResponse: description: Object containing the list of metrics matching the search query. properties: results: $ref: "#/components/schemas/MetricSearchResponseResults" type: object MetricSearchResponseResults: description: Search result. properties: metrics: description: List of metrics that match the search query. items: description: Metric name. type: string type: array type: object MetricsListResponse: description: Object listing all metric names stored by Datadog since a given time. properties: from: description: Time when the metrics were active, seconds since the Unix epoch. type: string metrics: description: List of metric names. items: description: A metric name. type: string type: array type: object MetricsPayload: description: The metrics' payload. properties: series: description: A list of timeseries to submit to Datadog. example: - metric: "system.load.1" points: - [1475317847.0, 0.7] items: $ref: "#/components/schemas/Series" type: array required: - series type: object MetricsQueryMetadata: description: Object containing all metric names returned and their associated metadata. properties: aggr: description: Aggregation type. example: "avg" nullable: true readOnly: true type: string display_name: description: Display name of the metric. example: system.cpu.idle readOnly: true type: string end: description: End of the time window, milliseconds since Unix epoch. format: int64 readOnly: true type: integer expression: description: Metric expression. example: system.cpu.idle{host:foo,env:test} readOnly: true type: string interval: description: Number of milliseconds between data samples. format: int64 readOnly: true type: integer length: description: Number of data samples. format: int64 readOnly: true type: integer metric: description: Metric name. example: system.cpu.idle readOnly: true type: string pointlist: description: List of points of the timeseries in milliseconds. example: - [1681683300000.0, 77.62145685254418] items: $ref: "#/components/schemas/Point" readOnly: true type: array query_index: description: The index of the series' query within the request. format: int64 readOnly: true type: integer scope: description: Metric scope, comma separated list of tags. example: host:foo,env:test readOnly: true type: string start: description: Start of the time window, milliseconds since Unix epoch. format: int64 readOnly: true type: integer tag_set: description: Unique tags identifying this series. items: description: Unique tags identifying this series. type: string readOnly: true type: array unit: description: |- Detailed information about the metric unit. The first element describes the "primary unit" (for example, `bytes` in `bytes per second`). The second element describes the "per unit" (for example, `second` in `bytes per second`). If the second element is not present, the API returns null. items: $ref: "#/components/schemas/MetricsQueryUnit" maxItems: 2 minItems: 2 readOnly: true type: array type: object MetricsQueryResponse: description: Response Object that includes your query and the list of metrics retrieved. properties: error: description: Message indicating the errors if status is not `ok`. readOnly: true type: string from_date: description: Start of requested time window, milliseconds since Unix epoch. format: int64 readOnly: true type: integer group_by: description: List of tag keys on which to group. items: description: Tag key to group by your metric. type: string readOnly: true type: array message: description: Message indicating `success` if status is `ok`. readOnly: true type: string query: description: Query string readOnly: true type: string res_type: description: Type of response. example: time_series readOnly: true type: string series: description: List of timeseries queried. items: $ref: "#/components/schemas/MetricsQueryMetadata" readOnly: true type: array status: description: Status of the query. example: ok readOnly: true type: string to_date: description: End of requested time window, milliseconds since Unix epoch. format: int64 readOnly: true type: integer type: object MetricsQueryUnit: description: Object containing the metric unit family, scale factor, name, and short name. nullable: true properties: family: description: Unit family, allows for conversion between units of the same family, for scaling. example: time readOnly: true type: string name: description: Unit name example: minute readOnly: true type: string plural: description: Plural form of the unit name. example: minutes readOnly: true type: string scale_factor: description: Factor for scaling between units of the same family. example: 60.0 format: double readOnly: true type: number short_name: description: Abbreviation of the unit. example: min readOnly: true type: string type: object Monitor: description: Object describing a monitor. properties: assets: description: The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). items: $ref: "#/components/schemas/MonitorAsset" type: array created: description: Timestamp of the monitor creation. format: date-time readOnly: true type: string creator: $ref: "#/components/schemas/Creator" deleted: description: Whether or not the monitor is deleted. (Always `null`) format: date-time nullable: true readOnly: true type: string draft_status: $ref: "#/components/schemas/MonitorDraftStatus" id: description: ID of this monitor. format: int64 readOnly: true type: integer matching_downtimes: description: A list of active v1 downtimes that match this monitor. items: $ref: "#/components/schemas/MatchingDowntime" type: array message: description: A message to include with notifications for this monitor. type: string modified: description: Last timestamp when the monitor was edited. format: date-time readOnly: true type: string multi: description: Whether or not the monitor is broken down on different groups. readOnly: true type: boolean name: description: The monitor name. example: "My monitor" type: string options: $ref: "#/components/schemas/MonitorOptions" overall_state: $ref: "#/components/schemas/MonitorOverallStates" priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int64 nullable: true type: integer query: description: The monitor query. example: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" type: string restricted_roles: description: A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) and are located in the `data.id` field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. items: description: A role UUID. type: string nullable: true type: array state: $ref: "#/components/schemas/MonitorState" tags: description: Tags associated to your monitor. items: description: A Datadog tag. type: string type: array type: $ref: "#/components/schemas/MonitorType" required: - type - query type: object MonitorAsset: description: |- Represents key links tied to a monitor to help users take action on alerts. This feature is in Preview and only available to users with the feature enabled. properties: category: $ref: "#/components/schemas/MonitorAssetCategory" name: description: Name for the monitor asset example: "Monitor Runbook" type: string resource_key: description: Represents the identifier of the internal Datadog resource that this asset represents. IDs in this field should be passed in as strings. example: "12345" type: string resource_type: $ref: "#/components/schemas/MonitorAssetResourceType" url: description: URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path. example: "/notebooks/12345" type: string required: - name - url - category type: object MonitorAssetCategory: description: Indicates the type of asset this entity represents on a monitor. enum: - runbook example: runbook type: string x-enum-varnames: - RUNBOOK MonitorAssetResourceType: description: Type of internal Datadog resource associated with a monitor asset. enum: - notebook type: string x-enum-varnames: - NOTEBOOK MonitorDeviceID: description: ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. enum: - laptop_large - tablet - mobile_small - chrome.laptop_large - chrome.tablet - chrome.mobile_small - firefox.laptop_large - firefox.tablet - firefox.mobile_small type: string x-enum-varnames: - LAPTOP_LARGE - TABLET - MOBILE_SMALL - CHROME_LAPTOP_LARGE - CHROME_TABLET - CHROME_MOBILE_SMALL - FIREFOX_LAPTOP_LARGE - FIREFOX_TABLET - FIREFOX_MOBILE_SMALL MonitorDraftStatus: default: published description: |- Indicates whether the monitor is in a draft or published state. `draft`: The monitor appears as Draft and does not send notifications. `published`: The monitor is active and evaluates conditions and notify as configured. This field is in preview. The draft value is only available to customers with the feature enabled. enum: - draft - published type: string x-enum-varnames: - DRAFT - PUBLISHED MonitorFormulaAndFunctionAggregateAugmentQuery: description: Augment query for aggregate augmented queries. Can be an events query or a reference table query. oneOf: - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition" MonitorFormulaAndFunctionAggregateAugmentedDataSource: description: Data source for aggregate augmented queries. enum: - aggregate_augmented_query example: "aggregate_augmented_query" type: string x-enum-varnames: - AGGREGATE_AUGMENTED_QUERY MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition: additionalProperties: false description: A formula and functions aggregate augmented query. Used to enrich base query results with data from a reference table. properties: augment_query: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentQuery" base_query: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery" compute: description: Compute options for the query. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute" minItems: 1 type: array data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedDataSource" group_by: description: Group by options for the query. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy" type: array join_condition: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinCondition" name: description: Name of the query for use in formulas. example: "query1" type: string required: - data_source - base_query - augment_query - join_condition - compute - group_by type: object MonitorFormulaAndFunctionAggregateBaseQuery: description: Base query for aggregate queries. Can be an events query or a metrics query. oneOf: - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsQueryDefinition" MonitorFormulaAndFunctionAggregateFilterQuery: description: Filter query for aggregate filtered queries. Can be an events query or a reference table query. oneOf: - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition" MonitorFormulaAndFunctionAggregateFilteredDataSource: description: Data source for aggregate filtered queries. enum: - aggregate_filtered_query example: "aggregate_filtered_query" type: string x-enum-varnames: - AGGREGATE_FILTERED_QUERY MonitorFormulaAndFunctionAggregateFilteredQueryDefinition: additionalProperties: false description: A formula and functions aggregate filtered query. Used to filter base query results using data from another source. properties: base_query: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery" compute: description: Compute options for the query. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute" type: array data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredDataSource" filter_query: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilterQuery" filters: description: Filter conditions for the query. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryFilter" type: array group_by: description: Group by options for the query. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy" type: array name: description: Name of the query for use in formulas. example: "query1" type: string required: - data_source - base_query - filter_query - filters type: object MonitorFormulaAndFunctionAggregateQueryFilter: additionalProperties: false description: Filter definition for aggregate filtered queries. properties: base_attribute: description: Attribute from the base query to filter on. example: "org_id" type: string exclude: default: false description: Whether to exclude matching records instead of including them. type: boolean filter_attribute: description: Attribute from the filter query to match against. example: "org_id" type: string required: - base_attribute - filter_attribute type: object MonitorFormulaAndFunctionAggregateQueryJoinCondition: additionalProperties: false description: Join condition for aggregate augmented queries. properties: augment_attribute: description: Attribute from the augment query to join on. example: "org_id" type: string base_attribute: description: Attribute from the base query to join on. example: "org_id" type: string join_type: $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinType" required: - base_attribute - augment_attribute - join_type type: object MonitorFormulaAndFunctionAggregateQueryJoinType: description: Join type for aggregate query join conditions. enum: - inner - left example: "inner" type: string x-enum-varnames: - INNER - LEFT MonitorFormulaAndFunctionCostAggregator: description: Aggregation methods for metric queries. enum: - avg - sum - max - min - last - area - l2norm - percentile - stddev example: avg type: string x-enum-varnames: - AVG - SUM - MAX - MIN - LAST - AREA - L2NORM - PERCENTILE - STDDEV MonitorFormulaAndFunctionCostDataSource: description: Data source for cost queries. enum: - metrics - cloud_cost - datadog_usage example: "cloud_cost" type: string x-enum-varnames: - METRICS - CLOUD_COST - DATADOG_USAGE MonitorFormulaAndFunctionCostQueryDefinition: description: A formula and functions cost query. properties: aggregator: $ref: "#/components/schemas/MonitorFormulaAndFunctionCostAggregator" data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionCostDataSource" name: description: Name of the query for use in formulas. example: "query1" type: string query: description: The monitor query. example: "sum:all.cost{*}.rollup(sum, 86400)" type: string required: - name - data_source - query type: object MonitorFormulaAndFunctionDataJobsQueryDefinition: description: A formula and functions data jobs query. properties: job_type: description: |- The type of job being monitored. Valid values include: `databricks.job`, `spark.application`, `airflow.dag`, `dbt.job`, `dbt.model`, `dbt.test`, `glue.job`. Custom job types are supported with the `custom.ol.` prefix. example: "databricks.job" type: string jobs_query: description: Filter expression used to select the jobs to monitor. example: "job_name:smoke*" type: string name: description: Name of the query for use in formulas. Must be `run_query`. example: "run_query" type: string query_dialect: description: |- Query dialect for data jobs queries. Currently only `metric` is supported. example: "metric" type: string required: - name - jobs_query - job_type - query_dialect type: object MonitorFormulaAndFunctionDataQualityDataSource: description: Data source for data quality queries. enum: - data_quality_metrics example: "data_quality_metrics" type: string x-enum-varnames: - DATA_QUALITY_METRICS MonitorFormulaAndFunctionDataQualityMeasure: description: |- The data quality measure to query. Common values include: `bytes`, `cardinality`, `custom`, `freshness`, `max`, `mean`, `min`, `nullness`, `percent_negative`, `percent_zero`, `row_count`, `stddev`, `sum`, `uniqueness`. Additional values may be supported. example: "row_count" type: string MonitorFormulaAndFunctionDataQualityModelTypeOverride: description: Override for the model type used in anomaly detection. enum: - freshness - percentage - any type: string x-enum-varnames: - FRESHNESS - PERCENTAGE - ANY MonitorFormulaAndFunctionDataQualityMonitorOptions: description: Monitor configuration options for data quality queries. properties: crontab_override: description: Crontab expression to override the default schedule. example: "* * * 10" type: string custom_sql: description: Custom SQL query for the monitor. example: "SELECT COUNT(*) FROM users AS dd_value" type: string custom_where: description: Custom WHERE clause for the query. example: "USER_ID = 123" type: string group_by_columns: description: Columns to group results by. example: ["col1", "col2"] items: description: A column name to group results by. type: string type: array model_type_override: $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityModelTypeOverride" type: object MonitorFormulaAndFunctionDataQualityQueryDefinition: description: A formula and functions data quality query. properties: data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityDataSource" filter: description: |- Filter expression used to match on data entities. Uses Aastra query syntax. example: "search for column where `database:production AND table:users`" type: string group_by: description: Optional grouping fields for aggregation. example: ["entity_id"] items: description: A field name to group results by. type: string type: array measure: $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityMeasure" monitor_options: $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityMonitorOptions" name: description: Name of the query for use in formulas. example: "query1" type: string schema_version: description: Schema version for the data quality query. example: "0.0.1" type: string scope: description: |- Optional scoping expression to further filter metrics. Uses metrics filter syntax. This is useful when an entity has been configured to emit metrics with additional tags. example: "env:production" type: string required: - name - data_source - measure - filter type: object MonitorFormulaAndFunctionEventAggregation: description: Aggregation methods for event platform queries. enum: - count - cardinality - median - pc75 - pc90 - pc95 - pc98 - pc99 - sum - min - max - avg example: avg type: string x-enum-varnames: - COUNT - CARDINALITY - MEDIAN - PC75 - PC90 - PC95 - PC98 - PC99 - SUM - MIN - MAX - AVG MonitorFormulaAndFunctionEventQueryDefinition: description: A formula and functions events query. properties: compute: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute" data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventsDataSource" group_by: description: Group by options. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy" type: array indexes: description: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. example: ["days-3", "days-7"] items: description: A log index set up for your organization. For additional indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) documentation. type: string type: array name: description: Name of the query for use in formulas. example: "query_errors" type: string search: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionSearch" required: - data_source - compute - name type: object MonitorFormulaAndFunctionEventQueryDefinitionCompute: description: Compute options. properties: aggregation: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventAggregation" interval: description: A time interval in milliseconds. example: 60000 format: int64 type: integer metric: description: Measurable attribute to compute. example: "@duration" type: string name: description: The name assigned to this aggregation, when multiple aggregations are defined for a query. example: "compute_result" type: string source: description: Source reference for composite query payloads. example: "filter_query" type: string required: - aggregation type: object MonitorFormulaAndFunctionEventQueryDefinitionSearch: description: Search options. properties: query: description: Events search string. example: "service:query" type: string required: - query type: object MonitorFormulaAndFunctionEventQueryGroupBy: description: List of objects used to group by. properties: facet: description: Event facet. example: status type: string limit: description: Number of groups to return. example: 10 format: int64 type: integer sort: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBySort" source: description: Source reference for composite query payloads. example: "filter_query" type: string required: - facet type: object MonitorFormulaAndFunctionEventQueryGroupBySort: description: Options for sorting group by results. properties: aggregation: $ref: "#/components/schemas/MonitorFormulaAndFunctionEventAggregation" metric: description: Metric used for sorting group by results. type: string order: $ref: "#/components/schemas/QuerySortOrder" required: - aggregation type: object MonitorFormulaAndFunctionEventsDataSource: description: Data source for event platform-based queries. enum: - rum - ci_pipelines - ci_tests - audit - events - logs - spans - database_queries - network - network_path example: "rum" type: string x-enum-varnames: - RUM - CI_PIPELINES - CI_TESTS - AUDIT - EVENTS - LOGS - SPANS - DATABASE_QUERIES - NETWORK - NETWORK_PATH MonitorFormulaAndFunctionMetricsAggregator: description: Aggregator for metrics queries. enum: - avg - min - max - sum - last - mean - area - l2norm - percentile - stddev - count_unique example: "avg" type: string x-enum-varnames: - AVG - MIN - MAX - SUM - LAST - MEAN - AREA - L2NORM - PERCENTILE - STDDEV - COUNT_UNIQUE MonitorFormulaAndFunctionMetricsDataSource: description: Data source for metrics queries. enum: - metrics - cloud_cost - datadog_usage example: "metrics" type: string x-enum-varnames: - METRICS - CLOUD_COST - DATADOG_USAGE MonitorFormulaAndFunctionMetricsQueryDefinition: additionalProperties: false description: A formula and functions metrics query for use in aggregate queries. properties: aggregator: $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsAggregator" data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsDataSource" name: description: Name of the query for use in formulas. example: "query1" type: string query: description: The metrics query definition. example: "avg:system.cpu.user{*}" type: string required: - data_source - query type: object MonitorFormulaAndFunctionQueryDefinition: description: A formula and function query. oneOf: - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataJobsQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition" - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredQueryDefinition" MonitorFormulaAndFunctionReferenceTableColumn: additionalProperties: false description: A column definition for reference table queries. properties: alias: description: Optional alias for the column. type: string name: description: Name of the column. example: "org_id" type: string required: - name type: object MonitorFormulaAndFunctionReferenceTableDataSource: description: Data source for reference table queries. enum: - reference_table example: "reference_table" type: string x-enum-varnames: - REFERENCE_TABLE MonitorFormulaAndFunctionReferenceTableQueryDefinition: additionalProperties: false description: A reference table query for use in aggregate queries. properties: columns: description: List of columns to retrieve from the reference table. items: $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableColumn" type: array data_source: $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableDataSource" name: description: Name of the query. example: "filter_query" type: string query_filter: description: Optional filter expression for the reference table query. type: string table_name: description: Name of the reference table. example: "test_table" type: string required: - data_source - table_name type: object MonitorGroupSearchResponse: description: The response of a monitor group search. example: counts: status: - count: 2 name: OK type: - count: 2 name: metric groups: - group: "*" group_tags: - "*" last_nodata_ts: 0 last_triggered_ts: 1525702966 monitor_id: 2738266 monitor_name: "[demo] Cassandra disk usage is high on {{host.name}}" status: OK - group: "*" group_tags: - "*" last_nodata_ts: 0 last_triggered_ts: 1525703008 monitor_id: 1576648 monitor_name: "[demo] Disk usage is high on {{host.name}}" status: OK metadata: page: 0 page_count: 2 per_page: 30 total_count: 2 properties: counts: $ref: "#/components/schemas/MonitorGroupSearchResponseCounts" groups: description: The list of found monitor groups. items: $ref: "#/components/schemas/MonitorGroupSearchResult" readOnly: true type: array metadata: $ref: "#/components/schemas/MonitorSearchResponseMetadata" type: object MonitorGroupSearchResponseCounts: description: The counts of monitor groups per different criteria. properties: status: $ref: "#/components/schemas/MonitorSearchCount" type: $ref: "#/components/schemas/MonitorSearchCount" readOnly: true type: object MonitorGroupSearchResult: description: A single monitor group search result. properties: group: description: The name of the group. readOnly: true type: string group_tags: description: The list of tags of the monitor group. items: description: One monitor group tag. readOnly: true type: string readOnly: true type: array last_nodata_ts: description: Latest timestamp the monitor group was in NO_DATA state. format: int64 readOnly: true type: integer last_triggered_ts: description: Latest timestamp the monitor group triggered. format: int64 nullable: true readOnly: true type: integer monitor_id: description: The ID of the monitor. format: int64 readOnly: true type: integer monitor_name: description: The name of the monitor. readOnly: true type: string status: $ref: "#/components/schemas/MonitorOverallStates" type: object MonitorOptions: description: List of options associated with your monitor. properties: aggregation: $ref: "#/components/schemas/MonitorOptionsAggregation" device_ids: deprecated: true description: IDs of the device the Synthetics monitor is running on. items: $ref: "#/components/schemas/MonitorDeviceID" readOnly: true type: array enable_logs_sample: description: Whether or not to send a log sample when the log monitor triggers. type: boolean enable_samples: description: Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors. type: boolean escalation_message: description: |- We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. type: string evaluation_delay: description: |- Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. format: int64 nullable: true type: integer group_retention_duration: description: |- The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: "60m", "1h", and "2d". This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. type: string groupby_simple_monitor: deprecated: true description: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use `notify_by` instead. type: boolean include_tags: default: true description: |- A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title` type: boolean locked: deprecated: true description: Whether or not the monitor is locked (only editable by creator and admins). Use `restricted_roles` instead. type: boolean min_failure_duration: default: 0 description: How long the test should be in failure before alerting (integer, number of seconds, max 7200). format: int64 maximum: 7200 minimum: 0 nullable: true type: integer min_location_failed: default: 1 description: |- The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1). format: int64 nullable: true type: integer new_group_delay: description: |- Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer. format: int64 nullable: true type: integer new_host_delay: default: 300 deprecated: true description: |- Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead. format: int64 nullable: true type: integer no_data_timeframe: description: |- The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks. format: int64 nullable: true type: integer notification_preset_name: $ref: "#/components/schemas/MonitorOptionsNotificationPresets" notify_audit: default: false description: A Boolean indicating whether tagged users is notified on changes to this monitor. type: boolean notify_by: description: |- Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each new `cluster` violating the alert conditions by setting `notify_by` to `["cluster"]`. Tags mentioned in `notify_by` must be a subset of the grouping tags in the query. For example, a query grouped by `cluster` and `namespace` cannot notify on `region`. Setting `notify_by` to `["*"]` configures the monitor to notify as a simple-alert. items: description: A grouping tag. type: string type: array notify_no_data: description: A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`. type: boolean on_missing_data: $ref: "#/components/schemas/OnMissingDataOption" renotify_interval: default: description: |- The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved. format: int64 nullable: true type: integer renotify_occurrences: description: |- The number of times re-notification messages should be sent on the current status at the provided re-notification interval. format: int64 nullable: true type: integer renotify_statuses: description: |- The types of monitor statuses for which re-notification messages are sent. Default: **null** if `renotify_interval` is **null**. If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`. items: $ref: "#/components/schemas/MonitorRenotifyStatusType" nullable: true type: array require_full_window: description: |- A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. This setting only applies to metric monitors. type: boolean scheduling_options: $ref: "#/components/schemas/MonitorOptionsSchedulingOptions" silenced: additionalProperties: description: UTC epoch timestamp in seconds when the downtime for the group expires. format: int64 nullable: true type: integer deprecated: true description: Information about the downtime applied to the monitor. Only shows v1 downtimes. type: object synthetics_check_id: deprecated: true description: ID of the corresponding Synthetic check. nullable: true type: string threshold_windows: $ref: "#/components/schemas/MonitorThresholdWindowOptions" thresholds: $ref: "#/components/schemas/MonitorThresholds" timeout_h: default: description: The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours. format: int64 nullable: true type: integer variables: description: List of requests that can be used in the monitor query. **This feature is currently in beta.** items: $ref: "#/components/schemas/MonitorFormulaAndFunctionQueryDefinition" type: array type: object MonitorOptionsAggregation: description: Type of aggregation performed in the monitor query. properties: group_by: description: Group to break down the monitor on. example: host type: string metric: description: Metric name used in the monitor. example: metrics.name type: string type: description: Metric type used in the monitor. example: count type: string readOnly: true type: object MonitorOptionsCustomSchedule: description: Configuration options for the custom schedule. **This feature is in private beta.** properties: recurrences: description: Array of custom schedule recurrences. items: $ref: "#/components/schemas/MonitorOptionsCustomScheduleRecurrence" type: array type: object MonitorOptionsCustomScheduleRecurrence: description: Configuration for a recurrence set on the monitor options for custom schedule. properties: rrule: description: Defines the recurrence rule (RRULE) for a given schedule. example: "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR" type: string start: description: Defines the start date and time of the recurring schedule. example: "2023-08-31T16:30:00" type: string timezone: description: Defines the timezone the schedule runs on. example: "Europe/Paris" type: string type: object MonitorOptionsNotificationPresets: default: "show_all" description: Toggles the display of additional content sent in the monitor notification. enum: - "show_all" - "hide_query" - "hide_handles" - "hide_all" - "hide_query_and_handles" - "show_only_snapshot" - "hide_handles_and_footer" type: string x-enum-varnames: - SHOW_ALL - HIDE_QUERY - HIDE_HANDLES - HIDE_ALL - HIDE_QUERY_AND_HANDLES - SHOW_ONLY_SNAPSHOT - HIDE_HANDLES_AND_FOOTER MonitorOptionsSchedulingOptions: description: Configuration options for scheduling. properties: custom_schedule: $ref: "#/components/schemas/MonitorOptionsCustomSchedule" evaluation_window: $ref: "#/components/schemas/MonitorOptionsSchedulingOptionsEvaluationWindow" type: object MonitorOptionsSchedulingOptionsEvaluationWindow: description: Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together. properties: day_starts: description: The time of the day at which a one day cumulative evaluation window starts. example: "04:00" type: string hour_starts: description: The minute of the hour at which a one hour cumulative evaluation window starts. example: 0 format: int32 maximum: 59 minimum: 0 type: integer month_starts: description: The day of the month at which a one month cumulative evaluation window starts. example: 1 format: int32 maximum: 1 minimum: 1 type: integer timezone: description: The timezone of the time of the day of the cumulative evaluation window start. example: "Europe/Paris" type: string type: object MonitorOverallStates: description: The different states your monitor can be in. enum: - Alert - Ignored - No Data - OK - Skipped - Unknown - Warn readOnly: true type: string x-enum-varnames: - ALERT - IGNORED - NO_DATA - OK - SKIPPED - UNKNOWN - WARN MonitorRenotifyStatusType: description: The different statuses for which renotification is supported. enum: - "alert" - "warn" - "no data" type: string x-enum-varnames: - ALERT - WARN - NO_DATA MonitorSearchCount: description: Search facets. items: $ref: "#/components/schemas/MonitorSearchCountItem" type: array MonitorSearchCountItem: description: A facet item. properties: count: description: The number of found monitors with the listed value. format: int64 readOnly: true type: integer name: description: The facet value. readOnly: true type: object MonitorSearchResponse: description: The response from a monitor search. example: counts: muted: - count: 3 name: false - count: 3 name: true status: - count: 4 name: No Data - count: 2 name: OK tag: - count: 6 name: service:cassandra type: - count: 6 name: metric metadata: page: 0 page_count: 6 per_page: 30 total_count: 6 monitors: - classification: metric creator: handle: john@datadoghq.com name: John Doe id: 2699850 last_triggered_ts: metrics: - system.cpu.user name: Cassandra CPU is high on {{host.name}} in {{availability-zone.name}} notifications: - handle: jane@datadoghq.com name: Jane Doe org_id: 1234 quality_issues: - "broken_at_handle" - "noisy_monitor" scopes: - "!availability-zone:us-east-1c" - name:cassandra status: No Data tags: - service:cassandra type: query alert properties: counts: $ref: "#/components/schemas/MonitorSearchResponseCounts" metadata: $ref: "#/components/schemas/MonitorSearchResponseMetadata" monitors: description: The list of found monitors. items: $ref: "#/components/schemas/MonitorSearchResult" readOnly: true type: array type: object MonitorSearchResponseCounts: description: The counts of monitors per different criteria. properties: muted: $ref: "#/components/schemas/MonitorSearchCount" status: $ref: "#/components/schemas/MonitorSearchCount" tag: $ref: "#/components/schemas/MonitorSearchCount" type: $ref: "#/components/schemas/MonitorSearchCount" readOnly: true type: object MonitorSearchResponseMetadata: description: Metadata about the response. properties: page: description: The page to start paginating from. format: int64 readOnly: true type: integer page_count: description: The number of pages. format: int64 readOnly: true type: integer per_page: description: The number of monitors to return per page. format: int64 readOnly: true type: integer total_count: description: The total number of monitors. format: int64 readOnly: true type: integer type: object MonitorSearchResult: description: Holds search results. properties: classification: description: Classification of the monitor. readOnly: true type: string creator: $ref: "#/components/schemas/Creator" id: description: ID of the monitor. format: int64 readOnly: true type: integer last_triggered_ts: description: Latest timestamp the monitor triggered. format: int64 nullable: true readOnly: true type: integer metrics: description: Metrics used by the monitor. items: description: A metric used by the monitor. readOnly: true type: string readOnly: true type: array name: description: The monitor name. readOnly: true type: string notifications: description: The notification triggered by the monitor. items: $ref: "#/components/schemas/MonitorSearchResultNotification" readOnly: true type: array org_id: description: The ID of the organization. format: int64 readOnly: true type: integer quality_issues: description: Quality issues detected with the monitor. items: description: A quality issue detected with the monitor. readOnly: true type: string readOnly: true type: array query: description: The monitor query. example: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" type: string scopes: description: |- The scope(s) to which the downtime applies, for example `host:app2`. Provide multiple scopes as a comma-separated list, for example `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (that is `env:dev AND env:prod`), NOT any of them. example: ["host:app2", "env:dev,env:prod"] items: description: Scope value(s). readOnly: true type: string type: array status: $ref: "#/components/schemas/MonitorOverallStates" tags: description: Tags associated with the monitor. items: description: A tag associated with the monitor. readOnly: true type: string readOnly: true type: array type: $ref: "#/components/schemas/MonitorType" type: object MonitorSearchResultNotification: description: A notification triggered by the monitor. properties: handle: description: The email address that received the notification. readOnly: true type: string name: description: The username receiving the notification readOnly: true type: string readOnly: true type: object MonitorState: description: Wrapper object with the different monitor states. properties: groups: additionalProperties: $ref: "#/components/schemas/MonitorStateGroup" description: |- Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on. type: object readOnly: true type: object MonitorStateGroup: description: Monitor state for a single group. properties: last_nodata_ts: description: Latest timestamp the monitor was in NO_DATA state. format: int64 type: integer last_notified_ts: description: Latest timestamp of the notification sent for this monitor group. format: int64 type: integer last_resolved_ts: description: Latest timestamp the monitor group was resolved. format: int64 type: integer last_triggered_ts: description: Latest timestamp the monitor group triggered. format: int64 type: integer name: description: The name of the monitor. type: string status: $ref: "#/components/schemas/MonitorOverallStates" type: object MonitorSummaryWidgetDefinition: description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. properties: color_preference: $ref: "#/components/schemas/WidgetColorPreference" count: deprecated: true description: The number of monitors to display. format: int64 type: integer description: description: The description of the widget. type: string display_format: $ref: "#/components/schemas/WidgetMonitorSummaryDisplayFormat" hide_zero_counts: description: Whether to show counts of 0 or not. type: boolean query: description: Query to filter the monitors with. example: "" type: string show_last_triggered: description: Whether to show the time that has elapsed since the monitor/group triggered. type: boolean show_priority: default: false description: Whether to show the priorities column. type: boolean sort: $ref: "#/components/schemas/WidgetMonitorSummarySort" start: deprecated: true description: The start of the list. Typically 0. format: int64 type: integer summary_type: $ref: "#/components/schemas/WidgetSummaryType" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/MonitorSummaryWidgetDefinitionType" required: - type - query type: object MonitorSummaryWidgetDefinitionType: default: manage_status description: Type of the monitor summary widget. enum: - manage_status example: manage_status type: string x-enum-varnames: - MANAGE_STATUS MonitorThresholdWindowOptions: description: Alerting time window options. properties: recovery_window: description: Describes how long an anomalous metric must be normal before the alert recovers. nullable: true type: string trigger_window: description: Describes how long a metric must be anomalous before an alert triggers. nullable: true type: string type: object MonitorThresholds: description: List of the different monitor threshold available. properties: critical: description: The monitor `CRITICAL` threshold. format: double type: number critical_query: description: Query evaluated as a dynamic `CRITICAL` threshold. Only supported on metric monitors with a formula query and options['variables']. Cannot be combined with static thresholds. This field is in preview. example: 'formula("2 * query1").rollup("avg").last("6mo")' type: string critical_recovery: description: The monitor `CRITICAL` recovery threshold. format: double nullable: true type: number critical_recovery_query: description: Query evaluated as a dynamic `CRITICAL` recovery threshold. Only supported on metric monitors with a formula query and options['variables']. Cannot be combined with static thresholds. This field is in preview. example: 'formula("1.5 * query1").rollup("avg").last("3mo")' type: string ok: description: The monitor `OK` threshold. format: double nullable: true type: number unknown: description: The monitor UNKNOWN threshold. format: double nullable: true type: number warning: description: The monitor `WARNING` threshold. format: double nullable: true type: number warning_recovery: description: The monitor `WARNING` recovery threshold. format: double nullable: true type: number type: object MonitorType: description: The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. enum: - "composite" - "event alert" - "log alert" - "metric alert" - "process alert" - "query alert" - "rum alert" - "service check" - "synthetics alert" - "trace-analytics alert" - "slo alert" - "event-v2 alert" - "audit alert" - "ci-pipelines alert" - "ci-tests alert" - "error-tracking alert" - "database-monitoring alert" - "network-performance alert" - "cost alert" - "data-quality alert" - "network-path alert" - "data-jobs alert" example: "query alert" type: string x-enum-varnames: - COMPOSITE - EVENT_ALERT - LOG_ALERT - METRIC_ALERT - PROCESS_ALERT - QUERY_ALERT - RUM_ALERT - SERVICE_CHECK - SYNTHETICS_ALERT - TRACE_ANALYTICS_ALERT - SLO_ALERT - EVENT_V2_ALERT - AUDIT_ALERT - CI_PIPELINES_ALERT - CI_TESTS_ALERT - ERROR_TRACKING_ALERT - DATABASE_MONITORING_ALERT - NETWORK_PERFORMANCE_ALERT - COST_ALERT - DATA_QUALITY_ALERT - NETWORK_PATH_ALERT - DATA_JOBS_ALERT MonitorUpdateRequest: description: Object describing a monitor update request. properties: assets: description: The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). items: $ref: "#/components/schemas/MonitorAsset" nullable: true type: array created: description: Timestamp of the monitor creation. format: date-time readOnly: true type: string creator: $ref: "#/components/schemas/Creator" deleted: description: Whether or not the monitor is deleted. (Always `null`) format: date-time nullable: true readOnly: true type: string draft_status: $ref: "#/components/schemas/MonitorDraftStatus" id: description: ID of this monitor. format: int64 readOnly: true type: integer message: description: A message to include with notifications for this monitor. type: string modified: description: Last timestamp when the monitor was edited. format: date-time readOnly: true type: string multi: description: Whether or not the monitor is broken down on different groups. readOnly: true type: boolean name: description: The monitor name. type: string options: $ref: "#/components/schemas/MonitorOptions" overall_state: $ref: "#/components/schemas/MonitorOverallStates" priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int64 nullable: true type: integer query: description: The monitor query. type: string restricted_roles: description: A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) and are located in the `data.id` field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. items: description: A role UUID. type: string nullable: true type: array state: $ref: "#/components/schemas/MonitorState" tags: description: Tags associated to your monitor. items: description: A Datadog tag. type: string type: array type: $ref: "#/components/schemas/MonitorType" type: object MonthlyUsageAttributionBody: description: Usage Summary by tag for a given organization. properties: month: description: "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]." format: date-time type: string org_name: description: The name of the organization. type: string public_id: description: The organization public ID. type: string region: description: The region of the Datadog instance that the organization belongs to. type: string tag_config_source: description: The source of the usage attribution tag configuration and the selected tags in the format `::://////`. type: string tags: $ref: "#/components/schemas/UsageAttributionTagNames" updated_at: description: Datetime of the most recent update to the usage values. format: date-time type: string values: $ref: "#/components/schemas/MonthlyUsageAttributionValues" type: object MonthlyUsageAttributionMetadata: description: The object containing document metadata. properties: aggregates: $ref: "#/components/schemas/UsageAttributionAggregates" pagination: $ref: "#/components/schemas/MonthlyUsageAttributionPagination" type: object MonthlyUsageAttributionPagination: description: The metadata for the current pagination. properties: next_record_id: description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the `next_record_id`. nullable: true type: string type: object MonthlyUsageAttributionResponse: description: Response containing the monthly Usage Summary by tag(s). properties: metadata: $ref: "#/components/schemas/MonthlyUsageAttributionMetadata" usage: description: Get usage summary by tag(s). items: $ref: "#/components/schemas/MonthlyUsageAttributionBody" type: array type: object MonthlyUsageAttributionSupportedMetrics: description: |- Supported metrics for monthly usage attribution requests. Usage types are in the format `_usage`. To obtain the complete list of valid usage types, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). enum: - api_usage - api_percentage - apm_fargate_usage - apm_fargate_percentage - appsec_fargate_usage - appsec_fargate_percentage - apm_host_usage - apm_host_percentage - apm_usm_usage - apm_usm_percentage - appsec_usage - appsec_percentage - asm_serverless_traced_invocations_usage - asm_serverless_traced_invocations_percentage - bits_ai_investigations_usage - bits_ai_investigations_percentage - browser_usage - browser_percentage - ci_visibility_itr_usage - ci_visibility_itr_percentage - cloud_siem_usage - cloud_siem_percentage - code_security_host_usage - code_security_host_percentage - container_excl_agent_usage - container_excl_agent_percentage - container_usage - container_percentage - cspm_containers_percentage - cspm_containers_usage - cspm_hosts_percentage - cspm_hosts_usage - custom_timeseries_usage - custom_timeseries_percentage - custom_ingested_timeseries_usage - custom_ingested_timeseries_percentage - cws_containers_percentage - cws_containers_usage - cws_fargate_task_percentage - cws_fargate_task_usage - cws_hosts_percentage - cws_hosts_usage - data_jobs_monitoring_usage - data_jobs_monitoring_percentage - data_stream_monitoring_usage - data_stream_monitoring_percentage - dbm_hosts_percentage - dbm_hosts_usage - dbm_queries_percentage - dbm_queries_usage - error_tracking_usage - error_tracking_percentage - estimated_indexed_spans_usage - estimated_indexed_spans_percentage - estimated_ingested_spans_usage - estimated_ingested_spans_percentage - fargate_usage - fargate_percentage - flex_logs_starter_usage - flex_logs_starter_percentage - flex_stored_logs_usage - flex_stored_logs_percentage - functions_usage - functions_percentage - incident_management_monthly_active_users_usage - incident_management_monthly_active_users_percentage - infra_host_usage - infra_host_percentage - infra_host_basic_usage - infra_host_basic_percentage - invocations_usage - invocations_percentage - lambda_traced_invocations_usage - lambda_traced_invocations_percentage - llm_observability_usage - llm_observability_percentage - llm_spans_usage - llm_spans_percentage - mobile_app_testing_percentage - mobile_app_testing_usage - ndm_netflow_usage - ndm_netflow_percentage - network_device_wireless_usage - network_device_wireless_percentage - npm_host_usage - npm_host_percentage - obs_pipeline_bytes_usage - obs_pipeline_bytes_percentage - obs_pipelines_vcpu_usage - obs_pipelines_vcpu_percentage - online_archive_usage - online_archive_percentage - product_analytics_session_usage - product_analytics_session_percentage - profiled_container_usage - profiled_container_percentage - profiled_fargate_usage - profiled_fargate_percentage - profiled_host_usage - profiled_host_percentage - published_app_usage - published_app_percentage - serverless_apps_usage - serverless_apps_percentage - serverless_apps_apm_usage - serverless_apps_apm_percentage - snmp_usage - snmp_percentage - universal_service_monitoring_usage - universal_service_monitoring_percentage - vuln_management_hosts_usage - vuln_management_hosts_percentage - sds_scanned_bytes_usage - sds_scanned_bytes_percentage - ci_test_indexed_spans_usage - ci_test_indexed_spans_percentage - ingested_logs_bytes_usage - ingested_logs_bytes_percentage - ci_pipeline_indexed_spans_usage - ci_pipeline_indexed_spans_percentage - indexed_spans_usage - indexed_spans_percentage - custom_event_usage - custom_event_percentage - logs_indexed_custom_retention_usage - logs_indexed_custom_retention_percentage - logs_indexed_360day_usage - logs_indexed_360day_percentage - logs_indexed_180day_usage - logs_indexed_180day_percentage - logs_indexed_90day_usage - logs_indexed_90day_percentage - logs_indexed_60day_usage - logs_indexed_60day_percentage - logs_indexed_45day_usage - logs_indexed_45day_percentage - logs_indexed_30day_usage - logs_indexed_30day_percentage - logs_indexed_15day_usage - logs_indexed_15day_percentage - logs_indexed_7day_usage - logs_indexed_7day_percentage - logs_indexed_3day_usage - logs_indexed_3day_percentage - logs_indexed_1day_usage - logs_indexed_1day_percentage - rum_ingested_usage - rum_ingested_percentage - rum_investigate_usage - rum_investigate_percentage - rum_replay_sessions_usage - rum_replay_sessions_percentage - rum_session_replay_add_on_usage - rum_session_replay_add_on_percentage - rum_browser_mobile_sessions_usage - rum_browser_mobile_sessions_percentage - ingested_spans_bytes_usage - ingested_spans_bytes_percentage - siem_12mo_retention_usage - siem_12mo_retention_percentage - siem_6mo_retention_usage - siem_6mo_retention_percentage - siem_analyzed_logs_add_on_usage - siem_analyzed_logs_add_on_percentage - siem_ingested_bytes_usage - siem_ingested_bytes_percentage - workflow_executions_usage - workflow_executions_percentage - sca_fargate_usage - sca_fargate_percentage - "*" type: string x-enum-varnames: - API_USAGE - API_PERCENTAGE - APM_FARGATE_USAGE - APM_FARGATE_PERCENTAGE - APPSEC_FARGATE_USAGE - APPSEC_FARGATE_PERCENTAGE - APM_HOST_USAGE - APM_HOST_PERCENTAGE - APM_USM_USAGE - APM_USM_PERCENTAGE - APPSEC_USAGE - APPSEC_PERCENTAGE - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE - BITS_AI_INVESTIGATIONS_USAGE - BITS_AI_INVESTIGATIONS_PERCENTAGE - BROWSER_USAGE - BROWSER_PERCENTAGE - CI_VISIBILITY_ITR_USAGE - CI_VISIBILITY_ITR_PERCENTAGE - CLOUD_SIEM_USAGE - CLOUD_SIEM_PERCENTAGE - CODE_SECURITY_HOST_USAGE - CODE_SECURITY_HOST_PERCENTAGE - CONTAINER_EXCL_AGENT_USAGE - CONTAINER_EXCL_AGENT_PERCENTAGE - CONTAINER_USAGE - CONTAINER_PERCENTAGE - CSPM_CONTAINERS_PERCENTAGE - CSPM_CONTAINERS_USAGE - CSPM_HOSTS_PERCENTAGE - CSPM_HOSTS_USAGE - CUSTOM_TIMESERIES_USAGE - CUSTOM_TIMESERIES_PERCENTAGE - CUSTOM_INGESTED_TIMESERIES_USAGE - CUSTOM_INGESTED_TIMESERIES_PERCENTAGE - CWS_CONTAINERS_PERCENTAGE - CWS_CONTAINERS_USAGE - CWS_FARGATE_TASK_PERCENTAGE - CWS_FARGATE_TASK_USAGE - CWS_HOSTS_PERCENTAGE - CWS_HOSTS_USAGE - DATA_JOBS_MONITORING_USAGE - DATA_JOBS_MONITORING_PERCENTAGE - DATA_STREAM_MONITORING_USAGE - DATA_STREAM_MONITORING_PERCENTAGE - DBM_HOSTS_PERCENTAGE - DBM_HOSTS_USAGE - DBM_QUERIES_PERCENTAGE - DBM_QUERIES_USAGE - ERROR_TRACKING_USAGE - ERROR_TRACKING_PERCENTAGE - ESTIMATED_INDEXED_SPANS_USAGE - ESTIMATED_INDEXED_SPANS_PERCENTAGE - ESTIMATED_INGESTED_SPANS_USAGE - ESTIMATED_INGESTED_SPANS_PERCENTAGE - FARGATE_USAGE - FARGATE_PERCENTAGE - FLEX_LOGS_STARTER_USAGE - FLEX_LOGS_STARTER_PERCENTAGE - FLEX_STORED_LOGS_USAGE - FLEX_STORED_LOGS_PERCENTAGE - FUNCTIONS_USAGE - FUNCTIONS_PERCENTAGE - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_PERCENTAGE - INFRA_HOST_USAGE - INFRA_HOST_PERCENTAGE - INFRA_HOST_BASIC_USAGE - INFRA_HOST_BASIC_PERCENTAGE - INVOCATIONS_USAGE - INVOCATIONS_PERCENTAGE - LAMBDA_TRACED_INVOCATIONS_USAGE - LAMBDA_TRACED_INVOCATIONS_PERCENTAGE - LLM_OBSERVABILITY_USAGE - LLM_OBSERVABILITY_PERCENTAGE - LLM_SPANS_USAGE - LLM_SPANS_PERCENTAGE - MOBILE_APP_TESTING_USAGE - MOBILE_APP_TESTING_PERCENTAGE - NDM_NETFLOW_USAGE - NDM_NETFLOW_PERCENTAGE - NETWORK_DEVICE_WIRELESS_USAGE - NETWORK_DEVICE_WIRELESS_PERCENTAGE - NPM_HOST_USAGE - NPM_HOST_PERCENTAGE - OBS_PIPELINE_BYTES_USAGE - OBS_PIPELINE_BYTES_PERCENTAGE - OBS_PIPELINES_VCPU_USAGE - OBS_PIPELINES_VCPU_PERCENTAGE - ONLINE_ARCHIVE_USAGE - ONLINE_ARCHIVE_PERCENTAGE - PRODUCT_ANALYTICS_SESSION_USAGE - PRODUCT_ANALYTICS_SESSION_PERCENTAGE - PROFILED_CONTAINER_USAGE - PROFILED_CONTAINER_PERCENTAGE - PROFILED_FARGATE_USAGE - PROFILED_FARGATE_PERCENTAGE - PROFILED_HOST_USAGE - PROFILED_HOST_PERCENTAGE - PUBLISHED_APP_USAGE - PUBLISHED_APP_PERCENTAGE - SERVERLESS_APPS_USAGE - SERVERLESS_APPS_PERCENTAGE - SERVERLESS_APPS_APM_USAGE - SERVERLESS_APPS_APM_PERCENTAGE - SNMP_USAGE - SNMP_PERCENTAGE - UNIVERSAL_SERVICE_MONITORING_USAGE - UNIVERSAL_SERVICE_MONITORING_PERCENTAGE - VULN_MANAGEMENT_HOSTS_USAGE - VULN_MANAGEMENT_HOSTS_PERCENTAGE - SDS_SCANNED_BYTES_USAGE - SDS_SCANNED_BYTES_PERCENTAGE - CI_TEST_INDEXED_SPANS_USAGE - CI_TEST_INDEXED_SPANS_PERCENTAGE - INGESTED_LOGS_BYTES_USAGE - INGESTED_LOGS_BYTES_PERCENTAGE - CI_PIPELINE_INDEXED_SPANS_USAGE - CI_PIPELINE_INDEXED_SPANS_PERCENTAGE - INDEXED_SPANS_USAGE - INDEXED_SPANS_PERCENTAGE - CUSTOM_EVENT_USAGE - CUSTOM_EVENT_PERCENTAGE - LOGS_INDEXED_CUSTOM_RETENTION_USAGE - LOGS_INDEXED_CUSTOM_RETENTION_PERCENTAGE - LOGS_INDEXED_360DAY_USAGE - LOGS_INDEXED_360DAY_PERCENTAGE - LOGS_INDEXED_180DAY_USAGE - LOGS_INDEXED_180DAY_PERCENTAGE - LOGS_INDEXED_90DAY_USAGE - LOGS_INDEXED_90DAY_PERCENTAGE - LOGS_INDEXED_60DAY_USAGE - LOGS_INDEXED_60DAY_PERCENTAGE - LOGS_INDEXED_45DAY_USAGE - LOGS_INDEXED_45DAY_PERCENTAGE - LOGS_INDEXED_30DAY_USAGE - LOGS_INDEXED_30DAY_PERCENTAGE - LOGS_INDEXED_15DAY_USAGE - LOGS_INDEXED_15DAY_PERCENTAGE - LOGS_INDEXED_7DAY_USAGE - LOGS_INDEXED_7DAY_PERCENTAGE - LOGS_INDEXED_3DAY_USAGE - LOGS_INDEXED_3DAY_PERCENTAGE - LOGS_INDEXED_1DAY_USAGE - LOGS_INDEXED_1DAY_PERCENTAGE - RUM_INGESTED_USAGE - RUM_INGESTED_PERCENTAGE - RUM_INVESTIGATE_USAGE - RUM_INVESTIGATE_PERCENTAGE - RUM_REPLAY_SESSIONS_USAGE - RUM_REPLAY_SESSIONS_PERCENTAGE - RUM_SESSION_REPLAY_ADD_ON_USAGE - RUM_SESSION_REPLAY_ADD_ON_PERCENTAGE - RUM_BROWSER_MOBILE_SESSIONS_USAGE - RUM_BROWSER_MOBILE_SESSIONS_PERCENTAGE - INGESTED_SPANS_BYTES_USAGE - INGESTED_SPANS_BYTES_PERCENTAGE - SIEM_12MO_RETENTION_USAGE - SIEM_12MO_RETENTION_PERCENTAGE - SIEM_6MO_RETENTION_USAGE - SIEM_6MO_RETENTION_PERCENTAGE - SIEM_ANALYZED_LOGS_ADD_ON_USAGE - SIEM_ANALYZED_LOGS_ADD_ON_PERCENTAGE - SIEM_INGESTED_BYTES_USAGE - SIEM_INGESTED_BYTES_PERCENTAGE - WORKFLOW_EXECUTIONS_USAGE - WORKFLOW_EXECUTIONS_PERCENTAGE - SCA_FARGATE_USAGE - SCA_FARGATE_PERCENTAGE - ALL MonthlyUsageAttributionValues: description: |- Fields in Usage Summary by tag(s). properties: api_percentage: description: The percentage of synthetic API test usage by tag(s). format: double type: number api_usage: description: The synthetic API test usage by tag(s). format: double type: number apm_fargate_percentage: description: The percentage of APM ECS Fargate task usage by tag(s). format: double type: number apm_fargate_usage: description: The APM ECS Fargate task usage by tag(s). format: double type: number apm_host_percentage: description: The percentage of APM host usage by tag(s). format: double type: number apm_host_usage: description: The APM host usage by tag(s). format: double type: number apm_usm_percentage: description: The percentage of APM and Universal Service Monitoring host usage by tag(s). format: double type: number apm_usm_usage: description: The APM and Universal Service Monitoring host usage by tag(s). format: double type: number appsec_fargate_percentage: description: The percentage of Application Security Monitoring ECS Fargate task usage by tag(s). format: double type: number appsec_fargate_usage: description: The Application Security Monitoring ECS Fargate task usage by tag(s). format: double type: number appsec_percentage: description: The percentage of Application Security Monitoring host usage by tag(s). format: double type: number appsec_usage: description: The Application Security Monitoring host usage by tag(s). format: double type: number asm_serverless_traced_invocations_percentage: description: The percentage of Application Security Monitoring Serverless traced invocations usage by tag(s). format: double type: number asm_serverless_traced_invocations_usage: description: The Application Security Monitoring Serverless traced invocations usage by tag(s). format: double type: number bits_ai_investigations_percentage: description: The percentage of Bits AI `SRE` investigation usage by tag(s). format: double type: number bits_ai_investigations_usage: description: The Bits AI `SRE` investigation usage by tag(s). format: double type: number browser_percentage: description: The percentage of synthetic browser test usage by tag(s). format: double type: number browser_usage: description: The synthetic browser test usage by tag(s). format: double type: number ci_code_coverage_committers_percentage: description: The percentage of Code Coverage committers usage by tag(s). format: double type: number ci_code_coverage_committers_usage: description: The total Code Coverage committers usage by tag(s). format: double type: number ci_pipeline_indexed_spans_percentage: description: The percentage of CI Pipeline Indexed Spans usage by tag(s). format: double type: number ci_pipeline_indexed_spans_usage: description: The total CI Pipeline Indexed Spans usage by tag(s). format: double type: number ci_test_indexed_spans_percentage: description: The percentage of CI Test Indexed Spans usage by tag(s). format: double type: number ci_test_indexed_spans_usage: description: The total CI Test Indexed Spans usage by tag(s). format: double type: number ci_visibility_itr_percentage: description: The percentage of Git committers for Intelligent Test Runner usage by tag(s). format: double type: number ci_visibility_itr_usage: description: The Git committers for Intelligent Test Runner usage by tag(s). format: double type: number cloud_siem_percentage: description: The percentage of Cloud Security Information and Event Management usage by tag(s). format: double type: number cloud_siem_usage: description: The Cloud Security Information and Event Management usage by tag(s). format: double type: number code_security_host_percentage: description: The percentage of Code Security host usage by tags. format: double type: number code_security_host_usage: description: The Code Security host usage by tags. format: double type: number container_excl_agent_percentage: description: The percentage of container usage without the Datadog Agent by tag(s). format: double type: number container_excl_agent_usage: description: The container usage without the Datadog Agent by tag(s). format: double type: number container_percentage: description: The percentage of container usage by tag(s). format: double type: number container_usage: description: The container usage by tag(s). format: double type: number cspm_containers_percentage: description: The percentage of Cloud Security Management Pro container usage by tag(s). format: double type: number cspm_containers_usage: description: The Cloud Security Management Pro container usage by tag(s). format: double type: number cspm_hosts_percentage: description: The percentage of Cloud Security Management Pro host usage by tag(s). format: double type: number cspm_hosts_usage: description: The Cloud Security Management Pro host usage by tag(s). format: double type: number custom_event_percentage: description: The percentage of Custom Events usage by tag(s). format: double type: number custom_event_usage: description: The total Custom Events usage by tag(s). format: double type: number custom_ingested_timeseries_percentage: description: The percentage of ingested custom metrics usage by tag(s). format: double type: number custom_ingested_timeseries_usage: description: The ingested custom metrics usage by tag(s). format: double type: number custom_timeseries_percentage: description: The percentage of indexed custom metrics usage by tag(s). format: double type: number custom_timeseries_usage: description: The indexed custom metrics usage by tag(s). format: double type: number cws_containers_percentage: description: The percentage of Cloud Workload Security container usage by tag(s). format: double type: number cws_containers_usage: description: The Cloud Workload Security container usage by tag(s). format: double type: number cws_fargate_task_percentage: description: The percentage of Cloud Workload Security Fargate task usage by tag(s). format: double type: number cws_fargate_task_usage: description: The Cloud Workload Security Fargate task usage by tag(s). format: double type: number cws_hosts_percentage: description: The percentage of Cloud Workload Security host usage by tag(s). format: double type: number cws_hosts_usage: description: The Cloud Workload Security host usage by tag(s). format: double type: number data_jobs_monitoring_usage: description: The Data Jobs Monitoring usage by tag(s). format: double type: number data_stream_monitoring_usage: description: The Data Stream Monitoring usage by tag(s). format: double type: number dbm_hosts_percentage: description: The percentage of Database Monitoring host usage by tag(s). format: double type: number dbm_hosts_usage: description: The Database Monitoring host usage by tag(s). format: double type: number dbm_queries_percentage: description: The percentage of Database Monitoring queries usage by tag(s). format: double type: number dbm_queries_usage: description: The Database Monitoring queries usage by tag(s). format: double type: number error_tracking_percentage: description: The percentage of error tracking events usage by tag(s). format: double type: number error_tracking_usage: description: The error tracking events usage by tag(s). format: double type: number estimated_indexed_spans_percentage: description: The percentage of estimated indexed spans usage by tag(s). format: double type: number estimated_indexed_spans_usage: description: The estimated indexed spans usage by tag(s). format: double type: number estimated_ingested_spans_percentage: description: The percentage of estimated ingested spans usage by tag(s). format: double type: number estimated_ingested_spans_usage: description: The estimated ingested spans usage by tag(s). format: double type: number fargate_percentage: description: The percentage of Fargate usage by tags. format: double type: number fargate_usage: description: The Fargate usage by tags. format: double type: number flex_logs_starter_percentage: description: The percentage of Flex Logs Starter usage by tags. format: double type: number flex_logs_starter_usage: description: The Flex Logs Starter usage by tags. format: double type: number flex_stored_logs_percentage: description: The percentage of Flex Stored Logs usage by tags. format: double type: number flex_stored_logs_usage: description: The Flex Stored Logs usage by tags. format: double type: number functions_percentage: description: The percentage of Lambda function usage by tag(s). format: double type: number functions_usage: description: The Lambda function usage by tag(s). format: double type: number incident_management_monthly_active_users_percentage: description: The percentage of Incident Management monthly active users usage by tag(s). format: double type: number incident_management_monthly_active_users_usage: description: The Incident Management monthly active users usage by tag(s). format: double type: number indexed_spans_percentage: description: The percentage of APM Indexed Spans usage by tag(s). format: double type: number indexed_spans_usage: description: The total APM Indexed Spans usage by tag(s). format: double type: number infra_host_basic_percentage: description: The percentage of infrastructure host Basic tier usage by tag(s). format: double type: number infra_host_basic_usage: description: The infrastructure host Basic tier usage by tag(s). format: double type: number infra_host_percentage: description: The percentage of infrastructure host usage by tag(s). format: double type: number infra_host_usage: description: The infrastructure host usage by tag(s). format: double type: number ingested_logs_bytes_percentage: description: The percentage of Ingested Logs usage by tag(s). format: double type: number ingested_logs_bytes_usage: description: The total Ingested Logs usage by tag(s). format: double type: number ingested_spans_bytes_percentage: description: The percentage of APM Ingested Spans usage by tag(s). format: double type: number ingested_spans_bytes_usage: description: The total APM Ingested Spans usage by tag(s). format: double type: number invocations_percentage: description: The percentage of Lambda invocation usage by tag(s). format: double type: number invocations_usage: description: The Lambda invocation usage by tag(s). format: double type: number lambda_traced_invocations_percentage: description: The percentage of Serverless APM usage by tag(s). format: double type: number lambda_traced_invocations_usage: description: The Serverless APM usage by tag(s). format: double type: number llm_observability_percentage: description: The percentage of LLM Observability usage by tag(s). format: double type: number llm_observability_usage: description: The LLM Observability usage by tag(s). format: double type: number llm_spans_percentage: description: The percentage of LLM Spans usage by tag(s). format: double type: number llm_spans_usage: description: The LLM Spans usage by tag(s). format: double type: number logs_indexed_15day_percentage: description: The percentage of Indexed Logs (15-day Retention) usage by tag(s). format: double type: number logs_indexed_15day_usage: description: The total Indexed Logs (15-day Retention) usage by tag(s). format: double type: number logs_indexed_180day_percentage: description: The percentage of Indexed Logs (180-day Retention) usage by tag(s). format: double type: number logs_indexed_180day_usage: description: The total Indexed Logs (180-day Retention) usage by tag(s). format: double type: number logs_indexed_1day_percentage: description: The percentage of Indexed Logs (1-day Retention) usage by tag(s). format: double type: number logs_indexed_1day_usage: description: The total Indexed Logs (1-day Retention) usage by tag(s). format: double type: number logs_indexed_30day_percentage: description: The percentage of Indexed Logs (30-day Retention) usage by tag(s). format: double type: number logs_indexed_30day_usage: description: The total Indexed Logs (30-day Retention) usage by tag(s). format: double type: number logs_indexed_360day_percentage: description: The percentage of Indexed Logs (360-day Retention) usage by tag(s). format: double type: number logs_indexed_360day_usage: description: The total Indexed Logs (360-day Retention) usage by tag(s). format: double type: number logs_indexed_3day_percentage: description: The percentage of Indexed Logs (3-day Retention) usage by tag(s). format: double type: number logs_indexed_3day_usage: description: The total Indexed Logs (3-day Retention) usage by tag(s). format: double type: number logs_indexed_45day_percentage: description: The percentage of Indexed Logs (45-day Retention) usage by tag(s). format: double type: number logs_indexed_45day_usage: description: The total Indexed Logs (45-day Retention) usage by tag(s). format: double type: number logs_indexed_60day_percentage: description: The percentage of Indexed Logs (60-day Retention) usage by tag(s). format: double type: number logs_indexed_60day_usage: description: The total Indexed Logs (60-day Retention) usage by tag(s). format: double type: number logs_indexed_7day_percentage: description: The percentage of Indexed Logs (7-day Retention) usage by tag(s). format: double type: number logs_indexed_7day_usage: description: The total Indexed Logs (7-day Retention) usage by tag(s). format: double type: number logs_indexed_90day_percentage: description: The percentage of Indexed Logs (90-day Retention) usage by tag(s). format: double type: number logs_indexed_90day_usage: description: The total Indexed Logs (90-day Retention) usage by tag(s). format: double type: number logs_indexed_custom_retention_percentage: description: The percentage of Indexed Logs (Custom Retention) usage by tag(s). format: double type: number logs_indexed_custom_retention_usage: description: The total Indexed Logs (Custom Retention) usage by tag(s). format: double type: number mobile_app_testing_percentage: description: The percentage of Synthetic mobile application test usage by tag(s). format: double type: number mobile_app_testing_usage: description: The Synthetic mobile application test usage by tag(s). format: double type: number ndm_netflow_percentage: description: The percentage of Network Device Monitoring NetFlow usage by tag(s). format: double type: number ndm_netflow_usage: description: The Network Device Monitoring NetFlow usage by tag(s). format: double type: number network_device_wireless_percentage: description: The percentage of network device wireless usage by tag(s). format: double type: number network_device_wireless_usage: description: The network device wireless usage by tag(s). format: double type: number npm_host_percentage: description: The percentage of network host usage by tag(s). format: double type: number npm_host_usage: description: The network host usage by tag(s). format: double type: number obs_pipeline_bytes_percentage: description: The percentage of observability pipeline bytes usage by tag(s). format: double type: number obs_pipeline_bytes_usage: description: The observability pipeline bytes usage by tag(s). format: double type: number obs_pipelines_vcpu_percentage: description: The percentage of observability pipeline per core usage by tag(s). format: double type: number obs_pipelines_vcpu_usage: description: The observability pipeline per core usage by tag(s). format: double type: number online_archive_percentage: description: The percentage of online archive usage by tag(s). format: double type: number online_archive_usage: description: The online archive usage by tag(s). format: double type: number product_analytics_session_percentage: description: The percentage of Product Analytics session usage by tag(s). format: double type: number product_analytics_session_usage: description: The Product Analytics session usage by tag(s). format: double type: number profiled_container_percentage: description: The percentage of profiled container usage by tag(s). format: double type: number profiled_container_usage: description: The profiled container usage by tag(s). format: double type: number profiled_fargate_percentage: description: The percentage of profiled Fargate task usage by tag(s). format: double type: number profiled_fargate_usage: description: The profiled Fargate task usage by tag(s). format: double type: number profiled_host_percentage: description: The percentage of profiled hosts usage by tag(s). format: double type: number profiled_host_usage: description: The profiled hosts usage by tag(s). format: double type: number published_app_percentage: description: The percentage of published application usage by tag(s). format: double type: number published_app_usage: description: The published application usage by tag(s). format: double type: number rum_browser_mobile_sessions_percentage: description: The percentage of RUM Browser and Mobile usage by tag(s). format: double type: number rum_browser_mobile_sessions_usage: description: The total RUM Browser and Mobile usage by tag(s). format: double type: number rum_ingested_percentage: description: The percentage of RUM Ingested usage by tag(s). format: double type: number rum_ingested_usage: description: The total RUM Ingested usage by tag(s). format: double type: number rum_investigate_percentage: description: The percentage of RUM Investigate usage by tag(s). format: double type: number rum_investigate_usage: description: The total RUM Investigate usage by tag(s). format: double type: number rum_replay_sessions_percentage: description: The percentage of RUM Session Replay usage by tag(s). format: double type: number rum_replay_sessions_usage: description: The total RUM Session Replay usage by tag(s). format: double type: number rum_session_replay_add_on_percentage: description: The percentage of RUM Session Replay Add-On usage by tag(s). format: double type: number rum_session_replay_add_on_usage: description: The total RUM Session Replay Add-On usage by tag(s). format: double type: number sca_fargate_percentage: description: The percentage of Software Composition Analysis Fargate task usage by tag(s). format: double type: number sca_fargate_usage: description: The total Software Composition Analysis Fargate task usage by tag(s). format: double type: number sds_scanned_bytes_percentage: description: The percentage of Sensitive Data Scanner usage by tag(s). format: double type: number sds_scanned_bytes_usage: description: The total Sensitive Data Scanner usage by tag(s). format: double type: number serverless_apps_apm_percentage: description: The percentage of Serverless Apps APM usage by tag(s). format: double type: number serverless_apps_apm_usage: description: The total Serverless Apps APM usage by tag(s). format: double type: number serverless_apps_percentage: description: The percentage of Serverless Apps usage by tag(s). format: double type: number serverless_apps_usage: description: The total Serverless Apps usage by tag(s). format: double type: number siem_12mo_retention_percentage: description: The percentage of Cloud SIEM Indexed Logs (12-month retention) usage by tag(s). format: double type: number siem_12mo_retention_usage: description: The Cloud SIEM Indexed Logs (12-month retention) usage by tag(s). format: double type: number siem_6mo_retention_percentage: description: The percentage of Cloud SIEM Indexed Logs (6-month retention) usage by tag(s). format: double type: number siem_6mo_retention_usage: description: The Cloud SIEM Indexed Logs (6-month retention) usage by tag(s). format: double type: number siem_analyzed_logs_add_on_percentage: description: The percentage of log events analyzed by Cloud SIEM usage by tag(s). format: double type: number siem_analyzed_logs_add_on_usage: description: The log events analyzed by Cloud SIEM usage by tag(s). format: double type: number siem_ingested_bytes_percentage: description: The percentage of SIEM usage by tag(s). format: double type: number siem_ingested_bytes_usage: description: The total SIEM usage by tag(s). format: double type: number snmp_percentage: description: The percentage of network device usage by tag(s). format: double type: number snmp_usage: description: The network device usage by tag(s). format: double type: number universal_service_monitoring_percentage: description: The percentage of universal service monitoring usage by tag(s). format: double type: number universal_service_monitoring_usage: description: The universal service monitoring usage by tag(s). format: double type: number vuln_management_hosts_percentage: description: The percentage of Application Vulnerability Management usage by tag(s). format: double type: number vuln_management_hosts_usage: description: The Application Vulnerability Management usage by tag(s). format: double type: number workflow_executions_percentage: description: The percentage of workflow executions usage by tag(s). format: double type: number workflow_executions_usage: description: The total workflow executions usage by tag(s). format: double type: number type: object NoteWidgetDefinition: description: The notes and links widget is similar to free text widget, but allows for more formatting options. properties: background_color: description: Background color of the note. type: string content: description: Content of the note. example: "" type: string font_size: description: Size of the text. type: string has_padding: default: true description: Whether to add padding or not. type: boolean show_tick: description: Whether to show a tick or not. type: boolean text_align: $ref: "#/components/schemas/WidgetTextAlign" tick_edge: $ref: "#/components/schemas/WidgetTickEdge" tick_pos: description: Where to position the tick on an edge. type: string type: $ref: "#/components/schemas/NoteWidgetDefinitionType" vertical_align: $ref: "#/components/schemas/WidgetVerticalAlign" required: - type - content type: object NoteWidgetDefinitionType: default: note description: Type of the note widget. enum: - note example: note type: string x-enum-varnames: - NOTE NotebookAbsoluteTime: description: Absolute timeframe. example: end: "2021-02-24T20:18:28+00:00" start: "2021-02-24T19:18:28+00:00" properties: end: description: The end time. example: "2021-02-24T20:18:28+00:00" format: date-time type: string live: description: Indicates whether the timeframe should be shifted to end at the current time. type: boolean start: description: The start time. example: "2021-02-24T19:18:28+00:00" format: date-time type: string required: - start - end type: object NotebookAuthor: description: Attributes of user object returned by the API. properties: created_at: description: Creation time of the user. format: date-time type: string disabled: description: Whether the user is disabled. type: boolean email: description: Email of the user. type: string handle: description: Handle of the user. type: string icon: description: URL of the user's icon. type: string name: description: Name of the user. nullable: true type: string status: description: Status of the user. type: string title: description: Title of the user. nullable: true type: string verified: description: Whether the user is verified. type: boolean type: object NotebookCellCreateRequest: additionalProperties: false description: The description of a notebook cell create request. properties: attributes: $ref: "#/components/schemas/NotebookCellCreateRequestAttributes" type: $ref: "#/components/schemas/NotebookCellResourceType" required: - attributes - type type: object NotebookCellCreateRequestAttributes: description: |- The attributes of a notebook cell in create cell request. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null} oneOf: - $ref: "#/components/schemas/NotebookMarkdownCellAttributes" - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes" - $ref: "#/components/schemas/NotebookToplistCellAttributes" - $ref: "#/components/schemas/NotebookHeatMapCellAttributes" - $ref: "#/components/schemas/NotebookDistributionCellAttributes" - $ref: "#/components/schemas/NotebookLogStreamCellAttributes" NotebookCellResourceType: default: notebook_cells description: Type of the Notebook Cell resource. enum: - notebook_cells example: notebook_cells type: string x-enum-varnames: - NOTEBOOK_CELLS NotebookCellResponse: description: The description of a notebook cell response. properties: attributes: $ref: "#/components/schemas/NotebookCellResponseAttributes" id: description: Notebook cell ID. example: "abcd1234" type: string type: $ref: "#/components/schemas/NotebookCellResourceType" required: - id - type - attributes type: object NotebookCellResponseAttributes: description: |- The attributes of a notebook cell response. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null} oneOf: - $ref: "#/components/schemas/NotebookMarkdownCellAttributes" - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes" - $ref: "#/components/schemas/NotebookToplistCellAttributes" - $ref: "#/components/schemas/NotebookHeatMapCellAttributes" - $ref: "#/components/schemas/NotebookDistributionCellAttributes" - $ref: "#/components/schemas/NotebookLogStreamCellAttributes" NotebookCellTime: description: Timeframe for the notebook cell. When 'null', the notebook global time is used. nullable: true oneOf: - $ref: "#/components/schemas/NotebookRelativeTime" - $ref: "#/components/schemas/NotebookAbsoluteTime" type: object NotebookCellUpdateRequest: description: The description of a notebook cell update request. properties: attributes: $ref: "#/components/schemas/NotebookCellUpdateRequestAttributes" id: description: Notebook cell ID. example: "abcd1234" type: string type: $ref: "#/components/schemas/NotebookCellResourceType" required: - id - type - attributes type: object NotebookCellUpdateRequestAttributes: description: |- The attributes of a notebook cell in update cell request. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null} oneOf: - $ref: "#/components/schemas/NotebookMarkdownCellAttributes" - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes" - $ref: "#/components/schemas/NotebookToplistCellAttributes" - $ref: "#/components/schemas/NotebookHeatMapCellAttributes" - $ref: "#/components/schemas/NotebookDistributionCellAttributes" - $ref: "#/components/schemas/NotebookLogStreamCellAttributes" NotebookCreateData: description: The data for a notebook create request. properties: attributes: $ref: "#/components/schemas/NotebookCreateDataAttributes" type: $ref: "#/components/schemas/NotebookResourceType" required: - type - attributes type: object NotebookCreateDataAttributes: description: The data attributes of a notebook. properties: cells: description: List of cells to display in the notebook. example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}] items: $ref: "#/components/schemas/NotebookCellCreateRequest" type: array metadata: $ref: "#/components/schemas/NotebookMetadata" name: description: The name of the notebook. example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: $ref: "#/components/schemas/NotebookStatus" time: $ref: "#/components/schemas/NotebookGlobalTime" required: - name - cells - time type: object NotebookCreateRequest: description: The description of a notebook create request. properties: data: $ref: "#/components/schemas/NotebookCreateData" required: - data type: object NotebookDistributionCellAttributes: description: The attributes of a notebook `distribution` cell. properties: definition: $ref: "#/components/schemas/DistributionWidgetDefinition" graph_size: $ref: "#/components/schemas/NotebookGraphSize" split_by: $ref: "#/components/schemas/NotebookSplitBy" time: $ref: "#/components/schemas/NotebookCellTime" required: - definition type: object NotebookGlobalTime: description: Notebook global timeframe. example: live_span: 1h oneOf: - $ref: "#/components/schemas/NotebookRelativeTime" - $ref: "#/components/schemas/NotebookAbsoluteTime" NotebookGraphSize: description: The size of the graph. enum: - xs - s - m - l - xl example: "m" type: string x-enum-varnames: - EXTRA_SMALL - SMALL - MEDIUM - LARGE - EXTRA_LARGE NotebookHeatMapCellAttributes: description: The attributes of a notebook `heatmap` cell. properties: definition: $ref: "#/components/schemas/HeatMapWidgetDefinition" graph_size: $ref: "#/components/schemas/NotebookGraphSize" split_by: $ref: "#/components/schemas/NotebookSplitBy" time: $ref: "#/components/schemas/NotebookCellTime" required: - definition type: object NotebookLogStreamCellAttributes: description: The attributes of a notebook `log_stream` cell. properties: definition: $ref: "#/components/schemas/LogStreamWidgetDefinition" graph_size: $ref: "#/components/schemas/NotebookGraphSize" time: $ref: "#/components/schemas/NotebookCellTime" required: - definition type: object NotebookMarkdownCellAttributes: description: The attributes of a notebook `markdown` cell. properties: definition: $ref: "#/components/schemas/NotebookMarkdownCellDefinition" required: - definition type: object NotebookMarkdownCellDefinition: description: >- Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/), which enables the use of headings, subheadings, links, images, lists, and code blocks. properties: text: description: The markdown content. example: "# Example Header \nexample content" type: string type: $ref: "#/components/schemas/NotebookMarkdownCellDefinitionType" required: - type - text type: object NotebookMarkdownCellDefinitionType: default: markdown description: Type of the markdown cell. enum: - markdown example: markdown type: string x-enum-varnames: - MARKDOWN NotebookMetadata: description: Metadata associated with the notebook. properties: is_template: default: false description: Whether or not the notebook is a template. example: false type: boolean take_snapshots: default: false description: Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs. example: false type: boolean type: $ref: "#/components/schemas/NotebookMetadataType" type: object NotebookMetadataType: description: Metadata type of the notebook. enum: - postmortem - runbook - investigation - documentation - report example: investigation nullable: true type: string x-enum-varnames: - POSTMORTEM - RUNBOOK - INVESTIGATION - DOCUMENTATION - REPORT NotebookRelativeTime: description: Relative timeframe. example: live_span: 1h nullable: true properties: live_span: $ref: "#/components/schemas/WidgetLiveSpan" required: - live_span type: object NotebookResourceType: default: notebooks description: Type of the Notebook resource. enum: - notebooks example: notebooks type: string x-enum-varnames: - NOTEBOOKS NotebookResponse: description: The description of a notebook response. properties: data: $ref: "#/components/schemas/NotebookResponseData" type: object NotebookResponseData: description: The data for a notebook. properties: attributes: $ref: "#/components/schemas/NotebookResponseDataAttributes" id: description: Unique notebook ID, assigned when you create the notebook. example: 123456 format: int64 readOnly: true type: integer type: $ref: "#/components/schemas/NotebookResourceType" required: - id - type - attributes type: object NotebookResponseDataAttributes: description: The attributes of a notebook. properties: author: $ref: "#/components/schemas/NotebookAuthor" cells: description: List of cells to display in the notebook. example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "id": "bzbycoya", "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "9k6bc6xc", "type": "notebook_cells"}] items: $ref: "#/components/schemas/NotebookCellResponse" type: array created: description: UTC time stamp for when the notebook was created. example: "2021-02-24T23:14:15.173964+00:00" format: date-time readOnly: true type: string metadata: $ref: "#/components/schemas/NotebookMetadata" modified: description: UTC time stamp for when the notebook was last modified. example: "2021-02-24T23:15:23.274966+00:00" format: date-time readOnly: true type: string name: description: The name of the notebook. example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: $ref: "#/components/schemas/NotebookStatus" time: $ref: "#/components/schemas/NotebookGlobalTime" required: - cells - time - name type: object NotebookSplitBy: description: Object describing how to split the graph to display multiple visualizations per request. example: {"keys": [], "tags": []} properties: keys: description: Keys to split on. example: - environment items: description: A key to split on. example: environment type: string type: array tags: description: Tags to split on. example: - environment:staging items: description: A tag to split on. example: environment:staging type: string type: array required: - keys - tags type: object NotebookStatus: default: published description: Publication status of the notebook. For now, always "published". enum: - published example: published type: string x-enum-varnames: - PUBLISHED NotebookTimeseriesCellAttributes: description: The attributes of a notebook `timeseries` cell. properties: definition: $ref: "#/components/schemas/TimeseriesWidgetDefinition" graph_size: $ref: "#/components/schemas/NotebookGraphSize" split_by: $ref: "#/components/schemas/NotebookSplitBy" time: $ref: "#/components/schemas/NotebookCellTime" required: - definition type: object NotebookToplistCellAttributes: description: The attributes of a notebook `toplist` cell. properties: definition: $ref: "#/components/schemas/ToplistWidgetDefinition" graph_size: $ref: "#/components/schemas/NotebookGraphSize" split_by: $ref: "#/components/schemas/NotebookSplitBy" time: $ref: "#/components/schemas/NotebookCellTime" required: - definition type: object NotebookUpdateCell: description: |- Updating a notebook can either insert new cell(s) or update existing cell(s) by including the cell `id`. To delete existing cell(s), simply omit it from the list of cells. oneOf: - $ref: "#/components/schemas/NotebookCellCreateRequest" - $ref: "#/components/schemas/NotebookCellUpdateRequest" NotebookUpdateData: description: The data for a notebook update request. properties: attributes: $ref: "#/components/schemas/NotebookUpdateDataAttributes" type: $ref: "#/components/schemas/NotebookResourceType" required: - type - attributes type: object NotebookUpdateDataAttributes: description: The data attributes of a notebook. properties: cells: description: List of cells to display in the notebook. example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "id": "bzbycoya", "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "9k6bc6xc", "type": "notebook_cells"}] items: $ref: "#/components/schemas/NotebookUpdateCell" type: array metadata: $ref: "#/components/schemas/NotebookMetadata" name: description: The name of the notebook. example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: $ref: "#/components/schemas/NotebookStatus" time: $ref: "#/components/schemas/NotebookGlobalTime" required: - name - cells - time type: object NotebookUpdateRequest: description: The description of a notebook update request. properties: data: $ref: "#/components/schemas/NotebookUpdateData" required: - data type: object NotebooksResponse: description: Notebooks get all response. properties: data: description: List of notebook definitions. items: $ref: "#/components/schemas/NotebooksResponseData" type: array meta: $ref: "#/components/schemas/NotebooksResponseMeta" type: object NotebooksResponseData: description: The data for a notebook in get all response. properties: attributes: $ref: "#/components/schemas/NotebooksResponseDataAttributes" id: description: Unique notebook ID, assigned when you create the notebook. example: 123456 format: int64 readOnly: true type: integer type: $ref: "#/components/schemas/NotebookResourceType" required: - id - type - attributes type: object NotebooksResponseDataAttributes: description: The attributes of a notebook in get all response. properties: author: $ref: "#/components/schemas/NotebookAuthor" cells: description: List of cells to display in the notebook. items: $ref: "#/components/schemas/NotebookCellResponse" type: array created: description: UTC time stamp for when the notebook was created. example: "2021-02-24T23:14:15.173964+00:00" format: date-time readOnly: true type: string metadata: $ref: "#/components/schemas/NotebookMetadata" modified: description: UTC time stamp for when the notebook was last modified. example: "2021-02-24T23:15:23.274966+00:00" format: date-time readOnly: true type: string name: description: The name of the notebook. example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: $ref: "#/components/schemas/NotebookStatus" time: $ref: "#/components/schemas/NotebookGlobalTime" required: - name type: object NotebooksResponseMeta: description: Searches metadata returned by the API. properties: page: $ref: "#/components/schemas/NotebooksResponsePage" type: object NotebooksResponsePage: description: Pagination metadata returned by the API. properties: total_count: description: >- The total number of notebooks that would be returned if the request was not filtered by `start` and `count` parameters. format: int64 type: integer total_filtered_count: description: The total number of notebooks returned. format: int64 type: integer type: object NotifyEndState: description: A notification end state. enum: - alert - no data - warn example: alert type: string x-enum-varnames: - ALERT - NO_DATA - WARN NotifyEndStates: default: ["alert", "no data", "warn"] description: States for which `notify_end_types` sends out notifications for. example: ["alert", "no data", "warn"] items: $ref: "#/components/schemas/NotifyEndState" type: array NotifyEndType: description: A notification end type. enum: - canceled - expired example: expired type: string x-enum-varnames: - CANCELED - EXPIRED NotifyEndTypes: default: ["expired"] description: |- If set, notifies if a monitor is in an alert-worthy state (`ALERT`, `WARNING`, or `NO DATA`) when this downtime expires or is canceled. Applied to monitors that change states during the downtime (such as from `OK` to `ALERT`, `WARNING`, or `NO DATA`), and to monitors that already have an alert-worthy state when downtime begins. example: ["canceled", "expired"] items: $ref: "#/components/schemas/NotifyEndType" type: array NumberFormatUnit: description: Number format unit. oneOf: - $ref: "#/components/schemas/NumberFormatUnitCanonical" - $ref: "#/components/schemas/NumberFormatUnitCustom" NumberFormatUnitCanonical: description: Canonical unit. properties: per_unit_name: description: The name of the unit per item. example: "bytes" type: string type: $ref: "#/components/schemas/NumberFormatUnitScaleType" unit_name: description: The name of the unit. example: "bytes" type: string type: object NumberFormatUnitCustom: description: Custom unit. properties: label: description: The label for the custom unit. maxLength: 12 minLength: 1 type: string type: $ref: "#/components/schemas/NumberFormatUnitCustomType" type: object NumberFormatUnitCustomType: description: The type of custom unit. enum: - custom_unit_label type: string x-enum-varnames: - CUSTOM_UNIT_LABEL NumberFormatUnitScale: description: The definition of `NumberFormatUnitScale` object. nullable: true properties: type: $ref: "#/components/schemas/NumberFormatUnitScaleType" unit_name: description: The name of the unit. example: "bytes" type: string type: object NumberFormatUnitScaleType: description: The type of unit scale. enum: - canonical_unit example: canonical_unit type: string x-enum-varnames: - CANONICAL_UNIT OnMissingDataOption: description: |- Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. enum: - "default" - "show_no_data" - "show_and_notify_no_data" - "resolve" type: string x-enum-varnames: - DEFAULT - SHOW_NO_DATA - SHOW_AND_NOTIFY_NO_DATA - RESOLVE OrgDowngradedResponse: description: Status of downgrade properties: message: description: Information pertaining to the downgraded child organization. type: string type: object Organization: description: Create, edit, and manage organizations. properties: billing: $ref: "#/components/schemas/OrganizationBilling" created: description: Date of the organization creation. example: "2019-09-26T17:28:28Z" readOnly: true type: string description: description: Description of the organization. example: "some description" type: string name: description: The name of the child organization, limited to 32 characters. example: "New child org" maxLength: 32 type: string public_id: description: The `public_id` of the organization you are operating within. example: "abcdef12345" type: string settings: $ref: "#/components/schemas/OrganizationSettings" subscription: $ref: "#/components/schemas/OrganizationSubscription" trial: description: Only available for MSP customers. Allows child organizations to be created on a trial plan. example: false type: boolean type: object OrganizationBilling: deprecated: true description: A JSON array of billing type. example: {"type": "parent_billing"} properties: type: description: The type of billing. Only `parent_billing` is supported. type: string type: object OrganizationCreateBody: description: Object describing an organization to create. properties: billing: $ref: "#/components/schemas/OrganizationBilling" name: description: The name of the new child-organization, limited to 32 characters. example: "New child org" maxLength: 32 type: string subscription: $ref: "#/components/schemas/OrganizationSubscription" required: - name type: object OrganizationCreateResponse: description: Response object for an organization creation. properties: api_key: $ref: "#/components/schemas/ApiKey" application_key: $ref: "#/components/schemas/ApplicationKey" org: $ref: "#/components/schemas/Organization" user: $ref: "#/components/schemas/User" type: object OrganizationListResponse: description: Response with the list of organizations. properties: orgs: description: Array of organization objects. items: $ref: "#/components/schemas/Organization" type: array type: object OrganizationResponse: description: Response with an organization. properties: org: $ref: "#/components/schemas/Organization" type: object OrganizationSettings: description: A JSON array of settings. properties: private_widget_share: description: Whether or not the organization users can share widgets outside of Datadog. example: false type: boolean saml: $ref: "#/components/schemas/OrganizationSettingsSaml" saml_autocreate_access_role: $ref: "#/components/schemas/AccessRole" saml_autocreate_users_domains: $ref: "#/components/schemas/OrganizationSettingsSamlAutocreateUsersDomains" saml_can_be_enabled: description: Whether or not SAML can be enabled for this organization. example: false type: boolean saml_idp_endpoint: description: Identity provider endpoint for SAML authentication. example: "https://my.saml.endpoint" type: string saml_idp_initiated_login: $ref: "#/components/schemas/OrganizationSettingsSamlIdpInitiatedLogin" saml_idp_metadata_uploaded: description: Whether or not a SAML identity provider metadata file was provided to the Datadog organization. example: false type: boolean saml_login_url: description: URL for SAML logging. example: "https://my.saml.login.url" type: string saml_strict_mode: $ref: "#/components/schemas/OrganizationSettingsSamlStrictMode" type: object OrganizationSettingsSaml: description: |- Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings. properties: enabled: description: Whether or not SAML is enabled for this organization. example: false type: boolean type: object OrganizationSettingsSamlAutocreateUsersDomains: description: Has two properties, `enabled` (boolean) and `domains`, which is a list of domains without the @ symbol. properties: domains: description: List of domains where the SAML automated user creation is enabled. items: description: Domain to automate user creation from. example: "example.com" type: string type: array enabled: description: Whether or not the automated user creation based on SAML domain is enabled. example: false type: boolean type: object OrganizationSettingsSamlIdpInitiatedLogin: description: Has one property enabled (boolean). properties: enabled: description: |- Whether SAML IdP initiated login is enabled, learn more in the [SAML documentation](https://docs.datadoghq.com/account_management/saml/#idp-initiated-login). example: false type: boolean type: object OrganizationSettingsSamlStrictMode: description: Has one property enabled (boolean). properties: enabled: description: |- Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the [SAML Strict documentation](https://docs.datadoghq.com/account_management/saml/#saml-strict). example: false type: boolean type: object OrganizationSubscription: deprecated: true description: Subscription definition. example: {"type": "pro"} properties: type: description: The subscription type. Types available are `trial`, `free`, and `pro`. type: string type: object PagerDutyService: description: |- The PagerDuty service that is available for integration with Datadog. properties: service_key: description: Your service key in PagerDuty. example: "" type: string service_name: description: Your service name associated with a service key in PagerDuty. example: "" type: string required: - service_name - service_key type: object PagerDutyServiceKey: description: PagerDuty service object key. properties: service_key: description: Your service key in PagerDuty. example: "" type: string required: - service_key type: object PagerDutyServiceName: description: PagerDuty service object name. properties: service_name: description: Your service name associated service key in PagerDuty. example: "" type: string required: - service_name type: object Pagination: description: Pagination object. properties: total_count: description: Total count. format: int64 type: integer total_filtered_count: description: Total count of elements matched by the filter. format: int64 type: integer type: object Point: description: Array of timeseries points. example: [1575317847.0, 0.5] items: description: |- Each point is of the form `[POSIX_timestamp, numeric_value]`. The timestamp should be in seconds and current. The numeric value format should be a 32bit float gauge-type value. Current is defined as not more than 10 minutes in the future or more than 1 hour in the past. format: double nullable: true type: number maxItems: 2 minItems: 2 type: array PointPlotDimension: description: Dimension of the point plot. enum: - group - time - y - radius example: y type: string x-enum-varnames: - GROUP - TIME - Y - RADIUS PointPlotProjection: description: Projection configuration for the point plot widget. properties: dimensions: description: List of dimension mappings for the projection. items: $ref: "#/components/schemas/PointPlotProjectionDimension" type: array extra_columns: description: Additional columns to include in the projection. items: description: Column name. type: string type: array type: $ref: "#/components/schemas/PointPlotProjectionType" required: - type - dimensions type: object PointPlotProjectionDimension: description: Dimension mapping for the point plot projection. properties: alias: description: Alias for the column. type: string column: description: Source column name from the dataset. example: duration type: string dimension: $ref: "#/components/schemas/PointPlotDimension" required: - column - dimension type: object PointPlotProjectionType: description: Type of the projection. enum: - point_plot example: point_plot type: string x-enum-varnames: - POINT_PLOT PointPlotWidgetDefinition: description: The point plot displays individual data points over time. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string legend: $ref: "#/components/schemas/PointPlotWidgetLegend" markers: description: List of markers for the widget. items: $ref: "#/components/schemas/WidgetMarker" type: array requests: description: List of request configurations for the widget. items: $ref: "#/components/schemas/PointPlotWidgetRequest" type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/PointPlotWidgetDefinitionType" yaxis: $ref: "#/components/schemas/WidgetAxis" required: - type - requests type: object PointPlotWidgetDefinitionType: default: point_plot description: Type of the point plot widget. enum: - point_plot example: point_plot type: string x-enum-varnames: - POINT_PLOT PointPlotWidgetLegend: description: Legend configuration for the point plot widget. properties: type: $ref: "#/components/schemas/PointPlotWidgetLegendType" required: - type type: object PointPlotWidgetLegendType: description: Type of legend to show for the point plot widget. enum: - automatic - none example: automatic type: string x-enum-varnames: - AUTOMATIC - NONE PointPlotWidgetRequest: description: Request configuration for the point plot widget. properties: limit: description: Maximum number of data points to return. format: int64 type: integer projection: $ref: "#/components/schemas/PointPlotProjection" query: $ref: "#/components/schemas/DataProjectionQuery" request_type: $ref: "#/components/schemas/DataProjectionRequestType" required: - request_type - query - projection type: object PowerpackTemplateVariableContents: description: Powerpack template variable contents. properties: name: description: The name of the variable. example: host1 type: string prefix: description: The tag prefix associated with the variable. type: string values: description: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. example: - my-host - host1 - host2 items: description: One or more possible values of the template variable. minLength: 1 type: string type: array required: - name - values type: object PowerpackTemplateVariables: description: Powerpack template variables. properties: controlled_by_powerpack: description: Template variables controlled at the powerpack level. items: $ref: "#/components/schemas/PowerpackTemplateVariableContents" type: array controlled_externally: description: "Template variables controlled by the external resource, such as the dashboard this powerpack is on." items: $ref: "#/components/schemas/PowerpackTemplateVariableContents" type: array type: object PowerpackWidgetDefinition: description: The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. properties: background_color: description: Background color of the powerpack title. type: string banner_img: description: URL of image to display as a banner for the powerpack. type: string powerpack_id: description: UUID of the associated powerpack. example: "df43cf2a-6475-490d-b686-6fbc6cb9a49c" type: string show_title: default: true description: Whether to show the title or not. type: boolean template_variables: $ref: "#/components/schemas/PowerpackTemplateVariables" title: description: Title of the widget. type: string type: $ref: "#/components/schemas/PowerpackWidgetDefinitionType" required: - type - powerpack_id type: object PowerpackWidgetDefinitionType: default: powerpack description: Type of the powerpack widget. enum: - powerpack example: powerpack type: string x-enum-varnames: - POWERPACK ProcessQueryDefinition: description: The process query to use in the widget. properties: filter_by: description: List of processes. items: description: Process name. type: string type: array limit: description: Max number of items in the filter list. format: int64 minimum: 0 type: integer metric: description: Your chosen metric. example: "system.load.1" type: string search_by: description: Your chosen search term. type: string required: - metric type: object ProductAnalyticsAudienceAccountSubquery: description: Product Analytics audience account subquery. properties: name: description: The name of the account subquery. type: string query: description: The query string for the account subquery. type: string type: object ProductAnalyticsAudienceFilters: description: Product Analytics/RUM audience filters. properties: accounts: items: $ref: "#/components/schemas/ProductAnalyticsAudienceAccountSubquery" type: array filter_condition: description: An optional filter condition applied to the audience subquery. type: string segments: items: $ref: "#/components/schemas/ProductAnalyticsAudienceSegmentSubquery" type: array users: items: $ref: "#/components/schemas/ProductAnalyticsAudienceUserSubquery" type: array type: object ProductAnalyticsAudienceOccurrenceFilter: description: Filter applied to occurrence counts when building a Product Analytics audience. properties: operator: description: "The comparison operator used for the occurrence filter (for example: `gt`, `lt`, `eq`)." type: string value: description: The threshold value to compare occurrence counts against. type: string type: object ProductAnalyticsAudienceSegmentSubquery: description: Product Analytics audience segment subquery. properties: name: description: The name of the segment subquery. type: string segment_id: description: The unique identifier of the segment. type: string type: object ProductAnalyticsAudienceUserSubquery: description: Product Analytics audience user subquery. properties: name: description: The name of the user subquery. type: string query: description: The query string for the user subquery. type: string type: object ProductAnalyticsBaseQuery: $ref: "#/components/schemas/ProductAnalyticsEventQuery" description: Base query for Product Analytics. ProductAnalyticsEventDataSource: description: Data source for Product Analytics event queries. enum: - product_analytics example: product_analytics type: string x-enum-varnames: - PRODUCT_ANALYTICS ProductAnalyticsEventQuery: additionalProperties: false description: Product Analytics event query. properties: data_source: $ref: "#/components/schemas/ProductAnalyticsEventDataSource" search: $ref: "#/components/schemas/ProductAnalyticsEventQuerySearch" required: - data_source - search type: object ProductAnalyticsEventQuerySearch: additionalProperties: false description: Search configuration for Product Analytics event query. properties: query: description: RUM event search query used to filter views or actions. example: "@type:view @view.name:/home" type: string required: - query type: object ProductAnalyticsExtendedCompute: additionalProperties: false description: Compute configuration for Product Analytics Extended queries. properties: aggregation: $ref: "#/components/schemas/FormulaAndFunctionEventAggregation" interval: description: Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. example: 60000 format: double type: number metric: description: Measurable attribute to compute. example: "@usr.id" type: string name: description: Name of the compute for use in formulas. example: "query1" type: string rollup: $ref: "#/components/schemas/CalendarInterval" description: Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. required: - aggregation type: object ProductAnalyticsExtendedGroupBy: description: Group by configuration for Product Analytics Extended queries. properties: facet: description: Facet name to group by. example: "@geo.country" type: string limit: description: Maximum number of groups to return. example: 10 format: int32 maximum: 10000 type: integer should_exclude_missing: description: Whether to exclude events missing the group-by facet. type: boolean sort: $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort" required: - facet type: object ProductAnalyticsFunnelCompute: additionalProperties: false description: Compute configuration for user journey funnel. properties: aggregation: $ref: "#/components/schemas/ProductAnalyticsFunnelComputeAggregation" metric: $ref: "#/components/schemas/ProductAnalyticsFunnelComputeMetric" required: - aggregation - metric type: object ProductAnalyticsFunnelComputeAggregation: description: Aggregation type for user journey funnel compute. enum: - cardinality - count example: count type: string x-enum-varnames: - CARDINALITY - COUNT ProductAnalyticsFunnelComputeMetric: description: Metric for user journey funnel compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` (unique users/sessions) and `cardinality` (total users/sessions) as aggregations. enum: - __dd.conversion - __dd.conversion_rate example: __dd.conversion_rate type: string x-enum-varnames: - CONVERSION - CONVERSION_RATE ProductAnalyticsFunnelDataSource: description: Data source for user journey funnel queries. enum: - product_analytics_journey example: product_analytics_journey type: string x-enum-varnames: - PRODUCT_ANALYTICS_JOURNEY ProductAnalyticsFunnelGroupBy: description: Group by configuration for user journey funnel. properties: facet: description: Facet to group by. example: "@usr.email" type: string limit: description: Maximum number of groups. format: int64 type: integer should_exclude_missing: description: Whether to exclude missing values. type: boolean sort: $ref: "#/components/schemas/ProductAnalyticsFunnelGroupBySort" target: $ref: "#/components/schemas/UserJourneySearchTarget" required: - facet type: object ProductAnalyticsFunnelGroupBySort: additionalProperties: false description: Sort configuration for user journey funnel group by. properties: aggregation: description: Aggregation type. example: "count" type: string metric: description: Metric to sort by. example: "@session.id" type: string order: $ref: "#/components/schemas/WidgetSort" required: - aggregation type: object ProductAnalyticsFunnelQuery: additionalProperties: false description: User journey funnel query definition. properties: compute: $ref: "#/components/schemas/ProductAnalyticsFunnelCompute" data_source: $ref: "#/components/schemas/ProductAnalyticsFunnelDataSource" group_by: description: Group by configuration. items: $ref: "#/components/schemas/ProductAnalyticsFunnelGroupBy" description: A user journey funnel group by configuration. type: array search: $ref: "#/components/schemas/UserJourneySearch" subquery_id: description: Subquery ID. type: string required: - data_source - search type: object ProductAnalyticsFunnelRequest: additionalProperties: false description: User journey funnel widget request. properties: comparison_segments: description: Comparison segments. items: description: Segment identifier. minLength: 1 type: string minItems: 1 type: array comparison_time: $ref: "#/components/schemas/FunnelComparisonDuration" query: $ref: "#/components/schemas/ProductAnalyticsFunnelQuery" request_type: $ref: "#/components/schemas/ProductAnalyticsFunnelRequestType" required: - query - request_type type: object ProductAnalyticsFunnelRequestType: description: Request type for user journey funnel widget. enum: - user_journey_funnel example: user_journey_funnel type: string x-enum-varnames: - USER_JOURNEY_FUNNEL ProductAnalyticsFunnelWidgetDefinition: additionalProperties: false description: The user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics. properties: description: description: The description of the widget. type: string grouped_display: $ref: "#/components/schemas/FunnelGroupedDisplay" requests: description: Request payload used to query items. example: - query: compute: aggregation: cardinality metric: __dd.conversion data_source: product_analytics_journey search: expression: "step1 -> step2" filters: string_filter: "@application.id:xxx @geo.country:France" node_objects: step1: data_source: product_analytics search: query: "@type:view @view.name:/home" step2: data_source: product_analytics search: query: '@type:action @action.name:"add to cart"' request_type: user_journey_funnel items: $ref: "#/components/schemas/ProductAnalyticsFunnelRequest" description: A user journey funnel widget request. minItems: 1 type: array time: $ref: "#/components/schemas/WidgetTime" title: description: The title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: The size of the title. type: string type: $ref: "#/components/schemas/FunnelWidgetDefinitionType" required: - type - requests type: object QuerySortOrder: default: desc description: Direction of sort. enum: - asc - desc type: string x-enum-varnames: - ASC - DESC QueryValueWidgetComparison: description: A change indicator that compares the current value to a historical period. properties: directionality: $ref: "#/components/schemas/QueryValueWidgetComparisonDirectionality" description: Which direction of change is considered an improvement, determining the indicator color. duration: $ref: "#/components/schemas/ComparisonDuration" type: $ref: "#/components/schemas/QueryValueWidgetComparisonType" required: - duration type: object QueryValueWidgetComparisonDirectionality: default: neutral description: "Color-coding direction: `increase_better` (green on rise), `decrease_better` (green on drop), or `neutral` (no color)." enum: - increase_better - decrease_better - neutral type: string x-enum-varnames: - INCREASE_BETTER - DECREASE_BETTER - NEUTRAL QueryValueWidgetComparisonType: default: absolute description: "How the delta is expressed: `absolute` (raw difference), `relative` (percentage), or `both`." enum: - absolute - relative - both type: string x-enum-varnames: - ABSOLUTE - RELATIVE - BOTH QueryValueWidgetDefinition: description: Query values display the current value of a given metric, APM, or log query. properties: autoscale: description: Whether to use auto-scaling or not. type: boolean custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array custom_unit: description: Display a unit of your choice on the widget. type: string description: description: The description of the widget. type: string precision: description: Number of decimals to show. If not defined, the widget uses the raw value. format: int64 type: integer requests: description: Widget definition. example: ["q/apm_query/log_query": "{}"] items: $ref: "#/components/schemas/QueryValueWidgetRequest" maxItems: 1 minItems: 1 type: array text_align: $ref: "#/components/schemas/WidgetTextAlign" time: $ref: "#/components/schemas/WidgetTime" timeseries_background: $ref: "#/components/schemas/TimeseriesBackground" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/QueryValueWidgetDefinitionType" required: - type - requests type: object QueryValueWidgetDefinitionType: default: query_value description: Type of the query value widget. enum: - query_value example: query_value type: string x-enum-varnames: - QUERY_VALUE QueryValueWidgetRequest: description: Updated query value widget. properties: aggregator: $ref: "#/components/schemas/WidgetAggregator" apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. comparison: $ref: "#/components/schemas/QueryValueWidgetComparison" description: Displays a change indicator showing a delta against a historical baseline. conditional_formats: description: List of conditional formats. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. type: object ReferenceTableLogsLookupProcessor: description: |- **Note**: Reference Tables are in public beta. Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in a Reference Table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean lookup_enrichment_table: description: |- Name of the Reference Table for the source attribute and their associated target attribute values. example: "service_id_to_service_name_table" type: string name: description: Name of the processor. type: string source: description: Source attribute used to perform the lookup. example: service_id type: string target: description: |- Name of the attribute that contains the corresponding value in the mapping list. example: service type: string type: $ref: "#/components/schemas/LogsLookupProcessorType" required: - source - target - lookup_enrichment_table - type type: object ResourceProviderConfig: description: Configuration settings applied to resources from the specified Azure resource provider. properties: metrics_enabled: description: Collect metrics for resources from this provider. example: true type: boolean namespace: description: The provider namespace to apply this configuration to. example: Microsoft.Compute type: string type: object ResponseMetaAttributes: description: Object describing meta attributes of response. properties: page: $ref: "#/components/schemas/Pagination" type: object RetentionCohortCriteria: additionalProperties: false description: Cohort criteria for retention queries. properties: base_query: $ref: "#/components/schemas/ProductAnalyticsBaseQuery" time_interval: $ref: "#/components/schemas/RetentionCohortCriteriaTimeInterval" required: - base_query - time_interval type: object RetentionCohortCriteriaTimeInterval: additionalProperties: false description: Time interval for cohort criteria. properties: type: $ref: "#/components/schemas/RetentionCohortCriteriaTimeIntervalType" value: $ref: "#/components/schemas/CalendarInterval" required: - type - value type: object RetentionCohortCriteriaTimeIntervalType: description: Type of time interval for cohort criteria. enum: - calendar example: calendar type: string x-enum-varnames: - CALENDAR RetentionCompute: additionalProperties: false description: Compute configuration for retention queries. properties: aggregation: $ref: "#/components/schemas/EventsAggregation" metric: $ref: "#/components/schemas/RetentionComputeMetric" required: - aggregation - metric type: object RetentionComputeMetric: description: Metric for retention compute. enum: - __dd.retention - __dd.retention_rate example: __dd.retention_rate type: string x-enum-varnames: - RETENTION - RETENTION_RATE RetentionCurveRequestType: description: Request type for retention curve widget. enum: - retention_curve example: retention_curve type: string x-enum-varnames: - RETENTION_CURVE RetentionCurveStyle: additionalProperties: false description: Style configuration for retention curve. properties: palette: description: Color palette for the retention curve. example: "dog_classic" type: string type: object RetentionCurveWidgetDefinition: additionalProperties: false description: The retention curve widget visualizes user retention rates over time. properties: description: description: The description of the widget. type: string requests: description: List of Retention Curve widget requests. example: - query: compute: aggregation: count metric: __dd.retention_rate data_source: product_analytics_retention search: cohort_criteria: base_query: data_source: product_analytics search: query: "@type:view @view.name:/home" time_interval: type: calendar value: type: week retention_entity: "@usr.id" return_condition: conversion_on_or_after return_criteria: base_query: data_source: product_analytics search: query: "@type:view @view.name:/checkout" request_type: retention_curve items: $ref: "#/components/schemas/RetentionCurveWidgetRequest" description: A retention curve widget request. minItems: 1 type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/RetentionCurveWidgetDefinitionType" required: - type - requests type: object RetentionCurveWidgetDefinitionType: default: retention_curve description: Type of the Retention Curve widget. enum: - retention_curve example: retention_curve type: string x-enum-varnames: - RETENTION_CURVE RetentionCurveWidgetRequest: additionalProperties: false description: Retention curve widget request. properties: query: $ref: "#/components/schemas/RetentionQuery" request_type: $ref: "#/components/schemas/RetentionCurveRequestType" style: $ref: "#/components/schemas/RetentionCurveStyle" required: - request_type - query type: object RetentionDataSource: description: Data source for retention queries. enum: - product_analytics_retention example: product_analytics_retention type: string x-enum-varnames: - PRODUCT_ANALYTICS_RETENTION RetentionEntity: description: Entity to track for retention. enum: - "@usr.id" - "@account.id" example: "@usr.id" type: string x-enum-varnames: - USER_ID - ACCOUNT_ID RetentionFilters: additionalProperties: false description: Filters for retention queries. properties: audience_filters: $ref: "#/components/schemas/ProductAnalyticsAudienceFilters" string_filter: description: String filter. example: "@session.type:user" type: string type: object RetentionGridRequest: additionalProperties: false description: Retention grid widget request. properties: query: $ref: "#/components/schemas/RetentionQuery" request_type: $ref: "#/components/schemas/RetentionGridRequestType" required: - request_type - query type: object RetentionGridRequestType: description: Request type for retention grid widget. enum: - retention_grid example: retention_grid type: string x-enum-varnames: - RETENTION_GRID RetentionGroupBy: additionalProperties: false description: Group by configuration for retention queries. properties: facet: description: Facet to group by. example: "@geo.country" type: string limit: description: Maximum number of groups. example: 10 format: int64 type: integer should_exclude_missing: description: Whether to exclude missing values. example: false type: boolean sort: $ref: "#/components/schemas/RetentionGroupBySort" source: description: Source field. example: "@geo.country" type: string target: $ref: "#/components/schemas/RetentionGroupByTarget" required: - target - facet type: object RetentionGroupBySort: additionalProperties: false description: Sort configuration for retention group by. properties: order: $ref: "#/components/schemas/WidgetSort" type: object RetentionGroupByTarget: description: Target for retention group by. enum: - cohort - return_period example: cohort type: string x-enum-varnames: - COHORT - RETURN_PERIOD RetentionQuery: additionalProperties: false description: Retention query definition. properties: compute: $ref: "#/components/schemas/RetentionCompute" data_source: $ref: "#/components/schemas/RetentionDataSource" filters: $ref: "#/components/schemas/RetentionFilters" group_by: description: Group by configuration. items: $ref: "#/components/schemas/RetentionGroupBy" description: A retention group by configuration. type: array name: description: Name of the query. example: "retention_query" type: string search: $ref: "#/components/schemas/RetentionSearch" required: - data_source - search - compute type: object RetentionReturnCondition: description: Condition for counting user return. enum: - conversion_on - conversion_on_or_after example: conversion_on_or_after type: string x-enum-varnames: - CONVERSION_ON - CONVERSION_ON_OR_AFTER RetentionReturnCriteria: additionalProperties: false description: Return criteria for retention queries. properties: base_query: $ref: "#/components/schemas/ProductAnalyticsBaseQuery" time_interval: $ref: "#/components/schemas/RetentionReturnCriteriaTimeInterval" required: - base_query type: object RetentionReturnCriteriaTimeInterval: additionalProperties: false description: Time interval for return criteria. properties: type: $ref: "#/components/schemas/RetentionReturnCriteriaTimeIntervalType" unit: $ref: "#/components/schemas/RetentionReturnCriteriaTimeIntervalUnit" value: description: Value of the time interval. example: 0.0 format: double type: number required: - type - value - unit type: object RetentionReturnCriteriaTimeIntervalType: description: Type of time interval for return criteria. enum: - fixed example: fixed type: string x-enum-varnames: - FIXED RetentionReturnCriteriaTimeIntervalUnit: description: Unit of time for retention return criteria interval. enum: - day - week - month example: day type: string x-enum-varnames: - DAY - WEEK - MONTH RetentionSearch: additionalProperties: false description: Search configuration for retention queries. properties: cohort_criteria: $ref: "#/components/schemas/RetentionCohortCriteria" filters: $ref: "#/components/schemas/RetentionFilters" retention_entity: $ref: "#/components/schemas/RetentionEntity" return_condition: $ref: "#/components/schemas/RetentionReturnCondition" return_criteria: $ref: "#/components/schemas/RetentionReturnCriteria" required: - cohort_criteria - retention_entity - return_condition type: object RunWorkflowWidgetDefinition: description: Run workflow is widget that allows you to run a workflow from a dashboard. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string inputs: description: Array of workflow inputs to map to dashboard template variables. items: $ref: "#/components/schemas/RunWorkflowWidgetInput" type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/RunWorkflowWidgetDefinitionType" workflow_id: description: Workflow id. example: "" type: string required: - type - workflow_id type: object RunWorkflowWidgetDefinitionType: default: run_workflow description: Type of the run workflow widget. enum: - run_workflow example: run_workflow type: string x-enum-varnames: - RUN_WORKFLOW RunWorkflowWidgetInput: description: Object to map a dashboard template variable to a workflow input. properties: name: description: Name of the workflow input. example: Environment type: string value: description: Dashboard template variable. Can be suffixed with '.value' or '.key'. example: "$env.value" type: string required: - name - value type: object SLOBulkDelete: additionalProperties: description: An array of all SLO timeframes. items: $ref: "#/components/schemas/SLOTimeframe" type: array description: |- A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID. example: id1: ["7d", "30d"] id2: ["7d", "30d"] type: object SLOBulkDeleteError: description: Object describing the error. properties: id: description: |- The ID of the service level objective object associated with this error. example: "" type: string message: description: The error message. example: "" type: string timeframe: $ref: "#/components/schemas/SLOErrorTimeframe" required: - id - timeframe - message type: object SLOBulkDeleteResponse: description: |- The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the "data" and "error" fields in this response indicate which deletions succeeded and failed. properties: data: $ref: "#/components/schemas/SLOBulkDeleteResponseData" errors: description: Array of errors object returned. items: $ref: "#/components/schemas/SLOBulkDeleteError" type: array type: object SLOBulkDeleteResponseData: description: An array of service level objective objects. properties: deleted: description: |- An array of service level objective object IDs that indicates which objects that were completely deleted. items: description: A deleted SLO ID. type: string type: array updated: description: |- An array of service level objective object IDs that indicates which objects that were modified (objects for which at least one threshold was deleted, but that were not completely deleted). items: description: An updated SLO ID. type: string type: array type: object SLOCorrection: description: |- The response object of a list of SLO corrections. properties: attributes: $ref: "#/components/schemas/SLOCorrectionResponseAttributes" id: description: The ID of the SLO correction. type: string type: $ref: "#/components/schemas/SLOCorrectionType" type: object SLOCorrectionCategory: description: Category the SLO correction belongs to. enum: - Scheduled Maintenance - Outside Business Hours - Deployment - Other example: Scheduled Maintenance type: string x-enum-varnames: - SCHEDULED_MAINTENANCE - OUTSIDE_BUSINESS_HOURS - DEPLOYMENT - OTHER SLOCorrectionCreateData: description: The data object associated with the SLO correction to be created. properties: attributes: $ref: "#/components/schemas/SLOCorrectionCreateRequestAttributes" type: $ref: "#/components/schemas/SLOCorrectionType" required: - type type: object SLOCorrectionCreateRequest: description: |- An object that defines a correction to be applied to one or more SLOs. properties: data: $ref: "#/components/schemas/SLOCorrectionCreateData" type: object SLOCorrectionCreateRequestAttributes: description: |- The attribute object associated with the SLO correction to be created. Exactly one of `slo_id` or `slo_query` must be provided. properties: category: $ref: "#/components/schemas/SLOCorrectionCategory" description: description: Description of the correction being made. type: string duration: description: Length of time (in seconds) for a specified `rrule` recurring SLO correction. example: 1600000000 format: int64 type: integer end: description: Ending time of the correction in epoch seconds. example: 1600000000 format: int64 type: integer rrule: description: |- The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`. example: FREQ=DAILY;INTERVAL=10;COUNT=5 type: string slo_id: description: ID of the single SLO that this correction applies to. example: sloId type: string slo_query: description: |- Query that matches the SLOs this correction applies to. The query uses the [Events search syntax](https://docs.datadoghq.com/events/explorer/searching/) and can filter SLOs by SLO tags. example: "env:prod service:checkout" type: string start: description: Starting time of the correction in epoch seconds. example: 1600000000 format: int64 type: integer timezone: description: The timezone to display in the UI for the correction times (defaults to "UTC"). example: UTC type: string required: - start - category type: object SLOCorrectionListResponse: description: A list of SLO correction objects. properties: data: description: |- The list of SLO corrections objects. items: $ref: "#/components/schemas/SLOCorrection" type: array meta: $ref: "#/components/schemas/ResponseMetaAttributes" type: object SLOCorrectionResponse: description: |- The response object of an SLO correction. properties: data: $ref: "#/components/schemas/SLOCorrection" type: object SLOCorrectionResponseAttributes: description: The attribute object associated with the SLO correction. properties: category: $ref: "#/components/schemas/SLOCorrectionCategory" created_at: description: The epoch timestamp of when the correction was created at. format: int64 nullable: true type: integer creator: $ref: "#/components/schemas/Creator" description: description: Description of the correction being made. type: string duration: description: Length of time (in seconds) for a specified `rrule` recurring SLO correction. example: 3600 format: int64 nullable: true type: integer end: description: Ending time of the correction in epoch seconds. format: int64 nullable: true type: integer modified_at: description: The epoch timestamp of when the correction was modified at. format: int64 nullable: true type: integer modifier: $ref: "#/components/schemas/SLOCorrectionResponseAttributesModifier" rrule: description: |- The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`. example: FREQ=DAILY;INTERVAL=10;COUNT=5 nullable: true type: string slo_id: description: ID of the single SLO that this correction applies to. nullable: true type: string slo_query: description: Query that matches the SLOs this correction applies to. nullable: true type: string start: description: Starting time of the correction in epoch seconds. format: int64 type: integer timezone: description: The timezone to display in the UI for the correction times (defaults to "UTC"). type: string type: object SLOCorrectionResponseAttributesModifier: description: Modifier of the object. nullable: true properties: email: description: Email of the Modifier. type: string handle: description: Handle of the Modifier. type: string name: description: Name of the Modifier. type: string type: object SLOCorrectionType: default: correction description: SLO correction resource type. enum: - correction example: correction type: string x-enum-varnames: - CORRECTION SLOCorrectionUpdateData: description: The data object associated with the SLO correction to be updated. properties: attributes: $ref: "#/components/schemas/SLOCorrectionUpdateRequestAttributes" type: $ref: "#/components/schemas/SLOCorrectionType" type: object SLOCorrectionUpdateRequest: description: |- An object that defines a correction to be applied to an SLO. properties: data: $ref: "#/components/schemas/SLOCorrectionUpdateData" type: object SLOCorrectionUpdateRequestAttributes: description: The attribute object associated with the SLO correction to be updated. properties: category: $ref: "#/components/schemas/SLOCorrectionCategory" description: description: Description of the correction being made. type: string duration: description: Length of time (in seconds) for a specified `rrule` recurring SLO correction. example: 3600 format: int64 type: integer end: description: Ending time of the correction in epoch seconds. example: 1600000000 format: int64 type: integer rrule: description: |- The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`. example: FREQ=DAILY;INTERVAL=10;COUNT=5 type: string slo_query: description: |- Query that matches the SLOs this correction applies to. The query uses the [Events search syntax](https://docs.datadoghq.com/events/explorer/searching/) and can filter SLOs by SLO tags. example: "env:prod service:checkout" type: string start: description: Starting time of the correction in epoch seconds. example: 1600000000 format: int64 type: integer timezone: description: The timezone to display in the UI for the correction times (defaults to "UTC"). example: UTC type: string type: object SLOCountDefinition: description: |- A count-based (metric) SLI specification, composed of three parts: the good events formula, the bad or total events formula, and the underlying queries. Exactly one of `total_events_formula` or `bad_events_formula` must be provided. example: bad_events_formula: "query2" good_events_formula: "query1" queries: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" - data_source: metrics name: "query2" query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" oneOf: - $ref: "#/components/schemas/SLOCountDefinitionWithTotalEventsFormula" - $ref: "#/components/schemas/SLOCountDefinitionWithBadEventsFormula" SLOCountDefinitionWithBadEventsFormula: additionalProperties: false description: SLO count definition using a bad events formula alongside a good events formula. properties: bad_events_formula: $ref: "#/components/schemas/SLOFormula" description: |- The bad events formula (recommended). Total events queries can be defined using the `total_events_formula` field as an alternative. Only one of `total_events_formula` or `bad_events_formula` must be provided. good_events_formula: $ref: "#/components/schemas/SLOFormula" queries: example: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" - data_source: metrics name: "query2" query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" items: $ref: "#/components/schemas/SLODataSourceQueryDefinition" minItems: 1 type: array required: - good_events_formula - bad_events_formula - queries type: object SLOCountDefinitionWithTotalEventsFormula: additionalProperties: false description: SLO count definition using a total events formula alongside a good events formula. properties: good_events_formula: $ref: "#/components/schemas/SLOFormula" queries: example: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" - data_source: metrics name: "query2" query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" items: $ref: "#/components/schemas/SLODataSourceQueryDefinition" minItems: 1 type: array total_events_formula: $ref: "#/components/schemas/SLOFormula" description: |- The total events formula. Bad events queries can be defined using the `bad_events_formula` field as an alternative. Only one of `total_events_formula` or `bad_events_formula` must be provided. required: - good_events_formula - total_events_formula - queries type: object SLOCountSpec: additionalProperties: false description: |- A metric SLI specification. example: count: bad_events_formula: "query2" good_events_formula: "query1" queries: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" - data_source: metrics name: "query2" query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" properties: count: $ref: "#/components/schemas/SLOCountDefinition" required: - count type: object SLOCreator: description: The creator of the SLO nullable: true properties: email: description: Email of the creator. type: string id: description: User ID of the creator. format: int64 type: integer name: description: Name of the creator. nullable: true type: string type: object SLODataSourceQueryDefinition: description: A formula and function query. example: data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" oneOf: - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" SLODeleteResponse: description: A response list of all service level objective deleted. properties: data: description: An array containing the ID of the deleted service level objective object. items: description: ID of a deleted SLO. type: string type: array errors: additionalProperties: description: Error preventing the SLO deletion. type: string description: An dictionary containing the ID of the SLO as key and a deletion error as value. type: object type: object SLOErrorBudgetRemainingData: additionalProperties: description: Remaining error budget. format: double type: number description: |- A mapping of threshold `timeframe` to the remaining error budget. example: 7d: 100.0 type: object SLOErrorTimeframe: description: |- The timeframe of the threshold associated with this error or "all" if all thresholds are affected. enum: - 7d - 30d - 90d - all example: 30d type: string x-enum-varnames: - SEVEN_DAYS - THIRTY_DAYS - NINETY_DAYS - ALL SLOFormula: description: |- A formula that specifies how to combine the results of multiple queries. example: formula: "query1 - default_zero(query2)" properties: formula: description: |- The formula string, which is an expression involving named queries. example: "query1 - default_zero(query2)" type: string required: - formula type: object SLOHistoryMetrics: description: |- A `metric` based SLO history response. This is not included in responses for `monitor` based SLOs. properties: denominator: $ref: "#/components/schemas/SLOHistoryMetricsSeries" interval: description: The aggregated query interval for the series data. It's implicit based on the query time window. example: 0 format: int64 type: integer message: description: Optional message if there are specific query issues/warnings. example: "" type: string numerator: $ref: "#/components/schemas/SLOHistoryMetricsSeries" query: description: The combined numerator and denominator query CSV. example: "" type: string res_type: description: The series result type. This mimics `batch_query` response type. example: "" type: string resp_version: description: The series response version type. This mimics `batch_query` response type. example: 0 format: int64 type: integer times: description: An array of query timestamps in EPOCH milliseconds. example: [] items: description: A timestamp in EPOCH milliseconds. format: double type: number type: array required: - res_type - interval - resp_version - query - times - numerator - denominator type: object SLOHistoryMetricsSeries: description: |- A representation of `metric` based SLO timeseries for the provided queries. This is the same response type from `batch_query` endpoint. properties: count: description: Count of submitted metrics. example: 0 format: int64 type: integer metadata: $ref: "#/components/schemas/SLOHistoryMetricsSeriesMetadata" sum: description: Total sum of the query. example: 0.0 format: double type: number values: description: The query values for each metric. example: [] items: description: A metric name and its value. format: double type: number type: array required: - count - sum - values type: object SLOHistoryMetricsSeriesMetadata: description: Query metadata. example: {} properties: aggr: deprecated: true description: Query aggregator function. type: string expression: deprecated: true description: Query expression. type: string metric: deprecated: true description: Query metric used. type: string query_index: deprecated: true description: Query index from original combined query. format: int64 type: integer scope: deprecated: true description: Query scope. type: string unit: description: |- An array of metric units that contains up to two unit objects. For example, bytes represents one unit object and bytes per second represents two unit objects. If a metric query only has one unit object, the second array element is null. example: [{"family": "bytes", "id": 2, "name": "byte", "plural": "bytes", "scale_factor": 1.0, "short_name": "B"}, null] items: $ref: "#/components/schemas/SLOHistoryMetricsSeriesMetadataUnit" nullable: true type: array type: object SLOHistoryMetricsSeriesMetadataUnit: description: An Object of metric units. nullable: true properties: family: description: |- The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. type: string id: description: The ID of the metric unit. format: int64 type: integer name: description: The unit of the metric, for instance `byte`. type: string plural: description: The plural Unit of metric, for instance `bytes`. nullable: true type: string scale_factor: description: The scale factor of metric unit, for instance `1.0`. format: double type: number short_name: description: A shorter and abbreviated version of the metric unit, for instance `B`. nullable: true type: string type: object SLOHistoryMonitor: description: |- An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. properties: error_budget_remaining: $ref: "#/components/schemas/SLOErrorBudgetRemainingData" errors: description: An array of error objects returned while querying the history data for the service level objective. items: $ref: "#/components/schemas/SLOHistoryResponseErrorWithType" type: array group: description: For groups in a grouped SLO, this is the group name. example: "name" type: string history: description: |- The state transition history for the monitor. It is represented as an array of pairs. Each pair is an array containing the timestamp of the transition as an integer in Unix epoch format in the first element, and the state as an integer in the second element. An integer value of `0` for state means uptime, `1` means downtime, and `2` means no data. Periods of no data are counted either as uptime or downtime depending on monitor settings. See [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data) for detailed information. example: [[1579212382, 0]] items: description: |- Represents an array timeseries data. example: [1579212382, 0] items: description: A timeseries data point which is a tuple of (timestamp, value). format: double type: number maxItems: 2 minItems: 2 type: array type: array monitor_modified: description: For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. example: 1615867200 format: int64 type: integer monitor_type: description: For `monitor` based SLOs, this describes the type of monitor. example: "string" type: string name: description: >- For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. example: "string" type: string precision: deprecated: true description: The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. Use `span_precision` instead. example: 2.0 format: double type: number preview: description: |- For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. example: true type: boolean sli_value: description: The current SLI value of the SLO over the history window. example: 99.99 format: double nullable: true type: number span_precision: description: The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. example: 2.0 format: double type: number uptime: deprecated: true description: Use `sli_value` instead. example: 99.99 format: double type: number type: object SLOHistoryResponse: description: A service level objective history response. properties: data: $ref: "#/components/schemas/SLOHistoryResponseData" errors: description: A list of errors while querying the history data for the service level objective. items: $ref: "#/components/schemas/SLOHistoryResponseError" nullable: true type: array type: object SLOHistoryResponseData: description: An array of service level objective objects. properties: from_ts: description: The `from` timestamp in epoch seconds. example: 1615323990 format: int64 type: integer group_by: description: |- For `metric` based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. This is not included in responses for `monitor` based SLOs. items: description: A grouping parameter. type: string type: array groups: description: |- For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. items: $ref: "#/components/schemas/SLOHistoryMonitor" type: array monitors: description: |- For multi-monitor SLOs, this represents SLI data for specific monitors. This is not included in the responses for `metric` based SLOs. items: $ref: "#/components/schemas/SLOHistoryMonitor" type: array overall: $ref: "#/components/schemas/SLOHistorySLIData" series: $ref: "#/components/schemas/SLOHistoryMetrics" thresholds: additionalProperties: $ref: "#/components/schemas/SLOThreshold" description: mapping of string timeframe to the SLO threshold. example: {"my_service": {"target": 95, "timeframe": "7d"}} type: object to_ts: description: The `to` timestamp in epoch seconds. example: 1615928790 format: int64 type: integer type: $ref: "#/components/schemas/SLOType" type_id: $ref: "#/components/schemas/SLOTypeNumeric" type: object SLOHistoryResponseError: description: A list of errors while querying the history data for the service level objective. properties: error: description: Human readable error. type: string type: object SLOHistoryResponseErrorWithType: description: An object describing the error with error type and error message. properties: error_message: description: A message with more details about the error. example: "" type: string error_type: description: Type of the error. example: "" type: string required: - error_type - error_message type: object SLOHistorySLIData: description: |- An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. properties: error_budget_remaining: $ref: "#/components/schemas/SLOErrorBudgetRemainingData" errors: description: An array of error objects returned while querying the history data for the service level objective. items: $ref: "#/components/schemas/SLOHistoryResponseErrorWithType" type: array group: description: For groups in a grouped SLO, this is the group name. example: "name" type: string history: description: |- The state transition history for `monitor` or `time-slice` SLOs. It is represented as an array of pairs. Each pair is an array containing the timestamp of the transition as an integer in Unix epoch format in the first element, and the state as an integer in the second element. An integer value of `0` for state means uptime, `1` means downtime, and `2` means no data. Periods of no data count as uptime in time-slice SLOs, while for monitor SLOs, no data is counted either as uptime or downtime depending on monitor settings. See [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data) for detailed information. example: [[1579212382, 0]] items: description: |- Represents an array timeseries data. example: [1579212382, 0] items: description: A timeseries data point which is a tuple of (timestamp, value). format: double type: number maxItems: 2 minItems: 2 type: array type: array monitor_modified: description: For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. example: 1615867200 format: int64 type: integer monitor_type: description: For `monitor` based SLOs, this describes the type of monitor. example: "string" type: string name: description: >- For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. example: "string" type: string precision: additionalProperties: description: The number of accurate decimals. format: double type: number description: |- A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. example: 30d: 1 7d: 2 type: object preview: description: |- For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. example: true type: boolean sli_value: description: The current SLI value of the SLO over the history window. example: 99.99 format: double nullable: true type: number span_precision: description: The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. example: 2.0 format: double type: number uptime: deprecated: true description: Use `sli_value` instead. example: 99.99 format: double nullable: true type: number type: object SLOListResponse: description: A response with one or more service level objective. properties: data: description: An array of service level objective objects. items: $ref: "#/components/schemas/ServiceLevelObjective" type: array errors: description: |- An array of error messages. Each endpoint documents how/whether this field is used. items: description: The error message. type: string type: array metadata: $ref: "#/components/schemas/SLOListResponseMetadata" type: object SLOListResponseMetadata: description: |- The metadata object containing additional information about the list of SLOs. properties: page: $ref: "#/components/schemas/SLOListResponseMetadataPage" type: object SLOListResponseMetadataPage: description: The object containing information about the pages of the list of SLOs. properties: total_count: description: |- The total number of resources that could be retrieved ignoring the parameters and filters in the request. format: int64 type: integer total_filtered_count: description: |- The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages. format: int64 type: integer type: object SLOListWidgetDefinition: description: Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. properties: description: description: The description of the widget. type: string requests: description: Array of one request object to display in the widget. items: $ref: "#/components/schemas/SLOListWidgetRequest" maxItems: 1 minItems: 1 type: array title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/SLOListWidgetDefinitionType" required: - type - requests type: object SLOListWidgetDefinitionType: default: slo_list description: Type of the SLO List widget. enum: - slo_list example: slo_list type: string x-enum-varnames: - SLO_LIST SLOListWidgetQuery: description: Updated SLO List widget. properties: limit: default: 100 description: Maximum number of results to display in the table. format: int64 maximum: 100 minimum: 1 type: integer query_string: description: Widget query. example: "env:prod AND service:my-app" type: string sort: description: Options for sorting results. items: $ref: "#/components/schemas/WidgetFieldSort" type: array required: - query_string type: object SLOListWidgetRequest: description: Updated SLO List widget. properties: query: $ref: "#/components/schemas/SLOListWidgetQuery" request_type: $ref: "#/components/schemas/SLOListWidgetRequestType" required: - query - request_type type: object SLOListWidgetRequestType: description: Widget request type. enum: - slo_list example: "slo_list" type: string x-enum-varnames: - SLO_LIST SLOOverallStatuses: description: Overall status of the SLO by timeframes. properties: error: description: Error message if SLO status or error budget could not be calculated. nullable: true type: string error_budget_remaining: description: Remaining error budget of the SLO in percentage. example: 100 format: double nullable: true type: number indexed_at: description: |- timestamp (UNIX time in seconds) of when the SLO status and error budget were calculated. example: 1662496260 format: int64 type: integer raw_error_budget_remaining: $ref: "#/components/schemas/SLORawErrorBudgetRemaining" span_precision: description: The amount of decimal places the SLI value is accurate to. example: 2 format: int64 nullable: true type: integer state: $ref: "#/components/schemas/SLOState" status: description: The status of the SLO. example: 100 format: double nullable: true type: number target: description: The target of the SLO. example: 99 format: double type: number timeframe: $ref: "#/components/schemas/SLOTimeframe" type: object SLORawErrorBudgetRemaining: description: Error budget remaining for an SLO. nullable: true properties: unit: description: Error budget remaining unit. example: "requests" type: string value: description: Error budget remaining value. example: 60 format: double type: number type: object SLOResponse: description: A service level objective response containing a single service level objective. properties: data: $ref: "#/components/schemas/SLOResponseData" errors: description: |- An array of error messages. Each endpoint documents how/whether this field is used. items: description: The error message. type: string type: array type: object SLOResponseData: description: |- A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). properties: configured_alert_ids: description: A list of SLO monitors IDs that reference this SLO. This field is returned only when `with_configured_alert_ids` parameter is true in query. example: [123, 456, 789] items: description: A monitor ID. format: int64 type: integer type: array created_at: description: |- Creation timestamp (UNIX time in seconds) Always included in service level objective responses. format: int64 readOnly: true type: integer creator: $ref: "#/components/schemas/Creator" description: description: |- A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. nullable: true type: string groups: description: |- A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string type: array id: description: |- A unique identifier for the service level objective object. Always included in service level objective responses. readOnly: true type: string modified_at: description: |- Modification timestamp (UNIX time in seconds) Always included in service level objective responses. format: int64 readOnly: true type: integer monitor_ids: description: |- A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. items: description: A monitor ID. format: int64 type: integer type: array monitor_tags: description: |- The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). items: description: A monitor tag. type: string type: array name: description: The name of the service level objective object. example: "Custom Metric SLO" type: string query: $ref: "#/components/schemas/ServiceLevelObjectiveQuery" description: |- The metric query used to define a count-based SLO as the ratio of good events to total events. sli_specification: $ref: "#/components/schemas/SLOSliSpec" description: |- A generic SLI specification. This is currently used for time-slice and count-based (metric) SLOs only. tags: description: |- A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. example: ["env:prod", "app:core"] items: description: A tag to apply to your SLO. type: string type: array target_threshold: description: |- The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met. example: 99.9 format: double type: number thresholds: description: |- The thresholds (timeframes and associated targets) for this service level objective object. example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}] items: $ref: "#/components/schemas/SLOThreshold" type: array timeframe: $ref: "#/components/schemas/SLOTimeframe" type: $ref: "#/components/schemas/SLOType" warning_threshold: description: |- The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold. example: 99.95 format: double type: number type: object SLOSliSpec: description: |- A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only. oneOf: - $ref: "#/components/schemas/SLOTimeSliceSpec" - $ref: "#/components/schemas/SLOCountSpec" SLOState: description: State of the SLO. enum: - breached - warning - ok - no_data example: ok type: string x-enum-varnames: - BREACHED - WARNING - OK - NO_DATA SLOStatus: description: Status of the SLO's primary timeframe. properties: calculation_error: description: Error message if SLO status or error budget could not be calculated. nullable: true type: string error_budget_remaining: description: Remaining error budget of the SLO in percentage. example: 100 format: double nullable: true type: number indexed_at: description: |- timestamp (UNIX time in seconds) of when the SLO status and error budget were calculated. example: 1662496260 format: int64 type: integer raw_error_budget_remaining: $ref: "#/components/schemas/SLORawErrorBudgetRemaining" sli: description: |- The current service level indicator (SLI) of the SLO, also known as 'status'. This is a percentage value from 0-100 (inclusive). example: 100 format: double nullable: true type: number span_precision: description: The number of decimal places the SLI value is accurate to. example: 2 format: int64 nullable: true type: integer state: $ref: "#/components/schemas/SLOState" type: object SLOThreshold: description: SLO thresholds (target and optionally warning) for a single time window. properties: target: description: |- The target value for the service level indicator within the corresponding timeframe. example: 99.9 format: double type: number target_display: description: |- A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (for example `98.00`). Always included in service level objective responses. Ignored in create/update requests. example: "99.9" type: string timeframe: $ref: "#/components/schemas/SLOTimeframe" warning: description: |- The warning value for the service level objective. example: 90.0 format: double type: number warning_display: description: |- A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests. example: "90.0" type: string required: - timeframe - target type: object SLOTimeSliceComparator: description: |- The comparator used to compare the SLI value to the threshold. enum: - ">" - ">=" - "<" - "<=" example: ">" type: string x-enum-varnames: - GREATER - GREATER_EQUAL - LESS - LESS_EQUAL SLOTimeSliceCondition: description: |- The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator, and 3. the threshold. Optionally, a fourth part, the query interval, can be provided. example: comparator: "<" query: formulas: - formula: "query2/query1" queries: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" - data_source: metrics name: "query1" query: "sum:trace.servlet.request.errors{*} by {env}.as_count()" threshold: 5 properties: comparator: $ref: "#/components/schemas/SLOTimeSliceComparator" query: $ref: "#/components/schemas/SLOTimeSliceQuery" query_interval_seconds: $ref: "#/components/schemas/SLOTimeSliceInterval" threshold: description: |- The threshold value to which each SLI value will be compared. example: 5 format: double type: number required: - comparator - threshold - query type: object SLOTimeSliceInterval: description: |- The interval used when querying data, which defines the size of a time slice. Two values are allowed: 60 (1 minute) and 300 (5 minutes). If not provided, the value defaults to 300 (5 minutes). enum: - 60 - 300 example: 300 format: int32 type: integer x-enum-varnames: - ONE_MINUTE - FIVE_MINUTES SLOTimeSliceQuery: description: |- The queries and formula used to calculate the SLI value. example: formulas: - formula: "query2/query1" queries: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" - data_source: metrics name: "query1" query: "sum:trace.servlet.request.errors{*} by {env}.as_count()" properties: formulas: description: |- A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO. example: - formula: "query1 - default_zero(query2)" items: $ref: "#/components/schemas/SLOFormula" maxItems: 1 minItems: 1 type: array queries: description: |- A list of queries that are used to calculate the SLI value. example: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" items: $ref: "#/components/schemas/SLODataSourceQueryDefinition" type: array required: - formulas - queries type: object SLOTimeSliceSpec: additionalProperties: false description: |- A time-slice SLI specification. example: time_slice: comparator: "<" query: formulas: - formula: "query2/query1" queries: - data_source: metrics name: "query1" query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" - data_source: metrics name: "query2" query: "sum:trace.servlet.request.errors{*} by {env}.as_count()" threshold: 5 properties: time_slice: $ref: "#/components/schemas/SLOTimeSliceCondition" required: - time_slice type: object SLOTimeframe: description: |- The SLO time window options. Note that "custom" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes. enum: - 7d - 30d - 90d - custom example: 30d type: string x-enum-varnames: - SEVEN_DAYS - THIRTY_DAYS - NINETY_DAYS - CUSTOM SLOType: description: The type of the service level objective. enum: - metric - monitor - time_slice example: "metric" type: string x-enum-varnames: - METRIC - MONITOR - TIME_SLICE SLOTypeNumeric: description: |- A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. enum: - 0 - 1 - 2 example: 0 format: int32 type: integer x-enum-varnames: - MONITOR - METRIC - TIME_SLICE SLOWidgetDefinition: description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. properties: additional_query_filters: description: Additional filters applied to the SLO query. type: string description: description: The description of the widget. type: string global_time_target: description: Defined global time target. type: string show_error_budget: description: Defined error budget. type: boolean slo_id: description: ID of the SLO displayed. type: string time_windows: description: Times being monitored. items: $ref: "#/components/schemas/WidgetTimeWindows" type: array title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/SLOWidgetDefinitionType" view_mode: $ref: "#/components/schemas/WidgetViewMode" view_type: default: detail description: Type of view displayed by the widget. example: detail type: string required: - type - view_type type: object SLOWidgetDefinitionType: default: slo description: Type of the SLO widget. enum: - slo example: slo type: string x-enum-varnames: - SLO SankeyJoinKeys: additionalProperties: false description: Join keys. properties: primary: description: Primary join key. example: "session.id" type: string secondary: description: Secondary join keys. items: description: Secondary join key. type: string type: array required: - primary type: object SankeyNetworkDataSource: default: network description: Network data source type. enum: - network_device_flows - network example: network type: string x-enum-varnames: - NETWORK_DEVICE_FLOWS - NETWORK SankeyNetworkQuery: additionalProperties: false description: Query configuration for Sankey network widget. properties: compute: $ref: "#/components/schemas/SankeyNetworkQueryCompute" data_source: $ref: "#/components/schemas/SankeyNetworkDataSource" group_by: description: Fields to group by. example: ["source", "destination"] items: description: A field name to group by. type: string type: array limit: description: Maximum number of results. example: 100 format: int64 type: integer mode: $ref: "#/components/schemas/SankeyNetworkQueryMode" query_string: description: Query string for filtering network data. example: "*" type: string should_exclude_missing: description: Whether to exclude missing values. type: boolean sort: $ref: "#/components/schemas/SankeyNetworkQuerySort" required: - data_source - query_string - group_by - limit type: object SankeyNetworkQueryCompute: additionalProperties: false description: Compute aggregation for network queries. properties: aggregation: $ref: "#/components/schemas/EventsAggregation" metric: description: Metric to aggregate. example: "" type: string required: - aggregation - metric type: object SankeyNetworkQueryMode: default: target description: Sankey mode for network queries. enum: - target example: target type: string x-enum-varnames: - TARGET SankeyNetworkQuerySort: description: Sort configuration for network queries. properties: field: description: Field to sort by. type: string order: $ref: "#/components/schemas/WidgetSort" type: object SankeyNetworkRequest: additionalProperties: false description: Sankey widget request for network data source. properties: query: $ref: "#/components/schemas/SankeyNetworkQuery" request_type: $ref: "#/components/schemas/SankeyNetworkRequestType" required: - query - request_type type: object SankeyNetworkRequestType: default: netflow_sankey description: Type of request for network Sankey widget. enum: - netflow_sankey example: netflow_sankey type: string x-enum-varnames: - NETFLOW_SANKEY SankeyRumDataSource: default: product_analytics description: Product Analytics or RUM data source type. enum: - rum - product_analytics example: product_analytics type: string x-enum-varnames: - RUM - PRODUCT_ANALYTICS SankeyRumQuery: additionalProperties: false description: Query configuration for Product Analytics or RUM Sankey widget. properties: audience_filters: $ref: "#/components/schemas/ProductAnalyticsAudienceFilters" data_source: $ref: "#/components/schemas/SankeyRumDataSource" entries_per_step: description: Entries per step. format: int64 type: integer join_keys: $ref: "#/components/schemas/SankeyJoinKeys" mode: $ref: "#/components/schemas/SankeyRumQueryMode" number_of_steps: description: Number of steps. format: int64 type: integer occurrences: $ref: "#/components/schemas/ProductAnalyticsAudienceOccurrenceFilter" query_string: description: RUM event search query used to filter views or actions. example: "@type:view" type: string source: description: Source. type: string subquery_id: description: Subquery ID. type: string target: description: Target. type: string required: - data_source - query_string - mode type: object SankeyRumQueryMode: default: source description: Sankey mode for Product Analytics or RUM queries. enum: - source - target example: source type: string x-enum-varnames: - SOURCE - TARGET SankeyRumRequest: additionalProperties: false description: Sankey widget request for Product Analytics or RUM data source. properties: query: $ref: "#/components/schemas/SankeyRumQuery" request_type: $ref: "#/components/schemas/SankeyWidgetDefinitionType" required: - query - request_type type: object SankeyWidgetDefinition: additionalProperties: false description: The Sankey diagram visualizes the flow of data between categories, stages or sets of values. properties: requests: description: List of Sankey widget requests. example: - query: data_source: rum mode: source query_string: "@type:view" request_type: sankey items: $ref: "#/components/schemas/SankeyWidgetRequest" minItems: 1 type: array show_other_links: description: Whether to show links for "other" category. type: boolean sort_nodes: description: Whether to sort nodes in the Sankey diagram. type: boolean time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/SankeyWidgetDefinitionType" required: - type - requests type: object SankeyWidgetDefinitionType: default: sankey description: Type of the Sankey widget. enum: - sankey example: sankey type: string x-enum-varnames: - SANKEY SankeyWidgetRequest: description: Request definition for Sankey widget. oneOf: - $ref: "#/components/schemas/SankeyRumRequest" - $ref: "#/components/schemas/SankeyNetworkRequest" ScatterPlotRequest: description: Updated scatter plot. properties: aggregator: $ref: "#/components/schemas/ScatterplotWidgetAggregator" apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: description: Query definition. type: string rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. type: object ScatterPlotWidgetDefinition: description: The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. properties: color_by_groups: description: List of groups used for colors. items: description: Group name. type: string type: array custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string requests: $ref: "#/components/schemas/ScatterPlotWidgetDefinitionRequests" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/ScatterPlotWidgetDefinitionType" xaxis: $ref: "#/components/schemas/WidgetAxis" yaxis: $ref: "#/components/schemas/WidgetAxis" required: - type - requests type: object ScatterPlotWidgetDefinitionRequests: description: Widget definition. example: {"x": {"q": "system.cpu.user"}, "y": {"q": "system.mem.used"}} properties: table: $ref: "#/components/schemas/ScatterplotTableRequest" x: $ref: "#/components/schemas/ScatterPlotRequest" y: $ref: "#/components/schemas/ScatterPlotRequest" type: object ScatterPlotWidgetDefinitionType: default: scatterplot description: Type of the scatter plot widget. enum: - scatterplot example: scatterplot type: string x-enum-varnames: - SCATTERPLOT ScatterplotDimension: description: Dimension of the Scatterplot. enum: - x - y - radius - color example: radius type: string x-enum-varnames: - X - Y - RADIUS - COLOR ScatterplotTableRequest: description: Scatterplot request containing formulas and functions. properties: formulas: description: List of Scatterplot formulas that operate on queries. items: $ref: "#/components/schemas/ScatterplotWidgetFormula" type: array queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" type: object ScatterplotWidgetAggregator: description: Aggregator used for the request. enum: - avg - last - max - min - sum type: string x-enum-varnames: - AVERAGE - LAST - MAXIMUM - MINIMUM - SUM ScatterplotWidgetFormula: description: Formula to be used in a Scatterplot widget query. properties: alias: description: Expression alias. example: "my-query" type: string dimension: $ref: "#/components/schemas/ScatterplotDimension" formula: description: String expression built from queries, formulas, and functions. example: "func(a) + b" type: string required: - formula - dimension type: object SearchSLOQuery: description: |- A metric-based SLO. **Required if type is `metric`**. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. nullable: true properties: denominator: description: A Datadog metric query for total (valid) events. example: "sum:my.custom.metric{*}.as_count()" type: string metrics: description: |- Metric names used in the query's numerator and denominator. This field will return null and will be implemented in the next version of this endpoint. example: ["my.custom.metric", "my.other.custom.metric"] items: description: Metric name. type: string nullable: true type: array numerator: description: A Datadog metric query for good events. example: "sum:my.custom.metric{type:good}.as_count()" type: string type: object SearchSLOResponse: description: A search SLO response containing results from the search query. properties: data: $ref: "#/components/schemas/SearchSLOResponseData" links: $ref: "#/components/schemas/SearchSLOResponseLinks" meta: $ref: "#/components/schemas/SearchSLOResponseMeta" type: object SearchSLOResponseData: description: Data from search SLO response. properties: attributes: $ref: "#/components/schemas/SearchSLOResponseDataAttributes" type: description: Type of service level objective result. example: "" type: string type: object SearchSLOResponseDataAttributes: description: Attributes properties: facets: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacets" slos: description: SLOs items: $ref: "#/components/schemas/SearchServiceLevelObjective" type: array type: object SearchSLOResponseDataAttributesFacets: description: Facets properties: all_tags: description: All tags associated with an SLO. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array creator_name: description: Creator of an SLO. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array env_tags: description: Tags with the `env` tag key. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array service_tags: description: Tags with the `service` tag key. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array slo_type: description: Type of SLO. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt" type: array target: description: SLO Target items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt" type: array team_tags: description: Tags with the `team` tag key. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array timeframe: description: Timeframes of SLOs. items: $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array type: object SearchSLOResponseDataAttributesFacetsObjectInt: description: Facet properties: count: description: Count format: int64 type: integer name: description: Facet format: double type: number type: object SearchSLOResponseDataAttributesFacetsObjectString: description: Facet properties: count: description: Count format: int64 type: integer name: description: Facet type: string type: object SearchSLOResponseLinks: description: Pagination links. properties: first: description: Link to last page. type: string last: description: Link to first page. nullable: true type: string next: description: Link to the next page. type: string prev: description: Link to previous page. nullable: true type: string self: description: Link to current page. type: string type: object SearchSLOResponseMeta: description: Searches metadata returned by the API. properties: pagination: $ref: "#/components/schemas/SearchSLOResponseMetaPage" type: object SearchSLOResponseMetaPage: description: Pagination metadata returned by the API. properties: first_number: description: The first number. format: int64 type: integer last_number: description: The last number. format: int64 type: integer next_number: description: The next number. format: int64 type: integer number: description: The page number. format: int64 type: integer prev_number: description: The previous page number. format: int64 type: integer size: description: The size of the response. format: int64 type: integer total: description: The total number of SLOs in the response. format: int64 type: integer type: description: Type of pagination. type: string type: object SearchSLOThreshold: description: SLO thresholds (target and optionally warning) for a single time window. properties: target: description: |- The target value for the service level indicator within the corresponding timeframe. example: 99.9 format: double type: number target_display: description: |- A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (for example `98.00`). Always included in service level objective responses. Ignored in create/update requests. example: "99.9" type: string timeframe: $ref: "#/components/schemas/SearchSLOTimeframe" warning: description: |- The warning value for the service level objective. example: 90.0 format: double nullable: true type: number warning_display: description: |- A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests. example: "90.0" nullable: true type: string required: - timeframe - target type: object SearchSLOTimeframe: description: The SLO time window options. enum: - 7d - 30d - 90d example: 30d type: string x-enum-varnames: - SEVEN_DAYS - THIRTY_DAYS - NINETY_DAYS SearchServiceLevelObjective: description: A service level objective data container. properties: data: $ref: "#/components/schemas/SearchServiceLevelObjectiveData" type: object SearchServiceLevelObjectiveAttributes: description: |- A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (`name`, `description`, and `tags`). properties: all_tags: description: |- A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). example: ["env:prod", "app:core"] items: description: A tag associated with the service level objective. type: string type: array created_at: description: |- Creation timestamp (UNIX time in seconds) Always included in service level objective responses. format: int64 readOnly: true type: integer creator: $ref: "#/components/schemas/SLOCreator" description: description: |- A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. nullable: true type: string env_tags: description: Tags with the `env` tag key. items: description: A tag with the `env` tag key. type: string type: array groups: description: |- A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string nullable: true type: array modified_at: description: |- Modification timestamp (UNIX time in seconds) Always included in service level objective responses. format: int64 readOnly: true type: integer monitor_ids: description: |- A list of monitor ids that defines the scope of a monitor service level objective. items: description: A monitor ID. format: int64 type: integer nullable: true type: array name: description: The name of the service level objective object. example: "Custom Metric SLO" type: string overall_status: description: calculated status and error budget remaining. items: $ref: "#/components/schemas/SLOOverallStatuses" type: array query: $ref: "#/components/schemas/SearchSLOQuery" service_tags: description: Tags with the `service` tag key. items: description: A tag with the `service` tag key. type: string type: array slo_type: $ref: "#/components/schemas/SLOType" status: $ref: "#/components/schemas/SLOStatus" team_tags: description: Tags with the `team` tag key. items: description: A tag with the `team` tag key. type: string type: array thresholds: description: |- The thresholds (timeframes and associated targets) for this service level objective object. example: [{"target": 95, "target_display": "95", "timeframe": "7d"}, {"target": 95, "target_display": "95", "timeframe": "30d", "warning": 97, "warning_display": "97"}] items: $ref: "#/components/schemas/SearchSLOThreshold" type: array type: object SearchServiceLevelObjectiveData: description: A service level objective ID and attributes. properties: attributes: $ref: "#/components/schemas/SearchServiceLevelObjectiveAttributes" id: description: |- A unique identifier for the service level objective object. Always included in service level objective responses. readOnly: true type: string type: description: The type of the object, must be `slo`. type: string type: object SelectableTemplateVariableItems: description: Object containing the template variable's name, associated tag/attribute, default value and selectable values. properties: default_value: description: The default value of the template variable. type: string name: description: Name of the template variable. type: string prefix: description: The tag/attribute key associated with the template variable. type: string type: description: The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). nullable: true type: string visible_tags: description: List of visible tag values on the shared dashboard. items: description: Other values for this tag that can be selected on the shared dashboard. type: string nullable: true type: array type: object Series: description: |- A metric to submit to Datadog. See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties). properties: host: description: The name of the host that produced the metric. example: test.example.com type: string interval: default: description: If the type of the metric is rate or count, define the corresponding interval in seconds. example: 20 format: int64 nullable: true type: integer metric: description: The name of the timeseries. example: system.load.1 type: string points: description: Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. example: - [1575317847.0, 0.5] items: $ref: "#/components/schemas/Point" type: array tags: description: A list of tags associated with the metric. example: ["environment:test"] items: description: Individual tags. type: string type: array type: default: "" description: The type of the metric. Valid types are "",`count`, `gauge`, and `rate`. example: rate type: string required: - metric - points type: object ServiceCheck: description: An object containing service check and status. properties: check: description: The check. example: app.ok type: string host_name: description: The host name correlated with the check. example: app.host1 type: string message: description: Message containing check status. example: app is running type: string status: $ref: "#/components/schemas/ServiceCheckStatus" tags: description: Tags related to a check. example: ["environment:test"] items: description: Items related to a check. type: string type: array timestamp: description: Time of check. format: int64 type: integer required: - check - status - tags - host_name type: object ServiceCheckStatus: description: The status of a service check. Set to `0` for OK, `1` for warning, `2` for critical, and `3` for unknown. enum: - 0 - 1 - 2 - 3 example: 0 format: int32 type: integer x-enum-varnames: - OK - WARNING - CRITICAL - UNKNOWN ServiceChecks: description: The service checks. items: $ref: "#/components/schemas/ServiceCheck" type: array ServiceLevelObjective: description: |- A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). properties: created_at: description: |- Creation timestamp (UNIX time in seconds) Always included in service level objective responses. format: int64 readOnly: true type: integer creator: $ref: "#/components/schemas/Creator" description: description: |- A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. nullable: true type: string groups: description: |- A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string type: array id: description: |- A unique identifier for the service level objective object. Always included in service level objective responses. readOnly: true type: string modified_at: description: |- Modification timestamp (UNIX time in seconds) Always included in service level objective responses. format: int64 readOnly: true type: integer monitor_ids: description: |- A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. items: description: A monitor ID. format: int64 type: integer type: array monitor_tags: description: |- The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor-based service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). items: description: A monitor tag. type: string type: array name: description: The name of the service level objective object. example: "Custom Metric SLO" type: string query: $ref: "#/components/schemas/ServiceLevelObjectiveQuery" sli_specification: $ref: "#/components/schemas/SLOSliSpec" tags: description: |- A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. example: ["env:prod", "app:core"] items: description: A tag to apply to your SLO. type: string type: array target_threshold: description: |- The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met. example: 99.9 format: double type: number thresholds: description: |- The thresholds (timeframes and associated targets) for this service level objective object. example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}] items: $ref: "#/components/schemas/SLOThreshold" type: array timeframe: $ref: "#/components/schemas/SLOTimeframe" type: $ref: "#/components/schemas/SLOType" warning_threshold: description: |- The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold. example: 99.95 format: double type: number required: - name - thresholds - type type: object ServiceLevelObjectiveQuery: description: |- A count-based (metric) SLO query. This field is superseded by `sli_specification` but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. properties: denominator: description: A Datadog metric query for total (valid) events. example: "sum:my.custom.metric{*}.as_count()" type: string numerator: description: A Datadog metric query for good events. example: "sum:my.custom.metric{type:good}.as_count()" type: string required: - numerator - denominator type: object ServiceLevelObjectiveRequest: description: |- A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). properties: description: description: |- A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. nullable: true type: string groups: description: |- A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string type: array monitor_ids: description: |- A list of monitor IDs that defines the scope of a monitor service level objective. **Required if type is `monitor`**. items: description: A monitor ID. format: int64 type: integer type: array name: description: The name of the service level objective object. example: "Custom Metric SLO" type: string query: $ref: "#/components/schemas/ServiceLevelObjectiveQuery" sli_specification: $ref: "#/components/schemas/SLOSliSpec" tags: description: |- A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. example: ["env:prod", "app:core"] items: description: A tag to apply to your SLO. type: string type: array target_threshold: description: |- The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met. example: 99.9 format: double type: number thresholds: description: |- The thresholds (timeframes and associated targets) for this service level objective object. example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}] items: $ref: "#/components/schemas/SLOThreshold" type: array timeframe: $ref: "#/components/schemas/SLOTimeframe" type: $ref: "#/components/schemas/SLOType" warning_threshold: description: |- The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold. example: 99.95 format: double type: number required: - name - thresholds - type type: object ServiceMapWidgetDefinition: description: This widget displays a map of a service to all of the services that call it, and all of the services that it calls. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string filters: description: Your environment and primary tag (or * if enabled for your account). example: ["*"] items: description: Filter name. type: string minItems: 1 type: array service: description: The ID of the service you want to map. example: "" type: string title: description: The title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/ServiceMapWidgetDefinitionType" required: - type - filters - service type: object ServiceMapWidgetDefinitionType: default: servicemap description: Type of the service map widget. enum: - servicemap example: servicemap type: string x-enum-varnames: - SERVICEMAP ServiceSummaryWidgetDefinition: description: The service summary displays the graphs of a chosen service in your dashboard. properties: description: description: The description of the widget. type: string display_format: $ref: "#/components/schemas/WidgetServiceSummaryDisplayFormat" env: description: APM environment. example: "" type: string service: description: APM service. example: "" type: string show_breakdown: description: Whether to show the latency breakdown or not. type: boolean show_distribution: description: Whether to show the latency distribution or not. type: boolean show_errors: description: Whether to show the error metrics or not. type: boolean show_hits: description: Whether to show the hits metrics or not. type: boolean show_latency: description: Whether to show the latency metrics or not. type: boolean show_resource_list: description: Whether to show the resource list or not. type: boolean size_format: $ref: "#/components/schemas/WidgetSizeFormat" span_name: description: APM span name. example: "" type: string time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/ServiceSummaryWidgetDefinitionType" required: - type - env - service - span_name type: object ServiceSummaryWidgetDefinitionType: default: trace_service description: Type of the service summary widget. enum: - trace_service example: trace_service type: string x-enum-varnames: - TRACE_SERVICE SharedDashboard: description: |- The metadata object associated with how a dashboard has been/will be shared. properties: author: $ref: "#/components/schemas/SharedDashboardAuthor" created: description: Date the dashboard was shared. format: date-time readOnly: true type: string dashboard_id: description: ID of the dashboard to share. example: "123-abc-456" type: string dashboard_type: $ref: "#/components/schemas/DashboardType" embeddable_domains: description: The `SharedDashboard` `embeddable_domains`. example: ["https://domain.atlassian.net/", "http://myserver.com/"] items: description: The allowlisted referrers for an EMBED shared dashboard. type: string type: array expiration: description: The time when an OPEN shared dashboard becomes publicly unavailable. format: date-time nullable: true type: string global_time: $ref: "#/components/schemas/DashboardGlobalTime" global_time_selectable_enabled: description: Whether to allow viewers to select a different global time setting for the shared dashboard. nullable: true type: boolean invitees: description: The `SharedDashboard` `invitees`. example: [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}] items: $ref: "#/components/schemas/SharedDashboardInviteesItems" type: array last_accessed: description: The last time the shared dashboard was accessed. Null if never accessed. format: date-time nullable: true readOnly: true type: string public_url: description: URL of the shared dashboard. readOnly: true type: string selectable_template_vars: description: List of objects representing template variables on the shared dashboard which can have selectable values. example: [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}] items: $ref: "#/components/schemas/SelectableTemplateVariableItems" nullable: true type: array share_list: deprecated: true description: List of email addresses that can receive an invitation to access to the shared dashboard. example: ["test@datadoghq.com", "test2@email.com"] items: description: Email address that can receive an invitation to access the shared dashboard. type: string nullable: true type: array share_type: $ref: "#/components/schemas/DashboardShareType" status: $ref: "#/components/schemas/SharedDashboardStatus" title: description: Title of the shared dashboard. type: string token: description: A unique token assigned to the shared dashboard. readOnly: true type: string viewing_preferences: $ref: "#/components/schemas/ViewingPreferences" required: - dashboard_id - dashboard_type type: object SharedDashboardAuthor: description: User who shared the dashboard. properties: handle: description: Identifier of the user who shared the dashboard. example: test@datadoghq.com readOnly: true type: string name: description: Name of the user who shared the dashboard. nullable: true readOnly: true type: string readOnly: true type: object SharedDashboardInviteesItems: description: The allowlisted invitees for an INVITE-only shared dashboard. properties: access_expiration: description: Time of the invitee expiration. Null means the invite will not expire. format: date-time nullable: true type: string created_at: description: Time that the invitee was created. format: date-time readOnly: true type: string email: description: Email of the invitee. example: "test@datadoghq.com" type: string required: - email type: object SharedDashboardInvites: description: Invitations data and metadata that exists for a shared dashboard returned by the API. example: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]} properties: data: $ref: "#/components/schemas/SharedDashboardInvitesData" meta: $ref: "#/components/schemas/SharedDashboardInvitesMeta" required: - data type: object SharedDashboardInvitesData: description: An object or list of objects containing the information for an invitation to a shared dashboard. example: [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}] oneOf: - $ref: "#/components/schemas/SharedDashboardInvitesDataObject" - $ref: "#/components/schemas/SharedDashboardInvitesDataList" SharedDashboardInvitesDataList: description: A list of objects containing the information for an invitation(s) to a shared dashboard. example: [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}] items: $ref: "#/components/schemas/SharedDashboardInvitesDataObject" type: array SharedDashboardInvitesDataObject: description: Object containing the information for an invitation to a shared dashboard. example: {"attributes": {"created_at": "2020-12-07T20:16:27.846985+00:00", "email": "test@datadoghq.com", "has_session": false, "invitation_expiry": "2020-12-07T21:16:27.840542+00:00", "session_expiry": null, "share_token": "XXXXXX-123456abcedfg7890hijklmnopqrstuv"}, "type": "public_dashboard_invitation"} properties: attributes: $ref: "#/components/schemas/SharedDashboardInvitesDataObjectAttributes" type: $ref: "#/components/schemas/DashboardInviteType" required: - type - attributes type: object SharedDashboardInvitesDataObjectAttributes: description: Attributes of the shared dashboard invitation example: {"created_at": "2020-12-07T20:16:27.846985+00:00", "email": "test@datadoghq.com", "has_session": false, "invitation_expiry": "2020-12-07T21:16:27.840542+00:00", "session_expiry": null, "share_token": "XXXXXX-123456abcedfg7890hijklmnopqrstuv"} properties: created_at: description: When the invitation was sent. format: date-time readOnly: true type: string email: description: An email address that an invitation has been (or if used in invitation request, will be) sent to. nullable: false type: string has_session: description: Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). readOnly: true type: boolean invitation_expiry: description: When the invitation expires. format: date-time readOnly: true type: string session_expiry: description: When the invited user's session expires. null if the invitation has no associated session. format: date-time nullable: true readOnly: true type: string share_token: description: The unique token of the shared dashboard that was (or is to be) shared. readOnly: true type: string type: object SharedDashboardInvitesMeta: description: Pagination metadata returned by the API. properties: page: $ref: "#/components/schemas/SharedDashboardInvitesMetaPage" readOnly: true type: object SharedDashboardInvitesMetaPage: description: Object containing the total count of invitations across all pages properties: total_count: description: The total number of invitations on this shared board, across all pages. format: int64 type: integer type: object SharedDashboardStatus: description: Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. enum: - active - paused example: "active" type: string x-enum-varnames: - ACTIVE - PAUSED SharedDashboardUpdateRequest: description: |- Update a shared dashboard's settings. example: {"global_time": {"live_span": "1h"}, "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"} properties: embeddable_domains: description: The `SharedDashboard` `embeddable_domains`. example: ["https://domain.atlassian.net/", "http://myserver.com/"] items: description: The allowlisted referrers for an EMBED shared dashboard. type: string type: array expiration: description: The time when an OPEN shared dashboard becomes publicly unavailable. format: date-time nullable: true type: string global_time: $ref: "#/components/schemas/SharedDashboardUpdateRequestGlobalTime" global_time_selectable_enabled: description: Whether to allow viewers to select a different global time setting for the shared dashboard. nullable: true type: boolean invitees: description: The `SharedDashboard` `invitees`. example: [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}] items: $ref: "#/components/schemas/SharedDashboardInviteesItems" type: array selectable_template_vars: description: List of objects representing template variables on the shared dashboard which can have selectable values. example: [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}] items: $ref: "#/components/schemas/SelectableTemplateVariableItems" nullable: true type: array share_list: deprecated: true description: List of email addresses that can be given access to the shared dashboard. example: ["test@datadoghq.com", "test2@email.com"] items: description: Email address that can receive an invitation to access the shared dashboard. type: string nullable: true type: array share_type: $ref: "#/components/schemas/DashboardShareType" status: $ref: "#/components/schemas/SharedDashboardStatus" title: description: Title of the shared dashboard. type: string viewing_preferences: $ref: "#/components/schemas/ViewingPreferences" type: object SharedDashboardUpdateRequestGlobalTime: description: Timeframe setting for the shared dashboard. example: {"live_span": "1h"} nullable: true properties: live_span: $ref: "#/components/schemas/DashboardGlobalTimeLiveSpan" type: object SignalArchiveReason: description: Reason why a signal has been archived. enum: - none - false_positive - testing_or_maintenance - investigated_case_opened - true_positive_benign - true_positive_malicious - other type: string x-enum-varnames: - NONE - FALSE_POSITIVE - TESTING_OR_MAINTENANCE - INVESTIGATED_CASE_OPENED - TRUE_POSITIVE_BENIGN - TRUE_POSITIVE_MALICIOUS - OTHER SignalAssigneeUpdateRequest: description: Attributes describing an assignee update operation over a security signal. properties: assignee: description: The UUID of the user being assigned. Use empty string to return signal to unassigned. example: 773b045d-ccf8-4808-bd3b-955ef6a8c940 type: string version: $ref: "#/components/schemas/Version" required: - assignee type: object SignalStateUpdateRequest: description: Attributes describing the change of state for a given state. properties: archiveComment: description: Optional comment to explain why a signal is being archived. type: string archiveReason: $ref: "#/components/schemas/SignalArchiveReason" state: $ref: "#/components/schemas/SignalTriageState" version: $ref: "#/components/schemas/Version" required: - state type: object SignalTriageState: description: The new triage state of the signal. enum: - open - archived - under_review example: "open" type: string x-enum-varnames: - OPEN - ARCHIVED - UNDER_REVIEW SlackIntegrationChannel: description: The Slack channel configuration. properties: display: $ref: "#/components/schemas/SlackIntegrationChannelDisplay" name: description: Your channel name. example: "#general" type: string type: object SlackIntegrationChannelDisplay: description: Configuration options for what is shown in an alert event message. properties: message: default: true description: Show the main body of the alert event. type: boolean mute_buttons: default: false description: Show interactive buttons to mute the alerting monitor. type: boolean notified: default: true description: Show the list of @-handles in the alert event. type: boolean snapshot: default: true description: Show the alert event's snapshot image. type: boolean tags: default: true description: Show the scopes on which the monitor alerted. type: boolean type: object SlackIntegrationChannels: description: A list of configured Slack channels. example: [{"display": {"message": true, "mute_buttons": true, "notified": true, "snapshot": true, "tags": true}, "name": "#channel_name_main_account"}, {"display": {"message": true, "mute_buttons": true, "notified": true, "snapshot": false, "tags": true}, "name": "#channel_name_doghouse"}] items: $ref: "#/components/schemas/SlackIntegrationChannel" type: array SplitConfig: description: Encapsulates all user choices about how to split a graph. properties: limit: description: Maximum number of graphs to display in the widget. example: 24 format: int64 maximum: 500 minimum: 1 type: integer sort: $ref: "#/components/schemas/SplitSort" split_dimensions: description: The dimension(s) on which to split the graph example: - {"one_graph_per": "service"} items: $ref: "#/components/schemas/SplitDimension" maxItems: 1 minItems: 1 type: array static_splits: description: Manual selection of tags making split graph widget static items: $ref: "#/components/schemas/SplitVectorEntry" maxItems: 500 type: array required: - split_dimensions - limit - sort type: object SplitConfigSortCompute: description: Defines the metric and aggregation used as the sort value. properties: aggregation: description: How to aggregate the sort metric for the purposes of ordering. example: "sum" type: string metric: description: The metric to use for sorting graphs. example: "system.cpu.user" type: string required: - aggregation - metric type: object SplitDimension: description: The property by which the graph splits example: {"one_graph_per": "service"} properties: one_graph_per: description: The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. example: "service" type: string required: - one_graph_per type: object SplitGraphSourceWidgetDefinition: description: The original widget we are splitting on. oneOf: - $ref: "#/components/schemas/BarChartWidgetDefinition" - $ref: "#/components/schemas/ChangeWidgetDefinition" - $ref: "#/components/schemas/GeomapWidgetDefinition" - $ref: "#/components/schemas/QueryValueWidgetDefinition" - $ref: "#/components/schemas/ScatterPlotWidgetDefinition" - $ref: "#/components/schemas/SunburstWidgetDefinition" - $ref: "#/components/schemas/TableWidgetDefinition" - $ref: "#/components/schemas/TimeseriesWidgetDefinition" - $ref: "#/components/schemas/ToplistWidgetDefinition" - $ref: "#/components/schemas/TreeMapWidgetDefinition" SplitGraphVizSize: description: Size of the individual graphs in the split. enum: - xs - sm - md - lg example: sm type: string x-enum-varnames: - XS - SM - MD - LG SplitGraphWidgetDefinition: description: |- The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) properties: has_uniform_y_axes: description: Normalize y axes across graphs type: boolean size: $ref: "#/components/schemas/SplitGraphVizSize" source_widget_definition: $ref: "#/components/schemas/SplitGraphSourceWidgetDefinition" split_config: $ref: "#/components/schemas/SplitConfig" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string type: $ref: "#/components/schemas/SplitGraphWidgetDefinitionType" required: - size - type - source_widget_definition - split_config type: object SplitGraphWidgetDefinitionType: default: split_group description: Type of the split graph widget enum: - split_group example: split_group type: string x-enum-varnames: - SPLIT_GROUP SplitSort: description: Controls the order in which graphs appear in the split. properties: compute: $ref: "#/components/schemas/SplitConfigSortCompute" order: $ref: "#/components/schemas/WidgetSort" required: - order type: object SplitVectorEntry: description: The widget displays one graph for each entry in this parameter. example: [{"tag_key": "demo", "tag_values": ["env"]}] items: $ref: "#/components/schemas/SplitVectorEntryItem" minItems: 1 type: array SplitVectorEntryItem: description: The split graph list contains a graph for each value of the split dimension. minLength: 1 properties: tag_key: description: The tag key. example: "demo" minLength: 1 type: string tag_values: description: The tag values. example: ["env"] items: description: A tag value string. minLength: 1 type: string type: array required: - tag_key - tag_values type: object SuccessfulSignalUpdateResponse: description: Updated signal data following a successfully performed update. properties: status: description: Status of the response. type: string type: object SunburstWidgetDefinition: description: Sunbursts are spot on to highlight how groups contribute to the total of a query. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string hide_total: description: Show the total value in this widget. type: boolean legend: $ref: "#/components/schemas/SunburstWidgetLegend" requests: description: List of sunburst widget requests. example: ["q/apm_query/log_query": "{}"] items: $ref: "#/components/schemas/SunburstWidgetRequest" minItems: 1 type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/SunburstWidgetDefinitionType" required: - type - requests type: object SunburstWidgetDefinitionType: default: sunburst description: Type of the Sunburst widget. enum: - sunburst example: sunburst type: string x-enum-varnames: - SUNBURST SunburstWidgetLegend: description: Configuration of the legend. oneOf: - $ref: "#/components/schemas/SunburstWidgetLegendTable" - $ref: "#/components/schemas/SunburstWidgetLegendInlineAutomatic" SunburstWidgetLegendInlineAutomatic: description: Configuration of inline or automatic legends. properties: hide_percent: description: Whether to hide the percentages of the groups. type: boolean hide_value: description: Whether to hide the values of the groups. type: boolean type: $ref: "#/components/schemas/SunburstWidgetLegendInlineAutomaticType" required: - type type: object SunburstWidgetLegendInlineAutomaticType: description: Whether to show the legend inline or let it be automatically generated. enum: - inline - automatic example: "automatic" type: string x-enum-varnames: - INLINE - AUTOMATIC SunburstWidgetLegendTable: description: Configuration of table-based legend. properties: type: $ref: "#/components/schemas/SunburstWidgetLegendTableType" required: - type type: object SunburstWidgetLegendTableType: description: Whether or not to show a table legend. enum: - table - none example: "table" type: string x-enum-varnames: - TABLE - NONE SunburstWidgetRequest: description: Request definition of sunburst widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: $ref: "#/components/schemas/WidgetSortBy" style: $ref: "#/components/schemas/WidgetStyle" type: object SyntheticsAPIStep: description: The steps used in a Synthetic multi-step API test. oneOf: - $ref: "#/components/schemas/SyntheticsAPITestStep" - $ref: "#/components/schemas/SyntheticsAPIWaitStep" - $ref: "#/components/schemas/SyntheticsAPISubtestStep" SyntheticsAPISubtestStep: description: The subtest step used in a Synthetics multi-step API test. properties: allowFailure: description: Determines whether or not to continue with test if this step fails. type: boolean alwaysExecute: description: A boolean set to always execute this step even if the previous step failed or was skipped. type: boolean exitIfSucceed: description: Determines whether or not to exit the test if the step succeeds. type: boolean extractedValuesFromScript: description: Generate variables using JavaScript. type: string id: description: ID of the step. example: "abc-def-123" readOnly: true type: string isCritical: description: |- Determines whether or not to consider the entire test as failed if this step fails. Can be used only if `allowFailure` is `true`. type: boolean name: description: The name of the step. example: "Example step name" type: string retry: $ref: "#/components/schemas/SyntheticsTestOptionsRetry" subtestPublicId: description: Public ID of the test to be played as part of a `playSubTest` step type. example: "" type: string subtype: $ref: "#/components/schemas/SyntheticsAPISubtestStepSubtype" required: - name - subtype - subtestPublicId type: object SyntheticsAPISubtestStepSubtype: description: The subtype of the Synthetic multi-step API subtest step. enum: - playSubTest example: playSubTest type: string x-enum-varnames: - PLAY_SUB_TEST SyntheticsAPITest: description: Object containing details about a Synthetic API test. properties: config: $ref: "#/components/schemas/SyntheticsAPITestConfig" locations: description: Array of locations used to run the test. example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array message: description: Notification message associated with the test. example: Notification message type: string monitor_id: description: The associated monitor ID. example: 12345678 format: int64 readOnly: true type: integer name: description: Name of the test. example: "Example test name" type: string options: $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The public ID for the test. example: 123-abc-456 readOnly: true type: string status: $ref: "#/components/schemas/SyntheticsTestPauseStatus" subtype: $ref: "#/components/schemas/SyntheticsTestDetailsSubType" tags: description: Array of tags attached to the test. example: ["env:production"] items: description: A tag attached to the test. type: string type: array type: $ref: "#/components/schemas/SyntheticsAPITestType" required: - name - config - locations - options - type - message type: object SyntheticsAPITestConfig: description: Configuration object for a Synthetic API test. example: {"assertions": [{"operator": "lessThan", "target": 1000, "type": "responseTime"}], "request": {"method": "GET", "url": "https://example.com"}} properties: assertions: default: [] description: Array of assertions used for the test. Required for single API tests. example: [{"operator": "lessThan", "target": 1000, "type": "responseTime"}] items: $ref: "#/components/schemas/SyntheticsAssertion" type: array configVariables: description: Array of variables used for the test. items: $ref: "#/components/schemas/SyntheticsConfigVariable" type: array request: $ref: "#/components/schemas/SyntheticsTestRequest" steps: description: When the test subtype is `multi`, the steps of the test. items: $ref: "#/components/schemas/SyntheticsAPIStep" type: array variablesFromScript: description: Variables defined from JavaScript code. example: 'dd.variable.set("FOO", "foo")' type: string type: object SyntheticsAPITestResultData: description: Object containing results for your Synthetic API test. properties: cert: $ref: "#/components/schemas/SyntheticsSSLCertificate" eventType: $ref: "#/components/schemas/SyntheticsTestProcessStatus" failure: $ref: "#/components/schemas/SyntheticsApiTestResultFailure" httpStatusCode: description: The API test HTTP status code. format: int64 type: integer requestHeaders: additionalProperties: description: Requested request header. type: object description: Request header object used for the API test. type: object responseBody: description: Response body returned for the API test. type: string responseHeaders: additionalProperties: description: Returned request header. description: Response headers returned for the API test. type: object responseSize: description: Global size in byte of the API test response. format: int64 type: integer timings: $ref: "#/components/schemas/SyntheticsTiming" type: object SyntheticsAPITestResultFull: description: Object returned describing a API test result. properties: check: $ref: "#/components/schemas/SyntheticsAPITestResultFullCheck" check_time: description: When the API test was conducted. format: double type: number check_version: description: Version of the API test used. format: int64 type: integer probe_dc: description: Locations for which to query the API test results. type: string result: $ref: "#/components/schemas/SyntheticsAPITestResultData" result_id: description: ID of the API test result. type: string status: $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsAPITestResultFullCheck: description: Object describing the API test configuration. properties: config: $ref: "#/components/schemas/SyntheticsTestConfig" required: - config type: object SyntheticsAPITestResultShort: description: Object with the results of a single Synthetic API test. properties: check_time: description: Last time the API test was performed. format: double type: number probe_dc: description: Location from which the API test was performed. type: string result: $ref: "#/components/schemas/SyntheticsAPITestResultShortResult" result_id: description: ID of the API test result. type: string status: $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsAPITestResultShortResult: description: Result of the last API test run. properties: passed: description: Describes if the test run has passed or failed. type: boolean timings: $ref: "#/components/schemas/SyntheticsTiming" type: object SyntheticsAPITestStep: description: The Test step used in a Synthetic multi-step API test. properties: allowFailure: description: Determines whether or not to continue with test if this step fails. type: boolean assertions: default: [] description: Array of assertions used for the test. example: [{"operator": "lessThan", "target": 1000, "type": "responseTime"}] items: $ref: "#/components/schemas/SyntheticsAssertion" type: array exitIfSucceed: description: Determines whether or not to exit the test if the step succeeds. type: boolean extractedValues: description: Array of values to parse and save as variables from the response. items: $ref: "#/components/schemas/SyntheticsParsingOptions" type: array extractedValuesFromScript: description: Generate variables using JavaScript. type: string id: description: ID of the step. example: "abc-def-123" readOnly: true type: string isCritical: description: |- Determines whether or not to consider the entire test as failed if this step fails. Can be used only if `allowFailure` is `true`. type: boolean name: description: The name of the step. example: "Example step name" type: string request: $ref: "#/components/schemas/SyntheticsTestRequest" retry: $ref: "#/components/schemas/SyntheticsTestOptionsRetry" subtype: $ref: "#/components/schemas/SyntheticsAPITestStepSubtype" required: - assertions - request - name - subtype type: object SyntheticsAPITestStepSubtype: description: |- The subtype of the Synthetic multi-step API test step. enum: - http - grpc - ssl - dns - tcp - udp - icmp - websocket - mcp example: http type: string x-enum-varnames: - HTTP - GRPC - SSL - DNS - TCP - UDP - ICMP - WEBSOCKET - MCP SyntheticsAPITestType: default: "api" description: Type of the Synthetic test, `api`. enum: - api example: api type: string x-enum-varnames: - API SyntheticsAPIWaitStep: description: The Wait step used in a Synthetic multi-step API test. properties: id: description: ID of the step. example: "abc-def-123" readOnly: true type: string name: description: The name of the step. example: "Example step name" type: string subtype: $ref: "#/components/schemas/SyntheticsAPIWaitStepSubtype" value: description: "The time to wait in seconds. Minimum value: 0. Maximum value: 180." example: 5 format: int32 maximum: 180 minimum: 0 type: integer required: - name - subtype - value type: object SyntheticsAPIWaitStepSubtype: description: |- The subtype of the Synthetic multi-step API wait step. enum: - wait example: wait type: string x-enum-varnames: - WAIT SyntheticsApiTestFailureCode: description: Error code that can be returned by a Synthetic test. enum: - BODY_TOO_LARGE - DENIED - TOO_MANY_REDIRECTS - AUTHENTICATION_ERROR - DECRYPTION - INVALID_CHAR_IN_HEADER - HEADER_TOO_LARGE - HEADERS_INCOMPATIBLE_CONTENT_LENGTH - INVALID_REQUEST - REQUIRES_UPDATE - UNESCAPED_CHARACTERS_IN_REQUEST_PATH - MALFORMED_RESPONSE - INCORRECT_ASSERTION - CONNREFUSED - CONNRESET - DNS - HOSTUNREACH - NETUNREACH - TIMEOUT - SSL - OCSP - INVALID_TEST - TUNNEL - WEBSOCKET - UNKNOWN - INTERNAL_ERROR type: string x-enum-varnames: - BODY_TOO_LARGE - DENIED - TOO_MANY_REDIRECTS - AUTHENTICATION_ERROR - DECRYPTION - INVALID_CHAR_IN_HEADER - HEADER_TOO_LARGE - HEADERS_INCOMPATIBLE_CONTENT_LENGTH - INVALID_REQUEST - REQUIRES_UPDATE - UNESCAPED_CHARACTERS_IN_REQUEST_PATH - MALFORMED_RESPONSE - INCORRECT_ASSERTION - CONNREFUSED - CONNRESET - DNS - HOSTUNREACH - NETUNREACH - TIMEOUT - SSL - OCSP - INVALID_TEST - TUNNEL - WEBSOCKET - UNKNOWN - INTERNAL_ERROR SyntheticsApiTestResultFailure: description: The API test failure details. properties: code: $ref: "#/components/schemas/SyntheticsApiTestFailureCode" message: description: The API test error message. example: "Error during DNS resolution (ENOTFOUND)." type: string type: object SyntheticsAssertion: description: |- Object describing the assertions type, their associated operator, which property they apply, and upon which target. oneOf: - $ref: "#/components/schemas/SyntheticsAssertionTarget" - $ref: "#/components/schemas/SyntheticsAssertionBodyHashTarget" - $ref: "#/components/schemas/SyntheticsAssertionJSONPathTarget" - $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaTarget" - $ref: "#/components/schemas/SyntheticsAssertionXPathTarget" - $ref: "#/components/schemas/SyntheticsAssertionJavascript" - $ref: "#/components/schemas/SyntheticsAssertionMCPServerCapabilitiesTarget" - $ref: "#/components/schemas/SyntheticsAssertionMCPRespectsSpecification" SyntheticsAssertionBodyHashOperator: description: Assertion operator to apply. enum: - md5 - sha1 - sha256 example: md5 type: string x-enum-varnames: - MD5 - SHA1 - SHA256 SyntheticsAssertionBodyHashTarget: description: An assertion which targets body hash. properties: operator: $ref: "#/components/schemas/SyntheticsAssertionBodyHashOperator" target: $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: Value used by the operator. type: $ref: "#/components/schemas/SyntheticsAssertionBodyHashType" required: - type - operator - target type: object SyntheticsAssertionBodyHashType: description: Type of the assertion. enum: - bodyHash example: bodyHash type: string x-enum-varnames: - BODY_HASH SyntheticsAssertionJSONPathOperator: description: Assertion operator to apply. enum: - validatesJSONPath example: validatesJSONPath type: string x-enum-varnames: - VALIDATES_JSON_PATH SyntheticsAssertionJSONPathTarget: description: An assertion for the `validatesJSONPath` operator. properties: operator: $ref: "#/components/schemas/SyntheticsAssertionJSONPathOperator" property: description: The associated assertion property. type: string target: $ref: "#/components/schemas/SyntheticsAssertionJSONPathTargetTarget" type: $ref: "#/components/schemas/SyntheticsAssertionType" required: - type - operator type: object SyntheticsAssertionJSONPathTargetTarget: description: Composed target for `validatesJSONPath` operator. properties: elementsOperator: description: The element from the list of results to assert on. To choose from the first element in the list `firstElementMatches`, every element in the list `everyElementMatches`, at least one element in the list `atLeastOneElementMatches` or the serialized value of the list `serializationMatches`. type: string jsonPath: description: The JSON path to assert. type: string operator: description: The specific operator to use on the path. type: string targetValue: $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: The path target value to compare to. type: object SyntheticsAssertionJSONSchemaMetaSchema: description: The JSON Schema meta-schema version used in the assertion. enum: - draft-07 - draft-06 type: string x-enum-varnames: - DRAFT_07 - DRAFT_06 SyntheticsAssertionJSONSchemaOperator: description: Assertion operator to apply. enum: - validatesJSONSchema example: validatesJSONSchema type: string x-enum-varnames: - VALIDATES_JSON_SCHEMA SyntheticsAssertionJSONSchemaTarget: description: An assertion for the `validatesJSONSchema` operator. properties: operator: $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaOperator" target: $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget" type: $ref: "#/components/schemas/SyntheticsAssertionType" required: - type - operator type: object SyntheticsAssertionJSONSchemaTargetTarget: description: Composed target for `validatesJSONSchema` operator. properties: jsonSchema: description: The JSON Schema to assert. type: string metaSchema: $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema" type: object SyntheticsAssertionJavascript: description: A JavaScript assertion. properties: code: description: The JavaScript code that performs the assertions. example: dd.expect(dd.response.statusCode).to.equal(200); type: string type: $ref: "#/components/schemas/SyntheticsAssertionJavascriptType" required: - type - code type: object SyntheticsAssertionJavascriptType: description: Type of the assertion. enum: - javascript example: javascript type: string x-enum-varnames: - JAVASCRIPT SyntheticsAssertionMCPRespectsSpecification: description: An assertion that verifies the MCP server response respects the MCP specification. properties: type: $ref: "#/components/schemas/SyntheticsAssertionMCPRespectsSpecificationType" required: - type type: object SyntheticsAssertionMCPRespectsSpecificationType: description: Type of the assertion. enum: - mcpRespectsSpecification example: mcpRespectsSpecification type: string x-enum-varnames: - MCP_RESPECTS_SPECIFICATION SyntheticsAssertionMCPServerCapabilitiesTarget: description: An assertion that checks that an MCP server advertises the expected capabilities. properties: operator: $ref: "#/components/schemas/SyntheticsAssertionOperator" target: description: List of MCP server capabilities to assert against. example: - completions items: $ref: "#/components/schemas/SyntheticsMCPServerCapability" type: array type: $ref: "#/components/schemas/SyntheticsAssertionMCPServerCapabilitiesType" required: - type - operator - target type: object SyntheticsAssertionMCPServerCapabilitiesType: description: Type of the assertion. enum: - mcpServerCapabilities example: mcpServerCapabilities type: string x-enum-varnames: - MCP_SERVER_CAPABILITIES SyntheticsAssertionOperator: description: Assertion operator to apply. enum: - contains - doesNotContain - is - isNot - lessThan - lessThanOrEqual - moreThan - moreThanOrEqual - matches - doesNotMatch - validates - isInMoreThan - isInLessThan - doesNotExist - isUndefined example: contains type: string x-enum-varnames: - CONTAINS - DOES_NOT_CONTAIN - IS - IS_NOT - LESS_THAN - LESS_THAN_OR_EQUAL - MORE_THAN - MORE_THAN_OR_EQUAL - MATCHES - DOES_NOT_MATCH - VALIDATES - IS_IN_MORE_DAYS_THAN - IS_IN_LESS_DAYS_THAN - DOES_NOT_EXIST - IS_UNDEFINED SyntheticsAssertionTarget: description: An assertion which uses a simple target. properties: operator: $ref: "#/components/schemas/SyntheticsAssertionOperator" property: description: The associated assertion property. type: string target: $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: Value used by the operator. timingsScope: $ref: "#/components/schemas/SyntheticsAssertionTimingsScope" type: $ref: "#/components/schemas/SyntheticsAssertionType" required: - type - operator - target type: object SyntheticsAssertionTargetValue: description: Value used by the operator in assertions. Can be either a number or string. example: 0.0 oneOf: - $ref: "#/components/schemas/SyntheticsAssertionTargetValueNumber" - $ref: "#/components/schemas/SyntheticsAssertionTargetValueString" SyntheticsAssertionTargetValueNumber: description: Numeric value used by the operator in assertions. format: double type: number SyntheticsAssertionTargetValueString: description: String value used by the operator in assertions. Supports templated variables. type: string SyntheticsAssertionTimingsScope: description: Timings scope for response time assertions. enum: - all - withoutDNS type: string x-enum-varnames: - ALL - WITHOUT_DNS SyntheticsAssertionType: description: Type of the assertion. enum: - body - header - statusCode - certificate - responseTime - property - recordEvery - recordSome - tlsVersion - minTlsVersion - latency - packetLossPercentage - packetsReceived - networkHop - receivedMessage - grpcHealthcheckStatus - grpcMetadata - grpcProto - connection - multiNetworkHop - jitter - mcpToolNameLength - mcpToolCount example: statusCode type: string x-enum-varnames: - BODY - HEADER - STATUS_CODE - CERTIFICATE - RESPONSE_TIME - PROPERTY - RECORD_EVERY - RECORD_SOME - TLS_VERSION - MIN_TLS_VERSION - LATENCY - PACKET_LOSS_PERCENTAGE - PACKETS_RECEIVED - NETWORK_HOP - RECEIVED_MESSAGE - GRPC_HEALTHCHECK_STATUS - GRPC_METADATA - GRPC_PROTO - CONNECTION - MULTI_NETWORK_HOP - JITTER - MCP_TOOL_NAME_LENGTH - MCP_TOOL_COUNT SyntheticsAssertionXPathOperator: description: Assertion operator to apply. enum: - validatesXPath example: validatesXPath type: string x-enum-varnames: - VALIDATES_X_PATH SyntheticsAssertionXPathTarget: description: An assertion for the `validatesXPath` operator. properties: operator: $ref: "#/components/schemas/SyntheticsAssertionXPathOperator" property: description: The associated assertion property. type: string target: $ref: "#/components/schemas/SyntheticsAssertionXPathTargetTarget" type: $ref: "#/components/schemas/SyntheticsAssertionType" required: - type - operator type: object SyntheticsAssertionXPathTargetTarget: description: Composed target for `validatesXPath` operator. properties: operator: description: The specific operator to use on the path. type: string targetValue: $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: The path target value to compare to. xPath: description: The X path to assert. type: string type: object SyntheticsBasicAuth: description: Object to handle basic authentication when performing the test. oneOf: - $ref: "#/components/schemas/SyntheticsBasicAuthWeb" - $ref: "#/components/schemas/SyntheticsBasicAuthSigv4" - $ref: "#/components/schemas/SyntheticsBasicAuthNTLM" - $ref: "#/components/schemas/SyntheticsBasicAuthDigest" - $ref: "#/components/schemas/SyntheticsBasicAuthOauthClient" - $ref: "#/components/schemas/SyntheticsBasicAuthOauthROP" - $ref: "#/components/schemas/SyntheticsBasicAuthJWT" SyntheticsBasicAuthDigest: description: Object to handle digest authentication when performing the test. properties: password: description: Password to use for the digest authentication. example: "PaSSw0RD!" type: string type: $ref: "#/components/schemas/SyntheticsBasicAuthDigestType" username: description: Username to use for the digest authentication. example: "my_username" type: string required: - password - username - type type: object SyntheticsBasicAuthDigestType: default: "digest" description: The type of basic authentication to use when performing the test. enum: - digest example: "digest" type: string x-enum-varnames: - DIGEST SyntheticsBasicAuthJWT: description: Object to handle JWT authentication when performing the test. properties: addClaims: $ref: "#/components/schemas/SyntheticsBasicAuthJWTAddClaims" algorithm: $ref: "#/components/schemas/SyntheticsBasicAuthJWTAlgorithm" expiresIn: description: Token time-to-live in seconds. example: 3600 format: int64 minimum: 1 type: integer header: description: Custom JWT header as a JSON string. example: '{"kid": "my-key-id"}' type: string payload: description: JWT claims as a JSON string. example: '{"sub": "1234567890", "name": "John Doe"}' type: string secret: description: |- Signing key for the JWT authentication. Use the shared secret for `HS256` or the private key (PEM format) for `RS256` and `ES256`. example: "mysecretkey" type: string tokenPrefix: description: Prefix added before the token in the `Authorization` header. Defaults to `Bearer`. example: "Bearer" type: string type: $ref: "#/components/schemas/SyntheticsBasicAuthJWTType" required: - algorithm - payload - secret - type type: object SyntheticsBasicAuthJWTAddClaims: description: Standard JWT claims to automatically inject. properties: exp: description: Whether to inject the `exp` (expiration) claim. example: true type: boolean iat: description: Whether to inject the `iat` (issued at) claim. example: true type: boolean type: object SyntheticsBasicAuthJWTAlgorithm: description: Algorithm to use for the JWT authentication. enum: - HS256 - RS256 - ES256 example: "HS256" type: string x-enum-varnames: - HS256 - RS256 - ES256 SyntheticsBasicAuthJWTType: default: "jwt" description: The type of authentication to use when performing the test. enum: - jwt example: "jwt" type: string x-enum-varnames: - JWT SyntheticsBasicAuthNTLM: description: Object to handle `NTLM` authentication when performing the test. properties: domain: description: Domain for the authentication to use when performing the test. example: "DOMAINNAME" type: string password: description: Password for the authentication to use when performing the test. example: "examplepassword" type: string type: $ref: "#/components/schemas/SyntheticsBasicAuthNTLMType" username: description: Username for the authentication to use when performing the test. example: "joedoe" type: string workstation: description: Workstation for the authentication to use when performing the test. example: "" type: string required: - type type: object SyntheticsBasicAuthNTLMType: default: "ntlm" description: The type of authentication to use when performing the test. enum: - ntlm example: "ntlm" type: string x-enum-varnames: - NTLM SyntheticsBasicAuthOauthClient: description: Object to handle `oauth client` authentication when performing the test. properties: accessTokenUrl: description: Access token URL to use when performing the authentication. example: "https://example.com" type: string audience: description: Audience to use when performing the authentication. example: "audience" type: string clientId: description: Client ID to use when performing the authentication. example: "oauth-username" type: string clientSecret: description: Client secret to use when performing the authentication. example: "oauth-password" type: string resource: description: Resource to use when performing the authentication. example: "resource" type: string scope: description: Scope to use when performing the authentication. example: "scope" type: string tokenApiAuthentication: $ref: "#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication" type: $ref: "#/components/schemas/SyntheticsBasicAuthOauthClientType" required: - accessTokenUrl - tokenApiAuthentication - clientId - clientSecret - type type: object SyntheticsBasicAuthOauthClientType: default: "oauth-client" description: The type of basic authentication to use when performing the test. enum: - oauth-client example: "oauth-client" type: string x-enum-varnames: - OAUTH_CLIENT SyntheticsBasicAuthOauthROP: description: Object to handle `oauth rop` authentication when performing the test. properties: accessTokenUrl: description: Access token URL to use when performing the authentication. example: "https://example.com" type: string audience: description: Audience to use when performing the authentication. example: "audience" type: string clientId: description: Client ID to use when performing the authentication. example: "client-id" type: string clientSecret: description: Client secret to use when performing the authentication. example: "client-secret" type: string password: description: Password to use when performing the authentication. example: "password" type: string resource: description: Resource to use when performing the authentication. example: "resource" type: string scope: description: Scope to use when performing the authentication. example: "scope" type: string tokenApiAuthentication: $ref: "#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication" type: $ref: "#/components/schemas/SyntheticsBasicAuthOauthROPType" username: description: Username to use when performing the authentication. example: "username" type: string required: - accessTokenUrl - password - tokenApiAuthentication - username - type type: object SyntheticsBasicAuthOauthROPType: default: "oauth-rop" description: The type of basic authentication to use when performing the test. enum: - oauth-rop example: "oauth-rop" type: string x-enum-varnames: - OAUTH_ROP SyntheticsBasicAuthOauthTokenApiAuthentication: description: Type of token to use when performing the authentication. enum: - header - body example: "header" type: string x-enum-varnames: - HEADER - BODY SyntheticsBasicAuthSigv4: description: Object to handle `SIGV4` authentication when performing the test. properties: accessKey: description: Access key for the `SIGV4` authentication. example: "AKIAIOSFODNN7EXAMPLE" type: string region: description: Region for the `SIGV4` authentication. example: "us-east-1" type: string secretKey: description: Secret key for the `SIGV4` authentication. example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY" type: string serviceName: description: Service name for the `SIGV4` authentication. example: "execute-api" type: string sessionToken: description: Session token for the `SIGV4` authentication. example: |- AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE type: string type: $ref: "#/components/schemas/SyntheticsBasicAuthSigv4Type" required: - accessKey - secretKey - type type: object SyntheticsBasicAuthSigv4Type: default: "sigv4" description: The type of authentication to use when performing the test. enum: - sigv4 example: "sigv4" type: string x-enum-varnames: - SIGV4 SyntheticsBasicAuthWeb: description: Object to handle basic authentication when performing the test. properties: password: description: Password to use for the basic authentication. example: "PaSSw0RD!" type: string type: $ref: "#/components/schemas/SyntheticsBasicAuthWebType" username: description: Username to use for the basic authentication. example: "my_username" type: string type: object SyntheticsBasicAuthWebType: default: "web" description: The type of basic authentication to use when performing the test. enum: - web example: "web" type: string x-enum-varnames: - WEB SyntheticsBatchDetails: description: Details about a batch response. properties: data: $ref: "#/components/schemas/SyntheticsBatchDetailsData" type: object SyntheticsBatchDetailsData: description: Wrapper object that contains the details of a batch. properties: metadata: $ref: "#/components/schemas/SyntheticsCIBatchMetadata" results: description: List of results for the batch. items: $ref: "#/components/schemas/SyntheticsBatchResult" type: array status: $ref: "#/components/schemas/SyntheticsBatchStatus" type: object SyntheticsBatchResult: description: Object with the results of a Synthetic batch. properties: device: $ref: "#/components/schemas/SyntheticsDeviceID" duration: description: Total duration in millisecond of the test. format: double type: number execution_rule: $ref: "#/components/schemas/SyntheticsTestExecutionRule" location: description: Name of the location. type: string result_id: description: The ID of the result to get. type: string retries: description: Number of times this result has been retried. format: double type: number status: $ref: "#/components/schemas/SyntheticsBatchStatus" test_name: description: Name of the test. type: string test_public_id: description: The public ID of the Synthetic test. type: string test_type: $ref: "#/components/schemas/SyntheticsTestDetailsType" type: object SyntheticsBatchStatus: description: Determines whether the batch has passed, failed, or is in progress. enum: - passed - skipped - failed type: string x-enum-varnames: - PASSED - SKIPPED - FAILED SyntheticsBrowserError: description: Error response object for a browser test. properties: description: description: Description of the error. example: "Example error message" type: string name: description: Name of the error. example: "Failed test" type: string status: description: Status Code of the error. example: 500 format: int64 type: integer type: $ref: "#/components/schemas/SyntheticsBrowserErrorType" required: - description - name - type type: object SyntheticsBrowserErrorType: description: Error type returned by a browser test. enum: - network - js example: network type: string x-enum-varnames: - NETWORK - JS SyntheticsBrowserTest: description: Object containing details about a Synthetic browser test. properties: config: $ref: "#/components/schemas/SyntheticsBrowserTestConfig" locations: description: Array of locations used to run the test. example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array message: description: Notification message associated with the test. Message can either be text or an empty string. example: "" type: string monitor_id: description: The associated monitor ID. format: int64 readOnly: true type: integer name: description: Name of the test. example: "Example test name" type: string options: $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The public ID of the test. readOnly: true type: string status: $ref: "#/components/schemas/SyntheticsTestPauseStatus" steps: description: Array of steps for the test. items: $ref: "#/components/schemas/SyntheticsStep" type: array tags: description: Array of tags attached to the test. example: ["env:prod"] items: description: A tag attached to the test. type: string type: array type: $ref: "#/components/schemas/SyntheticsBrowserTestType" required: - config - locations - name - options - type - message type: object SyntheticsBrowserTestConfig: description: Configuration object for a Synthetic browser test. properties: assertions: default: [] description: Array of assertions used for the test. example: [] items: $ref: "#/components/schemas/SyntheticsAssertion" type: array configVariables: description: Array of variables used for the test. items: $ref: "#/components/schemas/SyntheticsConfigVariable" type: array request: $ref: "#/components/schemas/SyntheticsTestRequest" setCookie: description: Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax. type: string variables: description: Array of variables used for the test steps. items: $ref: "#/components/schemas/SyntheticsBrowserVariable" type: array required: - request - assertions type: object SyntheticsBrowserTestFailureCode: description: Error code that can be returned by a Synthetic test. enum: - API_REQUEST_FAILURE - ASSERTION_FAILURE - DOWNLOAD_FILE_TOO_LARGE - ELEMENT_NOT_INTERACTABLE - EMAIL_VARIABLE_NOT_DEFINED - EVALUATE_JAVASCRIPT - EVALUATE_JAVASCRIPT_CONTEXT - EXTRACT_VARIABLE - FORBIDDEN_URL - FRAME_DETACHED - INCONSISTENCIES - INTERNAL_ERROR - INVALID_TYPE_TEXT_DELAY - INVALID_URL - INVALID_VARIABLE_PATTERN - INVISIBLE_ELEMENT - LOCATE_ELEMENT - NAVIGATE_TO_LINK - OPEN_URL - PRESS_KEY - SERVER_CERTIFICATE - SELECT_OPTION - STEP_TIMEOUT - SUB_TEST_NOT_PASSED - TEST_TIMEOUT - TOO_MANY_HTTP_REQUESTS - UNAVAILABLE_BROWSER - UNKNOWN - UNSUPPORTED_AUTH_SCHEMA - UPLOAD_FILES_ELEMENT_TYPE - UPLOAD_FILES_DIALOG - UPLOAD_FILES_DYNAMIC_ELEMENT - UPLOAD_FILES_NAME type: string x-enum-varnames: - API_REQUEST_FAILURE - ASSERTION_FAILURE - DOWNLOAD_FILE_TOO_LARGE - ELEMENT_NOT_INTERACTABLE - EMAIL_VARIABLE_NOT_DEFINED - EVALUATE_JAVASCRIPT - EVALUATE_JAVASCRIPT_CONTEXT - EXTRACT_VARIABLE - FORBIDDEN_URL - FRAME_DETACHED - INCONSISTENCIES - INTERNAL_ERROR - INVALID_TYPE_TEXT_DELAY - INVALID_URL - INVALID_VARIABLE_PATTERN - INVISIBLE_ELEMENT - LOCATE_ELEMENT - NAVIGATE_TO_LINK - OPEN_URL - PRESS_KEY - SERVER_CERTIFICATE - SELECT_OPTION - STEP_TIMEOUT - SUB_TEST_NOT_PASSED - TEST_TIMEOUT - TOO_MANY_HTTP_REQUESTS - UNAVAILABLE_BROWSER - UNKNOWN - UNSUPPORTED_AUTH_SCHEMA - UPLOAD_FILES_ELEMENT_TYPE - UPLOAD_FILES_DIALOG - UPLOAD_FILES_DYNAMIC_ELEMENT - UPLOAD_FILES_NAME SyntheticsBrowserTestResultData: description: Object containing results for your Synthetic browser test. properties: browserType: description: Type of browser device used for the browser test. type: string browserVersion: description: Browser version used for the browser test. type: string device: $ref: "#/components/schemas/SyntheticsDevice" duration: description: Global duration in second of the browser test. format: double type: number error: description: Error returned for the browser test. type: string failure: $ref: "#/components/schemas/SyntheticsBrowserTestResultFailure" passed: description: Whether or not the browser test was conducted. type: boolean receivedEmailCount: description: The amount of email received during the browser test. format: int64 type: integer startUrl: description: Starting URL for the browser test. type: string stepDetails: description: Array containing the different browser test steps. items: $ref: "#/components/schemas/SyntheticsStepDetail" type: array thumbnailsBucketKey: description: Whether or not a thumbnail is associated with the browser test. type: boolean timeToInteractive: description: |- Time in second to wait before the browser test starts after reaching the start URL. format: double type: number type: object SyntheticsBrowserTestResultFailure: description: The browser test failure details. properties: code: $ref: "#/components/schemas/SyntheticsBrowserTestFailureCode" message: description: The browser test error message. example: "Error during DNS resolution (ENOTFOUND)." type: string type: object SyntheticsBrowserTestResultFull: description: Object returned describing a browser test result. properties: check: $ref: "#/components/schemas/SyntheticsBrowserTestResultFullCheck" check_time: description: When the browser test was conducted. format: double type: number check_version: description: Version of the browser test used. format: int64 type: integer probe_dc: description: Location from which the browser test was performed. type: string result: $ref: "#/components/schemas/SyntheticsBrowserTestResultData" result_id: description: ID of the browser test result. type: string status: $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsBrowserTestResultFullCheck: description: Object describing the browser test configuration. properties: config: $ref: "#/components/schemas/SyntheticsTestConfig" required: - config type: object SyntheticsBrowserTestResultShort: description: Object with the results of a single Synthetic browser test. properties: check_time: description: Last time the browser test was performed. format: double type: number probe_dc: description: Location from which the Browser test was performed. type: string result: $ref: "#/components/schemas/SyntheticsBrowserTestResultShortResult" result_id: description: ID of the browser test result. type: string status: $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsBrowserTestResultShortResult: description: Object with the result of the last browser test run. properties: device: $ref: "#/components/schemas/SyntheticsDevice" duration: description: Length in milliseconds of the browser test run. format: double type: number errorCount: description: Amount of errors collected for a single browser test run. format: int64 type: integer stepCountCompleted: description: Amount of browser test steps completed before failing. format: int64 type: integer stepCountTotal: description: Total amount of browser test steps. format: int64 type: integer type: object SyntheticsBrowserTestRumSettings: description: |- The RUM data collection settings for the Synthetic browser test. **Note:** There are 3 ways to format RUM settings: `{ isEnabled: false }` RUM data is not collected. `{ isEnabled: true }` RUM data is collected from the Synthetic test's default application. `{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }` RUM data is collected using the specified application. example: {"applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clientTokenId": 12345, "isEnabled": true} properties: applicationId: description: RUM application ID used to collect RUM data for the browser test. example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: string clientTokenId: description: RUM application API key ID used to collect RUM data for the browser test. example: 12345 format: int64 type: integer isEnabled: description: Determines whether RUM data is collected during test runs. example: true type: boolean required: - isEnabled type: object SyntheticsBrowserTestType: default: "browser" description: Type of the Synthetic test, `browser`. enum: - browser example: "browser" type: string x-enum-varnames: - BROWSER SyntheticsBrowserVariable: description: |- Object defining a variable that can be used in your browser test. See the [Recording Steps documentation](https://docs.datadoghq.com/synthetics/browser_tests/actions/?tab=testanelementontheactivepage#variables). properties: example: description: Example for the variable. type: string id: description: ID for the variable. Global variables require an ID. type: string name: description: Name of the variable. example: "VARIABLE_NAME" type: string pattern: description: Pattern of the variable. type: string secure: description: Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type `text`. type: boolean type: $ref: "#/components/schemas/SyntheticsBrowserVariableType" required: - type - name type: object SyntheticsBrowserVariableType: description: Type of browser test variable. enum: - element - email - global - text example: text type: string x-enum-varnames: - ELEMENT - EMAIL - GLOBAL - TEXT SyntheticsCIBatchMetadata: description: Metadata for the Synthetic tests run. properties: ci: $ref: "#/components/schemas/SyntheticsCIBatchMetadataCI" git: $ref: "#/components/schemas/SyntheticsCIBatchMetadataGit" type: object SyntheticsCIBatchMetadataCI: description: Description of the CI provider. properties: pipeline: $ref: "#/components/schemas/SyntheticsCIBatchMetadataPipeline" provider: $ref: "#/components/schemas/SyntheticsCIBatchMetadataProvider" type: object SyntheticsCIBatchMetadataGit: description: Git information. properties: branch: description: Branch name. type: string commitSha: description: The commit SHA. type: string type: object SyntheticsCIBatchMetadataPipeline: description: Description of the CI pipeline. properties: url: description: URL of the pipeline. type: string type: object SyntheticsCIBatchMetadataProvider: description: Description of the CI provider. properties: name: description: Name of the CI provider. type: string type: object SyntheticsCITest: description: Configuration for Continuous Testing. properties: allowInsecureCertificates: description: Disable certificate checks in API tests. type: boolean basicAuth: $ref: "#/components/schemas/SyntheticsBasicAuth" body: description: Body to include in the test. type: string bodyType: description: Type of the data sent in a Synthetic API test. type: string cookies: description: Cookies for the request. type: string deviceIds: description: For browser test, array with the different device IDs used to run the test. items: $ref: "#/components/schemas/SyntheticsDeviceID" type: array followRedirects: description: For API HTTP test, whether or not the test should follow redirects. type: boolean headers: $ref: "#/components/schemas/SyntheticsTestHeaders" locations: description: Array of locations used to run the test. example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array metadata: $ref: "#/components/schemas/SyntheticsCIBatchMetadata" public_id: description: The public ID of the Synthetic test to trigger. example: aaa-aaa-aaa type: string retry: $ref: "#/components/schemas/SyntheticsTestOptionsRetry" startUrl: description: Starting URL for the browser test. type: string variables: additionalProperties: description: A single variable. type: string description: Variables to replace in the test. type: object version: description: The version number of the Synthetic test version to trigger. format: int64 type: integer required: - public_id type: object SyntheticsCITestBody: description: Object describing the synthetics tests to trigger. properties: tests: description: List of Synthetic tests with overrides. items: $ref: "#/components/schemas/SyntheticsCITest" type: array type: object SyntheticsCheckType: description: Type of assertion to apply in an API test. enum: - equals - notEquals - contains - notContains - startsWith - notStartsWith - greater - lower - greaterEquals - lowerEquals - matchRegex - between - isEmpty - notIsEmpty type: string x-enum-varnames: - EQUALS - NOT_EQUALS - CONTAINS - NOT_CONTAINS - STARTS_WITH - NOT_STARTS_WITH - GREATER - LOWER - GREATER_EQUALS - LOWER_EQUALS - MATCH_REGEX - BETWEEN - IS_EMPTY - NOT_IS_EMPTY SyntheticsConfigVariable: description: |- Object defining a variable that can be used in your test configuration. properties: example: description: Example for the variable. type: string id: description: ID of the variable for global variables. type: string name: description: Name of the variable. example: "VARIABLE_NAME" type: string pattern: description: Pattern of the variable. type: string secure: description: Whether the value of this variable will be obfuscated in test results. Only for config variables of type `text`. example: false type: boolean type: $ref: "#/components/schemas/SyntheticsConfigVariableType" required: - type - name type: object SyntheticsConfigVariableType: description: Type of the configuration variable. enum: - global - text - email example: text type: string x-enum-varnames: - GLOBAL - TEXT - EMAIL SyntheticsCoreWebVitals: description: Core Web Vitals attached to a browser test step. properties: cls: description: Cumulative Layout Shift. format: double type: number lcp: description: Largest Contentful Paint in milliseconds. format: double type: number url: description: URL attached to the metrics. type: string type: object SyntheticsDefaultLocations: description: List of Synthetics default locations settings. example: ["aws:eu-west-3"] items: description: Name of the location. type: string type: array SyntheticsDeleteTestsPayload: description: |- A JSON list of the ID or IDs of the Synthetic tests that you want to delete. properties: force_delete_dependencies: description: |- Delete the Synthetic test even if it's referenced by other resources (for example, SLOs and composite monitors). example: false type: boolean public_ids: description: An array of Synthetic test IDs you want to delete. example: [] items: description: A Synthetic test ID to delete. example: "abc-def-123" type: string type: array type: object SyntheticsDeleteTestsResponse: description: Response object for deleting Synthetic tests. properties: deleted_tests: description: |- Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp. items: $ref: "#/components/schemas/SyntheticsDeletedTest" type: array type: object SyntheticsDeletedTest: description: |- Object containing a deleted Synthetic test ID with the associated deletion timestamp. properties: deleted_at: description: Deletion timestamp of the Synthetic test ID. format: date-time type: string public_id: description: The Synthetic test ID deleted. type: string type: object SyntheticsDevice: description: Object describing the device used to perform the Synthetic test. properties: height: description: Screen height of the device. example: 0 format: int64 type: integer id: $ref: "#/components/schemas/SyntheticsDeviceID" isMobile: description: Whether or not the device is a mobile. type: boolean name: description: The device name. example: "" type: string width: description: Screen width of the device. example: 0 format: int64 type: integer required: - id - name - height - width type: object SyntheticsDeviceID: description: The device ID. example: chrome.laptop_large type: string SyntheticsFetchUptimesPayload: description: |- Object containing IDs of Synthetic tests and a timeframe. properties: from_ts: description: Timestamp in seconds (Unix epoch) for the start of uptime. example: 0 format: int64 type: integer public_ids: description: An array of Synthetic test IDs you want uptimes for. example: [] items: description: A Synthetic test ID. example: "abc-def-123" type: string type: array to_ts: description: Timestamp in seconds (Unix epoch) for the end of uptime. example: 0 format: int64 type: integer required: - from_ts - to_ts - public_ids type: object SyntheticsGetAPITestLatestResultsResponse: description: Object with the latest Synthetic API test run. properties: last_timestamp_fetched: description: Timestamp of the latest API test run. format: int64 type: integer results: description: Result of the latest API test run. items: $ref: "#/components/schemas/SyntheticsAPITestResultShort" type: array type: object SyntheticsGetBrowserTestLatestResultsResponse: description: Object with the latest Synthetic browser test run. properties: last_timestamp_fetched: description: Timestamp of the latest browser test run. format: int64 type: integer results: description: Result of the latest browser test run. items: $ref: "#/components/schemas/SyntheticsBrowserTestResultShort" type: array type: object SyntheticsGlobalVariable: description: Synthetic global variable. properties: attributes: $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes" description: description: Description of the global variable. example: "Example description" type: string id: description: Unique identifier of the global variable. readOnly: true type: string is_fido: description: Determines if the global variable is a FIDO variable. type: boolean is_totp: description: Determines if the global variable is a TOTP/MFA variable. type: boolean name: description: Name of the global variable. Unique across Synthetic global variables. example: "MY_VARIABLE" type: string parse_test_options: $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions" parse_test_public_id: description: A Synthetic test ID to use as a test to generate the variable value. example: "abc-def-123" type: string tags: description: Tags of the global variable. example: ["team:front", "test:workflow-1"] items: description: Tag name. type: string type: array value: $ref: "#/components/schemas/SyntheticsGlobalVariableValue" required: - description - name - tags - value type: object SyntheticsGlobalVariableAttributes: description: Attributes of the global variable. properties: restricted_roles: $ref: "#/components/schemas/SyntheticsRestrictedRoles" type: object SyntheticsGlobalVariableOptions: description: Options for the Global Variable for MFA. properties: totp_parameters: $ref: "#/components/schemas/SyntheticsGlobalVariableTOTPParameters" type: object SyntheticsGlobalVariableParseTestOptions: description: Parser options to use for retrieving a Synthetic global variable from a Synthetic test. Used in conjunction with `parse_test_public_id`. properties: field: description: When type is `http_header`, name of the header to use to extract the value. example: "content-type" type: string localVariableName: description: When type is `local_variable`, name of the local variable to use to extract the value. example: "LOCAL_VARIABLE" type: string parser: $ref: "#/components/schemas/SyntheticsVariableParser" type: $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType" required: - type type: object SyntheticsGlobalVariableParseTestOptionsType: description: Type of value to extract from a test for a Synthetic global variable. enum: - http_body - http_header - http_status_code - local_variable example: http_body type: string x-enum-varnames: - HTTP_BODY - HTTP_HEADER - HTTP_STATUS_CODE - LOCAL_VARIABLE SyntheticsGlobalVariableParserType: description: Type of parser for a Synthetic global variable from a synthetics test. enum: - raw - json_path - regex - x_path example: raw type: string x-enum-varnames: - RAW - JSON_PATH - REGEX - X_PATH SyntheticsGlobalVariableRequest: description: Details of the global variable to create. properties: attributes: $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes" description: description: Description of the global variable. example: "Example description" type: string id: description: Unique identifier of the global variable. readOnly: true type: string is_fido: description: Determines if the global variable is a FIDO variable. type: boolean is_totp: description: Determines if the global variable is a TOTP/MFA variable. type: boolean name: description: Name of the global variable. Unique across Synthetic global variables. example: "MY_VARIABLE" type: string parse_test_options: $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions" parse_test_public_id: description: A Synthetic test ID to use as a test to generate the variable value. example: "abc-def-123" type: string tags: description: Tags of the global variable. example: ["team:front", "test:workflow-1"] items: description: Tag name. type: string type: array value: $ref: "#/components/schemas/SyntheticsGlobalVariableValue" required: - description - name - tags type: object SyntheticsGlobalVariableTOTPParameters: description: "Parameters for the TOTP/MFA variable" properties: digits: description: Number of digits for the OTP code. example: 6 format: int32 maximum: 10 minimum: 4 type: integer refresh_interval: description: Interval for which to refresh the token (in seconds). example: 30 format: int32 maximum: 999 minimum: 0 type: integer type: object SyntheticsGlobalVariableValue: description: Value of the global variable. example: secure: true value: value properties: options: $ref: "#/components/schemas/SyntheticsGlobalVariableOptions" secure: description: Determines if the value of the variable is hidden. type: boolean value: description: |- Value of the global variable. When reading a global variable, the value will not be present if the variable is hidden with the `secure` property. example: "example-value" type: string type: object SyntheticsListGlobalVariablesResponse: description: Object containing an array of Synthetic global variables. properties: variables: description: Array of Synthetic global variables. items: $ref: "#/components/schemas/SyntheticsGlobalVariable" type: array type: object SyntheticsListTestsResponse: description: Object containing an array of Synthetic tests configuration. properties: tests: description: Array of Synthetic tests configuration. items: $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps" type: array type: object SyntheticsLocalVariableParsingOptionsType: description: Property of the Synthetic Test Response to extract into a local variable. enum: - grpc_message - grpc_metadata - http_body - http_header - http_status_code example: http_body type: string x-enum-varnames: - GRPC_MESSAGE - GRPC_METADATA - HTTP_BODY - HTTP_HEADER - HTTP_STATUS_CODE SyntheticsLocation: description: |- Synthetic location that can be used when creating or editing a test. properties: id: description: Unique identifier of the location. type: string name: description: Name of the location. type: string type: object SyntheticsLocations: description: List of Synthetic locations. properties: locations: description: List of Synthetic locations. items: $ref: "#/components/schemas/SyntheticsLocation" type: array type: object SyntheticsMCPProtocolVersion: description: The MCP protocol version used by the step. See https://modelcontextprotocol.io/specification. enum: - "2025-06-18" example: "2025-06-18" type: string x-enum-varnames: - VERSION_2025_06_18 SyntheticsMCPServerCapability: description: A capability advertised by an MCP server. enum: - completions - experimental - logging - prompts - resources - tools type: string x-enum-varnames: - COMPLETIONS - EXPERIMENTAL - LOGGING - PROMPTS - RESOURCES - TOOLS SyntheticsMobileStep: description: The steps used in a Synthetic mobile test. properties: allowFailure: description: A boolean set to allow this step to fail. type: boolean hasNewStepElement: description: A boolean set to determine if the step has a new step element. type: boolean isCritical: description: A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails. type: boolean name: description: The name of the step. example: "" maxLength: 1500 type: string noScreenshot: description: A boolean set to not take a screenshot for the step. type: boolean params: $ref: "#/components/schemas/SyntheticsMobileStepParams" publicId: description: The public ID of the step. example: "pub-lic-id0" type: string timeout: description: The time before declaring a step failed. format: int64 type: integer type: $ref: "#/components/schemas/SyntheticsMobileStepType" required: - name - params - type type: object SyntheticsMobileStepParams: description: The parameters of a mobile step. properties: check: $ref: "#/components/schemas/SyntheticsCheckType" delay: description: Number of milliseconds to wait between inputs in a `typeText` step type. format: int64 maximum: 5000 minimum: 0 type: integer direction: $ref: "#/components/schemas/SyntheticsMobileStepParamsDirection" element: $ref: "#/components/schemas/SyntheticsMobileStepParamsElement" enabled: description: Boolean to change the state of the wifi for a `toggleWiFi` step type. type: boolean maxScrolls: description: Maximum number of scrolls to do for a `scrollToElement` step type. format: int64 type: integer positions: $ref: "#/components/schemas/SyntheticsMobileStepParamsPositions" subtestPublicId: description: Public ID of the test to be played as part of a `playSubTest` step type. type: string value: $ref: "#/components/schemas/SyntheticsMobileStepParamsValue" variable: $ref: "#/components/schemas/SyntheticsMobileStepParamsVariable" withEnter: description: Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type. type: boolean x: description: Amount to scroll by on the `x` axis for a `scroll` step type. format: double type: number y: description: Amount to scroll by on the `y` axis for a `scroll` step type. format: double type: number type: object SyntheticsMobileStepParamsDirection: description: The direction of the scroll for a `scrollToElement` step type. enum: - up - down - left - right type: string x-enum-varnames: - UP - DOWN - LEFT - RIGHT SyntheticsMobileStepParamsElement: description: Information about the element used for a step. properties: context: description: Context of the element. type: string contextType: $ref: "#/components/schemas/SyntheticsMobileStepParamsElementContextType" elementDescription: description: Description of the element. type: string multiLocator: description: Multi-locator to find the element. type: object relativePosition: $ref: "#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition" textContent: description: Text content of the element. type: string userLocator: $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocator" viewName: description: Name of the view of the element. type: string type: object SyntheticsMobileStepParamsElementContextType: description: Type of the context that the element is in. enum: - native - web type: string x-enum-varnames: - NATIVE - WEB SyntheticsMobileStepParamsElementRelativePosition: description: Position of the action relative to the element. properties: x: description: The `relativePosition` on the `x` axis for the element. format: double type: number y: description: The `relativePosition` on the `y` axis for the element. format: double type: number type: object SyntheticsMobileStepParamsElementUserLocator: description: User locator to find the element. properties: failTestOnCannotLocate: description: Whether if the test should fail if the element cannot be found. type: boolean values: description: Values of the user locator. items: $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems" type: array type: object SyntheticsMobileStepParamsElementUserLocatorValuesItems: description: A single user locator object. properties: type: $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType" value: description: Value of a user locator. type: string type: object SyntheticsMobileStepParamsElementUserLocatorValuesItemsType: description: Type of a user locator. enum: - accessibility-id - id - ios-predicate-string - ios-class-chain - xpath type: string x-enum-varnames: - ACCESSIBILITY_ID - ID - IOS_PREDICATE_STRING - IOS_CLASS_CHAIN - XPATH SyntheticsMobileStepParamsPositions: description: List of positions for the `flick` step type. The maximum is 10 flicks per step items: $ref: "#/components/schemas/SyntheticsMobileStepParamsPositionsItems" type: array SyntheticsMobileStepParamsPositionsItems: description: A description of a single position for a `flick` step type. properties: x: description: The `x` position for the flick. format: double type: number y: description: The `y` position for the flick. format: double type: number type: object SyntheticsMobileStepParamsValue: description: Values used in the step for in multiple step types. oneOf: - $ref: "#/components/schemas/SyntheticsMobileStepParamsValueString" - $ref: "#/components/schemas/SyntheticsMobileStepParamsValueNumber" SyntheticsMobileStepParamsValueNumber: description: Value used in the step for in multiple step types. format: int64 type: integer SyntheticsMobileStepParamsValueString: description: Value used in the step for in multiple step types. type: string SyntheticsMobileStepParamsVariable: description: Variable object for `extractVariable` step type. properties: example: description: An example for the variable. example: "" type: string name: description: The variable name. example: "VAR_NAME" type: string required: - name - example type: object SyntheticsMobileStepType: description: Step type used in your mobile Synthetic test. enum: - assertElementContent - assertScreenContains - assertScreenLacks - doubleTap - extractVariable - flick - openDeeplink - playSubTest - pressBack - restartApplication - rotate - scroll - scrollToElement - tap - toggleWiFi - typeText - wait example: assertElementContent type: string x-enum-varnames: - ASSERTELEMENTCONTENT - ASSERTSCREENCONTAINS - ASSERTSCREENLACKS - DOUBLETAP - EXTRACTVARIABLE - FLICK - OPENDEEPLINK - PLAYSUBTEST - PRESSBACK - RESTARTAPPLICATION - ROTATE - SCROLL - SCROLLTOELEMENT - TAP - TOGGLEWIFI - TYPETEXT - WAIT SyntheticsMobileTest: description: Object containing details about a Synthetic mobile test. properties: config: $ref: "#/components/schemas/SyntheticsMobileTestConfig" device_ids: description: Array with the different device IDs used to run the test. items: $ref: "#/components/schemas/SyntheticsDeviceID" type: array message: description: Notification message associated with the test. example: Notification message type: string monitor_id: description: The associated monitor ID. example: 12345678 format: int64 readOnly: true type: integer name: description: Name of the test. example: "Example test name" type: string options: $ref: "#/components/schemas/SyntheticsMobileTestOptions" public_id: description: The public ID of the test. example: 123-abc-456 readOnly: true type: string status: $ref: "#/components/schemas/SyntheticsTestPauseStatus" steps: description: Array of steps for the test. items: $ref: "#/components/schemas/SyntheticsMobileStep" type: array tags: description: Array of tags attached to the test. example: ["env:production"] items: description: A tag attached to the test. type: string type: array type: $ref: "#/components/schemas/SyntheticsMobileTestType" required: - config - name - options - type - message type: object SyntheticsMobileTestConfig: description: Configuration object for a Synthetic mobile test. properties: initialApplicationArguments: $ref: "#/components/schemas/SyntheticsMobileTestInitialApplicationArguments" variables: description: Array of variables used for the test steps. items: $ref: "#/components/schemas/SyntheticsConfigVariable" type: array type: object SyntheticsMobileTestInitialApplicationArguments: additionalProperties: description: "A single application argument." type: string description: Initial application arguments for a mobile test. type: object SyntheticsMobileTestOptions: description: Object describing the extra options for a Synthetic test. properties: allowApplicationCrash: description: A boolean to set if an application crash would mark the test as failed. type: boolean bindings: description: Array of bindings used for the mobile test. items: $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBinding" type: array ci: $ref: "#/components/schemas/SyntheticsTestCiOptions" defaultStepTimeout: description: The default timeout for steps in the test (in seconds). format: int32 maximum: 300 minimum: 1 type: integer device_ids: description: For mobile test, array with the different device IDs used to run the test. example: - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16 items: $ref: "#/components/schemas/SyntheticsDeviceID" type: array disableAutoAcceptAlert: description: A boolean to disable auto accepting alerts. type: boolean min_failure_duration: description: Minimum amount of time in failure required to trigger an alert. format: int64 maximum: 7200 minimum: 0 type: integer mobileApplication: $ref: "#/components/schemas/SyntheticsMobileTestsMobileApplication" monitor_name: description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. type: string monitor_options: $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions" monitor_priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int32 maximum: 5 minimum: 1 type: integer noScreenshot: description: A boolean set to not take a screenshot for the step. type: boolean restricted_roles: $ref: "#/components/schemas/SyntheticsRestrictedRoles" retry: $ref: "#/components/schemas/SyntheticsTestOptionsRetry" scheduling: $ref: "#/components/schemas/SyntheticsTestOptionsScheduling" tick_every: description: The frequency at which to run the Synthetic test (in seconds). example: 300 format: int64 maximum: 604800 minimum: 300 type: integer verbosity: description: The level of verbosity for the mobile test. This field can not be set by a user. format: int32 maximum: 5 minimum: 0 type: integer required: - device_ids - tick_every - mobileApplication type: object SyntheticsMobileTestType: default: "mobile" description: Type of the Synthetic test, `mobile`. enum: - mobile example: "mobile" type: string x-enum-varnames: - MOBILE SyntheticsMobileTestsMobileApplication: description: Mobile application for mobile synthetics test. properties: applicationId: description: Application ID of the mobile application. example: "00000000-0000-0000-0000-aaaaaaaaaaaa" maxLength: 1500 type: string referenceId: description: Reference ID of the mobile application. example: "00000000-0000-0000-0000-aaaaaaaaaaab" maxLength: 1500 type: string referenceType: $ref: "#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType" required: - applicationId - referenceId - referenceType type: object SyntheticsMobileTestsMobileApplicationReferenceType: description: Reference type for the mobile application for a mobile synthetics test. enum: - latest - version example: latest type: string x-enum-varnames: - LATEST - VERSION SyntheticsParsingOptions: description: Parsing options for variables to extract. example: {} properties: field: description: When type is `http_header` or `grpc_metadata`, name of the header or metadatum to extract. example: "content-type" type: string name: description: Name of the variable to extract. type: string parser: $ref: "#/components/schemas/SyntheticsVariableParser" secure: description: Determines whether or not the extracted value will be obfuscated. type: boolean type: $ref: "#/components/schemas/SyntheticsLocalVariableParsingOptionsType" type: object SyntheticsPatchTestBody: description: Wrapper around an array of [JSON Patch](https://jsonpatch.com) operations to perform on the test properties: data: description: Array of [JSON Patch](https://jsonpatch.com) operations to perform on the test example: [{"op": "replace", "path": "/name", "value": "New test name"}, {"op": "remove", "path": "/config/assertions/0"}] items: $ref: "#/components/schemas/SyntheticsPatchTestOperation" type: array type: object SyntheticsPatchTestOperation: description: A single [JSON Patch](https://jsonpatch.com) operation to perform on the test properties: op: $ref: "#/components/schemas/SyntheticsPatchTestOperationName" path: description: The path to the value to modify example: /name type: string value: description: A value to use in a [JSON Patch](https://jsonpatch.com) operation example: "New Test Name" type: object SyntheticsPatchTestOperationName: description: The operation to perform enum: - add - remove - replace - move - copy - test example: replace type: string x-enum-varnames: - ADD - REMOVE - REPLACE - MOVE - COPY - TEST SyntheticsPlayingTab: description: Navigate between different tabs for your browser test. enum: - -1 - 0 - 1 - 2 - 3 format: int64 type: integer x-enum-varnames: - MAIN_TAB - NEW_TAB - TAB_1 - TAB_2 - TAB_3 SyntheticsPrivateLocation: description: Object containing information about the private location to create. properties: description: description: Description of the private location. example: Description of private location type: string id: description: Unique identifier of the private location. readOnly: true type: string metadata: $ref: "#/components/schemas/SyntheticsPrivateLocationMetadata" name: description: Name of the private location. example: New private location type: string secrets: $ref: "#/components/schemas/SyntheticsPrivateLocationSecrets" tags: description: Array of tags attached to the private location. example: ["team:front"] items: description: A tag attached to the private location. example: "team:front" type: string type: array required: - name - description - tags type: object SyntheticsPrivateLocationCreationResponse: description: Object that contains the new private location, the public key for result encryption, and the configuration skeleton. properties: config: description: Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. type: object private_location: $ref: "#/components/schemas/SyntheticsPrivateLocation" result_encryption: $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponseResultEncryption" type: object SyntheticsPrivateLocationCreationResponseResultEncryption: description: Public key for the result encryption. properties: id: description: Fingerprint for the encryption key. type: string key: description: Public key for result encryption. type: string type: object SyntheticsPrivateLocationMetadata: description: Object containing metadata about the private location. properties: restricted_roles: $ref: "#/components/schemas/SyntheticsRestrictedRoles" type: object SyntheticsPrivateLocationSecrets: description: Secrets for the private location. Only present in the response when creating the private location. properties: authentication: $ref: "#/components/schemas/SyntheticsPrivateLocationSecretsAuthentication" config_decryption: $ref: "#/components/schemas/SyntheticsPrivateLocationSecretsConfigDecryption" readOnly: true type: object SyntheticsPrivateLocationSecretsAuthentication: description: Authentication part of the secrets. properties: id: description: Access key for the private location. readOnly: true type: string key: description: Secret access key for the private location. readOnly: true type: string type: object SyntheticsPrivateLocationSecretsConfigDecryption: description: Private key for the private location. properties: key: description: Private key for the private location. readOnly: true type: string type: object SyntheticsRestrictedRoles: deprecated: true description: A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions. example: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] items: description: UUID for a role. example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: string type: array SyntheticsSSLCertificate: description: Object describing the SSL certificate used for a Synthetic test. properties: cipher: description: Cipher used for the connection. type: string exponent: description: Exponent associated to the certificate. format: double type: number extKeyUsage: description: Array of extensions and details used for the certificate. items: description: An extension or detail used for the certificate. type: string type: array fingerprint: description: MD5 digest of the DER-encoded Certificate information. type: string fingerprint256: description: SHA-1 digest of the DER-encoded Certificate information. type: string issuer: $ref: "#/components/schemas/SyntheticsSSLCertificateIssuer" modulus: description: Modulus associated to the SSL certificate private key. type: string protocol: description: TLS protocol used for the test. type: string serialNumber: description: Serial Number assigned by Symantec to the SSL certificate. type: string subject: $ref: "#/components/schemas/SyntheticsSSLCertificateSubject" validFrom: description: Date from which the SSL certificate is valid. format: date-time type: string validTo: description: Date until which the SSL certificate is valid. format: date-time type: string type: object SyntheticsSSLCertificateIssuer: description: Object describing the issuer of a SSL certificate. properties: C: description: Country Name that issued the certificate. type: string CN: description: Common Name that issued certificate. type: string L: description: Locality that issued the certificate. type: string O: description: Organization that issued the certificate. type: string OU: description: Organizational Unit that issued the certificate. type: string ST: description: State Or Province Name that issued the certificate. type: string type: object SyntheticsSSLCertificateSubject: description: Object describing the SSL certificate used for the test. properties: C: description: Country Name associated with the certificate. type: string CN: description: Common Name that associated with the certificate. type: string L: description: Locality associated with the certificate. type: string O: description: Organization associated with the certificate. type: string OU: description: Organizational Unit associated with the certificate. type: string ST: description: State Or Province Name associated with the certificate. type: string altName: description: Subject Alternative Name associated with the certificate. type: string type: object SyntheticsStep: description: The steps used in a Synthetic browser test. properties: allowFailure: description: A boolean set to allow this step to fail. type: boolean alwaysExecute: description: A boolean set to always execute this step even if the previous step failed or was skipped. type: boolean exitIfSucceed: description: A boolean set to exit the test if the step succeeds. type: boolean isCritical: description: A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails. type: boolean name: description: The name of the step. type: string noScreenshot: description: A boolean set to skip taking a screenshot for the step. type: boolean params: description: The parameters of the step. type: object public_id: description: The public ID of the step. type: string timeout: description: The time before declaring a step failed. format: int64 type: integer type: $ref: "#/components/schemas/SyntheticsStepType" type: object SyntheticsStepDetail: description: Object describing a step for a Synthetic test. properties: allowFailure: description: Whether or not the step was allowed to fail. type: boolean browserErrors: description: Array of errors collected for a browser test. items: $ref: "#/components/schemas/SyntheticsBrowserError" type: array checkType: $ref: "#/components/schemas/SyntheticsCheckType" description: description: Description of the test. type: string duration: description: Total duration in millisecond of the test. format: double type: number error: description: Error returned by the test. type: string failure: $ref: "#/components/schemas/SyntheticsBrowserTestResultFailure" playingTab: $ref: "#/components/schemas/SyntheticsPlayingTab" screenshotBucketKey: description: Whether or not screenshots where collected by the test. type: boolean skipped: description: Whether or not to skip this step. type: boolean snapshotBucketKey: description: Whether or not snapshots where collected by the test. type: boolean stepId: description: The step ID. format: int64 type: integer subTestStepDetails: description: |- If this step includes a sub-test. [Subtests documentation](https://docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests). items: $ref: "#/components/schemas/SyntheticsStepDetail" type: array timeToInteractive: description: Time before starting the step. format: double type: number type: $ref: "#/components/schemas/SyntheticsStepType" url: description: URL to perform the step against. type: string value: description: Value for the step. vitalsMetrics: description: Array of Core Web Vitals metrics for the step. items: $ref: "#/components/schemas/SyntheticsCoreWebVitals" type: array warnings: description: Warning collected that didn't failed the step. items: $ref: "#/components/schemas/SyntheticsStepDetailWarning" type: array type: object SyntheticsStepDetailWarning: description: Object collecting warnings for a given step. properties: message: description: Message for the warning. example: "" type: string type: $ref: "#/components/schemas/SyntheticsWarningType" required: - message - type type: object SyntheticsStepType: description: Step type used in your Synthetic test. enum: - assertCurrentUrl - assertElementAttribute - assertElementContent - assertElementPresent - assertEmail - assertFileDownload - assertFromJavascript - assertPageContains - assertPageLacks - assertRequests - click - drag - drop - extractFromJavascript - extractFromEmailBody - extractVariable - goToEmailLink - goToUrl - goToUrlAndMeasureTti - hover - playSubTest - pressKey - refresh - runApiTest - scroll - selectOption - typeText - uploadFiles - wait example: assertElementContent type: string x-enum-varnames: - ASSERT_CURRENT_URL - ASSERT_ELEMENT_ATTRIBUTE - ASSERT_ELEMENT_CONTENT - ASSERT_ELEMENT_PRESENT - ASSERT_EMAIL - ASSERT_FILE_DOWNLOAD - ASSERT_FROM_JAVASCRIPT - ASSERT_PAGE_CONTAINS - ASSERT_PAGE_LACKS - ASSERT_REQUESTS - CLICK - DRAG - DROP - EXTRACT_FROM_JAVASCRIPT - EXTRACT_FROM_EMAIL_BODY - EXTRACT_VARIABLE - GO_TO_EMAIL_LINK - GO_TO_URL - GO_TO_URL_AND_MEASURE_TTI - HOVER - PLAY_SUB_TEST - PRESS_KEY - REFRESH - RUN_API_TEST - SCROLL - SELECT_OPTION - TYPE_TEXT - UPLOAD_FILES - WAIT SyntheticsTestCallType: description: |- The type of call to perform. Used by gRPC steps (`healthcheck`, `unary`) and MCP steps (`init`, `tool_list`, `tool_call`). Valid values depend on the parent step's `subtype`. enum: - healthcheck - unary - init - tool_list - tool_call example: unary type: string x-enum-varnames: - HEALTHCHECK - UNARY - INIT - TOOL_LIST - TOOL_CALL SyntheticsTestCiOptions: description: CI/CD options for a Synthetic test. properties: executionRule: $ref: "#/components/schemas/SyntheticsTestExecutionRule" required: - executionRule type: object SyntheticsTestConfig: description: Configuration object for a Synthetic test. properties: assertions: default: [] description: Array of assertions used for the test. Required for single API tests. example: [] items: $ref: "#/components/schemas/SyntheticsAssertion" type: array configVariables: description: Array of variables used for the test. items: $ref: "#/components/schemas/SyntheticsConfigVariable" type: array request: $ref: "#/components/schemas/SyntheticsTestRequest" variables: description: Browser tests only - array of variables used for the test steps. items: $ref: "#/components/schemas/SyntheticsBrowserVariable" type: array type: object SyntheticsTestDetails: description: Object containing details about your Synthetic test. properties: config: $ref: "#/components/schemas/SyntheticsTestConfig" creator: $ref: "#/components/schemas/Creator" locations: description: Array of locations used to run the test. example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array message: description: Notification message associated with the test. type: string monitor_id: description: The associated monitor ID. format: int64 readOnly: true type: integer name: description: Name of the test. type: string options: $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The test public ID. readOnly: true type: string status: $ref: "#/components/schemas/SyntheticsTestPauseStatus" steps: description: The steps of the test if they exist. items: $ref: "#/components/schemas/SyntheticsStep" type: array subtype: $ref: "#/components/schemas/SyntheticsTestDetailsSubType" tags: description: Array of tags attached to the test. items: description: A tag attached to the test. type: string type: array type: $ref: "#/components/schemas/SyntheticsTestDetailsType" type: object SyntheticsTestDetailsSubType: description: |- The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`. enum: - http - ssl - tcp - dns - multi - icmp - udp - websocket - grpc example: http type: string x-enum-varnames: - HTTP - SSL - TCP - DNS - MULTI - ICMP - UDP - WEBSOCKET - GRPC SyntheticsTestDetailsType: description: Type of the Synthetic test. enum: - api - browser - mobile - network type: string x-enum-varnames: - API - BROWSER - MOBILE - NETWORK SyntheticsTestDetailsWithoutSteps: description: Object containing details about your Synthetic test, without test steps. properties: config: $ref: "#/components/schemas/SyntheticsTestConfig" creator: $ref: "#/components/schemas/Creator" locations: description: Array of locations used to run the test. example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array message: description: Notification message associated with the test. type: string monitor_id: description: The associated monitor ID. format: int64 readOnly: true type: integer name: description: Name of the test. type: string options: $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The test public ID. readOnly: true type: string status: $ref: "#/components/schemas/SyntheticsTestPauseStatus" subtype: $ref: "#/components/schemas/SyntheticsTestDetailsSubType" tags: description: Array of tags attached to the test. items: description: A tag attached to the test. type: string type: array type: $ref: "#/components/schemas/SyntheticsTestDetailsType" type: object SyntheticsTestExecutionRule: description: Execution rule for a Synthetic test. enum: - blocking - non_blocking - skipped example: blocking type: string x-enum-varnames: - BLOCKING - NON_BLOCKING - SKIPPED SyntheticsTestHeaders: additionalProperties: description: A single Header. type: string description: Headers to include when performing the test. type: object SyntheticsTestMetadata: additionalProperties: description: A single metadatum. type: string description: Metadata to include when performing the gRPC test. type: object SyntheticsTestMonitorStatus: description: |- The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data enum: - 0 - 1 - 2 format: int64 type: integer x-enum-varnames: - UNTRIGGERED - TRIGGERED - NO_DATA SyntheticsTestOptions: description: Object describing the extra options for a Synthetic test. properties: accept_self_signed: description: |- For SSL tests, whether or not the test should allow self signed certificates. type: boolean allow_insecure: description: Allows loading insecure content for an HTTP request in an API test. type: boolean blockedRequestPatterns: description: Array of URL patterns to block. items: description: A URL pattern to block during the Synthetic test. type: string type: array checkCertificateRevocation: description: |- For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP. type: boolean ci: $ref: "#/components/schemas/SyntheticsTestCiOptions" device_ids: description: For browser test, array with the different device IDs used to run the test. items: $ref: "#/components/schemas/SyntheticsDeviceID" type: array disableAiaIntermediateFetching: description: |- For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA. type: boolean disableCors: description: Whether or not to disable CORS mechanism. type: boolean disableCsp: description: Disable Content Security Policy for browser tests. type: boolean enableProfiling: description: Enable profiling for browser tests. type: boolean enableSecurityTesting: deprecated: true description: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used. type: boolean follow_redirects: description: For API HTTP test, whether or not the test should follow redirects. type: boolean httpVersion: $ref: "#/components/schemas/SyntheticsTestOptionsHTTPVersion" ignoreServerCertificateError: description: Ignore server certificate error for browser tests. type: boolean initialNavigationTimeout: description: Timeout before declaring the initial step as failed (in seconds) for browser tests. format: int64 type: integer min_failure_duration: description: Minimum amount of time in failure required to trigger an alert. format: int64 type: integer min_location_failed: description: |- Minimum number of locations in failure required to trigger an alert. format: int64 type: integer monitor_name: description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. type: string monitor_options: $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions" monitor_priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int32 maximum: 5 minimum: 1 type: integer noScreenshot: description: Prevents saving screenshots of the steps. type: boolean restricted_roles: $ref: "#/components/schemas/SyntheticsRestrictedRoles" retry: $ref: "#/components/schemas/SyntheticsTestOptionsRetry" rumSettings: $ref: "#/components/schemas/SyntheticsBrowserTestRumSettings" scheduling: $ref: "#/components/schemas/SyntheticsTestOptionsScheduling" tick_every: description: The frequency at which to run the Synthetic test (in seconds). format: int64 maximum: 604800 minimum: 30 type: integer type: object SyntheticsTestOptionsHTTPVersion: description: HTTP version to use for a Synthetic test. enum: - http1 - http2 - any type: string x-enum-varnames: - HTTP1 - HTTP2 - ANY SyntheticsTestOptionsMonitorOptions: description: |- Object containing the options for a Synthetic test as a monitor (for example, renotification). properties: escalation_message: description: Message to include in the escalation notification. type: string notification_preset_name: $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName" renotify_interval: description: |- Time interval before renotifying if the test is still failing (in minutes). format: int64 minimum: 0 type: integer renotify_occurrences: description: The number of times to renotify if the test is still failing. format: int64 type: integer type: object SyntheticsTestOptionsMonitorOptionsNotificationPresetName: description: The name of the preset for the notification for the monitor. enum: - show_all - hide_all - hide_query - hide_handles - hide_query_and_handles - show_only_snapshot - hide_handles_and_footer type: string x-enum-varnames: - SHOW_ALL - HIDE_ALL - HIDE_QUERY - HIDE_HANDLES - HIDE_QUERY_AND_HANDLES - SHOW_ONLY_SNAPSHOT - HIDE_HANDLES_AND_FOOTER SyntheticsTestOptionsRetry: description: Object describing the retry strategy to apply to a Synthetic test. properties: count: description: |- Number of times a test needs to be retried before marking a location as failed. Defaults to 0. format: int64 type: integer interval: description: |- Time interval between retries (in milliseconds). Defaults to 300ms. format: double type: number type: object SyntheticsTestOptionsScheduling: description: Object containing timeframes and timezone used for advanced scheduling. properties: timeframes: description: Array containing objects describing the scheduling pattern to apply to each day. example: [{"day": 1, "from": "07:00", "to": "16:00"}, {"day": 3, "from": "07:00", "to": "16:00"}] items: $ref: "#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe" type: array timezone: description: Timezone in which the timeframe is based. example: "America/New_York" type: string required: - timeframes - timezone type: object SyntheticsTestOptionsSchedulingTimeframe: description: Object describing a timeframe. properties: day: description: Number representing the day of the week. example: 1 format: int32 maximum: 7 minimum: 1 type: integer from: description: The hour of the day on which scheduling starts. example: "07:00" type: string to: description: The hour of the day on which scheduling ends. example: "16:00" type: string required: - day - from - to type: object SyntheticsTestPauseStatus: description: |- Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. enum: - live - paused example: live type: string x-enum-varnames: - LIVE - PAUSED SyntheticsTestProcessStatus: description: Status of a Synthetic test. enum: - not_scheduled - scheduled - finished - finished_with_error type: string x-enum-varnames: - NOT_SCHEDULED - SCHEDULED - FINISHED - FINISHED_WITH_ERROR SyntheticsTestRequest: description: Object describing the Synthetic test request. properties: allow_insecure: description: Allows loading insecure content for an HTTP request in a multistep test step. type: boolean basicAuth: $ref: "#/components/schemas/SyntheticsBasicAuth" body: description: Body to include in the test. type: string bodyType: $ref: "#/components/schemas/SyntheticsTestRequestBodyType" callType: $ref: "#/components/schemas/SyntheticsTestCallType" certificate: $ref: "#/components/schemas/SyntheticsTestRequestCertificate" certificateDomains: default: [] description: By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in `certificateDomains`. items: description: Domain to apply the client certificate. example: "" type: string type: array checkCertificateRevocation: description: Check for certificate revocation. type: boolean compressedJsonDescriptor: description: A protobuf JSON descriptor that needs to be gzipped first then base64 encoded. type: string compressedProtoFile: description: A protobuf file that needs to be gzipped first then base64 encoded. type: string disableAiaIntermediateFetching: description: |- Disable fetching intermediate certificates from AIA. type: boolean dnsServer: description: DNS server to use for DNS tests. type: string dnsServerPort: $ref: "#/components/schemas/SyntheticsTestRequestDNSServerPort" description: DNS server port to use for DNS tests. files: description: Files to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`. items: $ref: "#/components/schemas/SyntheticsTestRequestBodyFile" type: array follow_redirects: description: Specifies whether or not the request follows redirects. type: boolean form: additionalProperties: description: A single form entry. type: string description: Form to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`. type: object headers: $ref: "#/components/schemas/SyntheticsTestHeaders" host: description: Host name to perform the test with. type: string httpVersion: $ref: "#/components/schemas/SyntheticsTestOptionsHTTPVersion" isMessageBase64Encoded: description: Whether the message is base64 encoded. type: boolean mcpProtocolVersion: $ref: "#/components/schemas/SyntheticsMCPProtocolVersion" message: description: Message to send for UDP or WebSocket tests. type: string metadata: $ref: "#/components/schemas/SyntheticsTestMetadata" method: description: Either the HTTP method/verb to use or a gRPC method available on the service set in the `service` field. Required if `subtype` is `HTTP` or if `subtype` is `grpc` and `callType` is `unary`. type: string noSavingResponseBody: description: Determines whether or not to save the response body. type: boolean numberOfPackets: description: Number of pings to use per test. format: int32 maximum: 10 minimum: 0 type: integer persistCookies: description: Persist cookies across redirects. type: boolean port: $ref: "#/components/schemas/SyntheticsTestRequestPort" proxy: $ref: "#/components/schemas/SyntheticsTestRequestProxy" query: description: Query to use for the test. type: object servername: description: |- For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number. type: string service: description: The gRPC service on which you want to perform the gRPC call. example: Greeter type: string shouldTrackHops: description: Turns on a traceroute probe to discover all gateways along the path to the host destination. type: boolean timeout: description: Timeout in seconds for the test. format: double type: number toolArgs: additionalProperties: {} description: Arguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when `callType` is `tool_call`. type: object toolName: description: The name of the MCP tool to call. Required when `callType` is `tool_call`. example: search type: string url: description: URL to perform the test with. example: "https://example.com" type: string type: object SyntheticsTestRequestBodyFile: description: Object describing a file to be used as part of the request in the test. properties: bucketKey: description: Bucket key of the file. type: string content: description: Content of the file. maxLength: 3145728 type: string encoding: description: Encoding of the file content. The only supported value is `base64`, indicating the `content` field contains base64-encoded data. type: string name: description: Name of the file. maxLength: 1500 type: string originalFileName: description: Original name of the file. maxLength: 1500 type: string size: description: Size of the file. format: int64 maximum: 3145728 minimum: 1 type: integer type: description: Type of the file. maxLength: 1500 type: string type: object SyntheticsTestRequestBodyType: description: Type of the request body. enum: - text/plain - application/json - text/xml - text/html - application/x-www-form-urlencoded - graphql - application/octet-stream - multipart/form-data example: "text/plain" type: string x-enum-varnames: - TEXT_PLAIN - APPLICATION_JSON - TEXT_XML - TEXT_HTML - APPLICATION_X_WWW_FORM_URLENCODED - GRAPHQL - APPLICATION_OCTET_STREAM - MULTIPART_FORM_DATA SyntheticsTestRequestCertificate: description: Client certificate to use when performing the test request. properties: cert: $ref: "#/components/schemas/SyntheticsTestRequestCertificateItem" key: $ref: "#/components/schemas/SyntheticsTestRequestCertificateItem" type: object SyntheticsTestRequestCertificateItem: description: Define a request certificate. properties: content: description: Content of the certificate or key. type: string filename: description: File name for the certificate or key. type: string updatedAt: description: Date of update of the certificate or key, ISO format. type: string type: object SyntheticsTestRequestDNSServerPort: description: DNS server port to use for DNS tests. oneOf: - $ref: "#/components/schemas/SyntheticsTestRequestNumericalDNSServerPort" - $ref: "#/components/schemas/SyntheticsTestRequestVariableDNSServerPort" SyntheticsTestRequestNumericalDNSServerPort: description: Integer DNS server port number to use when performing the test. format: int64 type: integer SyntheticsTestRequestNumericalPort: description: Integer Port number to use when performing the test. format: int64 type: integer SyntheticsTestRequestPort: description: Port to use when performing the test. oneOf: - $ref: "#/components/schemas/SyntheticsTestRequestNumericalPort" - $ref: "#/components/schemas/SyntheticsTestRequestVariablePort" SyntheticsTestRequestProxy: description: The proxy to perform the test. properties: headers: $ref: "#/components/schemas/SyntheticsTestHeaders" url: description: URL of the proxy to perform the test. example: "https://example.com" type: string required: - url type: object SyntheticsTestRequestVariableDNSServerPort: description: String DNS server port number to use when performing the test. Supports templated variables. type: string SyntheticsTestRequestVariablePort: description: String Port number to use when performing the test. Supports templated variables. type: string SyntheticsTestRestrictionPolicyBinding: description: Objects describing the binding used for a mobile test. properties: principals: $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals" relation: $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation" type: object SyntheticsTestRestrictionPolicyBindingPrincipals: description: List of principals for a mobile test binding. items: description: A principal for a mobile test binding. maxLength: 1500 type: string type: array SyntheticsTestRestrictionPolicyBindingRelation: description: The type of relation for the binding. enum: - editor - viewer type: string x-enum-varnames: - EDITOR - VIEWER SyntheticsTestUptime: description: |- Object containing the uptime for a Synthetic test ID. properties: from_ts: description: Timestamp in seconds for the start of uptime. format: int64 type: integer overall: $ref: "#/components/schemas/SyntheticsUptime" public_id: description: A Synthetic test ID. example: "abc-def-123" type: string to_ts: description: Timestamp in seconds for the end of uptime. format: int64 type: integer type: object SyntheticsTiming: description: |- Object containing all metrics and their values collected for a Synthetic API test. See the [Synthetic Monitoring Metrics documentation](https://docs.datadoghq.com/synthetics/metrics/). properties: dns: description: The duration in millisecond of the DNS lookup. format: double type: number download: description: The time in millisecond to download the response. format: double type: number firstByte: description: The time in millisecond to first byte. format: double type: number handshake: description: The duration in millisecond of the TLS handshake. format: double type: number redirect: description: The time in millisecond spent during redirections. format: double type: number ssl: description: The duration in millisecond of the TLS handshake. format: double type: number tcp: description: Time in millisecond to establish the TCP connection. format: double type: number total: description: The overall time in millisecond the request took to be processed. format: double type: number wait: description: Time spent in millisecond waiting for a response. format: double type: number type: object SyntheticsTriggerBody: description: Object describing the Synthetic tests to trigger. properties: tests: description: List of Synthetic tests. items: $ref: "#/components/schemas/SyntheticsTriggerTest" type: array required: - tests type: object SyntheticsTriggerCITestLocation: description: Synthetic location. properties: id: description: Unique identifier of the location. format: int64 type: integer name: description: Name of the location. type: string type: object SyntheticsTriggerCITestRunResult: description: Information about a single test run. properties: device: $ref: "#/components/schemas/SyntheticsDeviceID" location: description: The location ID of the test run. format: int64 type: integer public_id: description: The public ID of the Synthetic test. type: string result_id: description: ID of the result. type: string type: object SyntheticsTriggerCITestsResponse: description: Object containing information about the tests triggered. properties: batch_id: description: The public ID of the batch triggered. nullable: true type: string locations: description: List of Synthetic locations. items: $ref: "#/components/schemas/SyntheticsTriggerCITestLocation" type: array results: description: Information about the tests runs. items: $ref: "#/components/schemas/SyntheticsTriggerCITestRunResult" type: array triggered_check_ids: description: The public IDs of the Synthetic test triggered. items: description: The public ID of the Synthetic test. type: string type: array type: object SyntheticsTriggerTest: description: Test configuration for Synthetics properties: metadata: $ref: "#/components/schemas/SyntheticsCIBatchMetadata" public_id: description: The public ID of the Synthetic test to trigger. example: aaa-aaa-aaa type: string required: - public_id type: object SyntheticsUpdateTestPauseStatusPayload: description: Object to start or pause an existing Synthetic test. properties: new_status: $ref: "#/components/schemas/SyntheticsTestPauseStatus" type: object SyntheticsUptime: description: |- Object containing the uptime information. properties: errors: description: An array of error objects returned while querying the history data for the service level objective. items: $ref: "#/components/schemas/SLOHistoryResponseErrorWithType" nullable: true type: array group: description: The location name example: "name" type: string history: description: |- The state transition history for the monitor, represented as an array of pairs. Each pair is an array where the first element is the transition timestamp in Unix epoch format (integer) and the second element is the state (integer). For the state, an integer value of `0` indicates uptime, `1` indicates downtime, and `2` indicates no data. example: [[1579212382, 0]] items: description: |- An array of transitions example: [1579212382, 0] items: description: A timeseries data point which is a tuple of (timestamp, value). format: double type: number maxItems: 2 minItems: 2 type: array type: array span_precision: description: The number of decimal places to which the SLI value is accurate for the given from-to timestamps. example: 2.0 format: double type: number uptime: description: The overall uptime. example: 99.99 format: double type: number type: object SyntheticsVariableParser: description: Details of the parser to use for the global variable. example: type: regex value: .* properties: type: $ref: "#/components/schemas/SyntheticsGlobalVariableParserType" value: description: Regex or JSON path used for the parser. Not used with type `raw`. type: string required: - type type: object SyntheticsWarningType: description: User locator used. enum: - user_locator example: user_locator type: string x-enum-varnames: - USER_LOCATOR TableWidgetCellDisplayMode: description: Define a display mode for the table cell. enum: - number - bar - trend example: number type: string x-enum-varnames: - NUMBER - BAR - TREND TableWidgetDefinition: description: The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string has_search_bar: $ref: "#/components/schemas/TableWidgetHasSearchBar" requests: description: Widget definition. example: ["q/apm_query/log_query": "{}"] items: $ref: "#/components/schemas/TableWidgetRequest" type: array time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/TableWidgetDefinitionType" required: - type - requests type: object TableWidgetDefinitionType: default: query_table description: Type of the table widget. enum: - query_table example: query_table type: string x-enum-varnames: - QUERY_TABLE TableWidgetHasSearchBar: description: Controls the display of the search bar. enum: - always - never - auto example: auto type: string x-enum-varnames: - ALWAYS - NEVER - AUTO TableWidgetRequest: description: Updated table widget. properties: aggregator: $ref: "#/components/schemas/WidgetAggregator" alias: description: The column name (defaults to the metric name). type: string apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. apm_stats_query: $ref: "#/components/schemas/ApmStatsQueryDefinition" cell_display_mode: description: A list of display modes for each table cell. items: $ref: "#/components/schemas/TableWidgetCellDisplayMode" type: array conditional_formats: description: List of conditional formats. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array limit: description: For metric queries, the number of lines to show in the table. Only one request should have this property. format: int64 type: integer log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. order: $ref: "#/components/schemas/WidgetSort" process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Query definition. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: $ref: "#/components/schemas/WidgetSortBy" text_formats: description: List of text formats for columns produced by tags. items: $ref: "#/components/schemas/TableWidgetTextFormat" type: array type: object TableWidgetTextFormat: description: Text format rules for a tag-based column within a table widget. example: [{"match": {"type": "is", "value": "fruit"}, "replace": {"type": "all", "with": "vegetable"}}, {"match": {"type": "is", "value": "cake"}, "palette": "white_on_green"}] items: $ref: "#/components/schemas/TableWidgetTextFormatRule" minItems: 1 type: array TableWidgetTextFormatMatch: description: Match rule for the table widget text format. example: {"type": "is", "value": "fruit"} properties: type: $ref: "#/components/schemas/TableWidgetTextFormatMatchType" value: description: Table Widget Match String. example: "Match Value" type: string required: - type - value type: object TableWidgetTextFormatMatchType: description: Match or compare option. enum: - is - is_not - contains - does_not_contain - starts_with - ends_with example: is type: string x-enum-varnames: - IS - IS_NOT - CONTAINS - DOES_NOT_CONTAIN - STARTS_WITH - ENDS_WITH TableWidgetTextFormatPalette: default: white_on_green description: Color-on-color palette to highlight replaced text. enum: - white_on_red - white_on_yellow - white_on_green - black_on_light_red - black_on_light_yellow - black_on_light_green - red_on_white - yellow_on_white - green_on_white - custom_bg - custom_text type: string x-enum-varnames: - WHITE_ON_RED - WHITE_ON_YELLOW - WHITE_ON_GREEN - BLACK_ON_LIGHT_RED - BLACK_ON_LIGHT_YELLOW - BLACK_ON_LIGHT_GREEN - RED_ON_WHITE - YELLOW_ON_WHITE - GREEN_ON_WHITE - CUSTOM_BG - CUSTOM_TEXT TableWidgetTextFormatReplace: description: Replace rule for the table widget text format. example: {"type": "all", "with": "vegetable"} oneOf: - $ref: "#/components/schemas/TableWidgetTextFormatReplaceAll" - $ref: "#/components/schemas/TableWidgetTextFormatReplaceSubstring" TableWidgetTextFormatReplaceAll: description: Match All definition. example: {"type": "all", "with": "vegetable"} properties: type: $ref: "#/components/schemas/TableWidgetTextFormatReplaceAllType" with: description: Replace All type. example: all type: string required: - type - with type: object TableWidgetTextFormatReplaceAllType: description: Table widget text format replace all type. enum: - all example: all type: string x-enum-varnames: - ALL TableWidgetTextFormatReplaceSubstring: description: Match Sub-string definition. example: {"substring": "fruit", "type": "substring", "with": "vegetable"} properties: substring: description: Text that will be replaced. example: "string to replace" type: string type: $ref: "#/components/schemas/TableWidgetTextFormatReplaceSubstringType" with: description: Text that will replace original sub-string. example: "replacement" type: string required: - type - with - substring type: object TableWidgetTextFormatReplaceSubstringType: description: Table widget text format replace sub-string type. enum: - substring example: substring type: string x-enum-varnames: - SUBSTRING TableWidgetTextFormatRule: description: Text format rules. example: {"match": {"type": "is", "value": "apple"}, "replace": {"type": "all", "with": "vegetable"}} properties: custom_bg_color: description: Hex representation of the custom background color. Used with custom background palette option. example: "#632ca6" type: string custom_fg_color: description: Hex representation of the custom text color. Used with custom text palette option. example: "#632ca6" type: string match: $ref: "#/components/schemas/TableWidgetTextFormatMatch" palette: $ref: "#/components/schemas/TableWidgetTextFormatPalette" replace: $ref: "#/components/schemas/TableWidgetTextFormatReplace" required: - match type: object TagToHosts: description: In this object, the key is the tag, and the value is a list of host names that are reporting that tag. properties: tags: additionalProperties: description: A list of host names which contain this tag items: description: A given tag in a list. example: "test.metric.host" type: string type: array description: A mapping of tags to host names type: object type: object TargetFormatType: description: |- If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. enum: - auto - string - integer - double type: string x-enum-varnames: - AUTO - STRING - INTEGER - DOUBLE TimeseriesBackground: description: Set a timeseries on the widget background. properties: type: $ref: "#/components/schemas/TimeseriesBackgroundType" yaxis: $ref: "#/components/schemas/WidgetAxis" required: - type type: object TimeseriesBackgroundType: default: area description: Timeseries is made using an area or bars. enum: - bars - area example: bars type: string x-enum-varnames: - BARS - AREA TimeseriesRequestStyle: description: Define request widget style for timeseries widgets. properties: has_value_labels: description: If true, the value is displayed as a label relative to the data point. type: boolean line_type: $ref: "#/components/schemas/WidgetLineType" line_width: $ref: "#/components/schemas/WidgetLineWidth" order_by: $ref: "#/components/schemas/WidgetStyleOrderBy" palette: description: Color palette to apply to the widget. type: string type: object TimeseriesWidgetDefinition: description: The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string events: deprecated: true description: List of widget events. Deprecated - Use `overlay` request type instead. items: $ref: "#/components/schemas/WidgetEvent" type: array legend_columns: description: Columns displayed in the legend. items: $ref: "#/components/schemas/TimeseriesWidgetLegendColumn" type: array legend_layout: $ref: "#/components/schemas/TimeseriesWidgetLegendLayout" legend_size: $ref: "#/components/schemas/WidgetLegendSize" markers: description: List of markers. items: $ref: "#/components/schemas/WidgetMarker" type: array requests: description: List of timeseries widget requests. example: ["q/apm_query/log_query": "{}"] items: $ref: "#/components/schemas/TimeseriesWidgetRequest" minItems: 1 type: array right_yaxis: $ref: "#/components/schemas/WidgetAxis" show_legend: description: (screenboard only) Show the legend for this widget. type: boolean time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/TimeseriesWidgetDefinitionType" yaxis: $ref: "#/components/schemas/WidgetAxis" required: - type - requests type: object TimeseriesWidgetDefinitionType: default: timeseries description: Type of the timeseries widget. enum: - timeseries example: timeseries type: string x-enum-varnames: - TIMESERIES TimeseriesWidgetExpressionAlias: description: Define an expression alias. properties: alias_name: description: Expression alias. type: string expression: description: Expression name. example: "" type: string required: - expression type: object TimeseriesWidgetLegendColumn: description: Legend column. enum: - value - avg - sum - min - max type: string x-enum-varnames: - VALUE - AVG - SUM - MIN - MAX TimeseriesWidgetLegendLayout: description: Layout of the legend. enum: - auto - horizontal - vertical type: string x-enum-varnames: - AUTO - HORIZONTAL - VERTICAL TimeseriesWidgetRequest: description: Updated timeseries widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. display_type: $ref: "#/components/schemas/WidgetDisplayType" event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. metadata: description: Used to define expression aliases. items: $ref: "#/components/schemas/TimeseriesWidgetExpressionAlias" type: array network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. on_right_yaxis: description: Whether or not to display a second y-axis on the right. type: boolean process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: $ref: "#/components/schemas/TimeseriesRequestStyle" type: object ToplistWidgetDefinition: description: The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string requests: description: List of top list widget requests. example: ["q": "system.load.1"] items: $ref: "#/components/schemas/ToplistWidgetRequest" type: array style: $ref: "#/components/schemas/ToplistWidgetStyle" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/ToplistWidgetDefinitionType" required: - type - requests type: object ToplistWidgetDefinitionType: default: toplist description: Type of the top list widget. enum: - toplist example: toplist type: string x-enum-varnames: - TOPLIST ToplistWidgetDisplay: description: Top list widget display options. oneOf: - $ref: "#/components/schemas/ToplistWidgetStacked" - $ref: "#/components/schemas/ToplistWidgetFlat" ToplistWidgetFlat: description: Top list widget flat display. properties: type: $ref: "#/components/schemas/ToplistWidgetFlatType" required: - type type: object ToplistWidgetFlatType: default: flat description: Top list widget flat display type. enum: - flat example: flat type: string x-enum-varnames: - FLAT ToplistWidgetLegend: description: Top list widget stacked legend behavior. enum: - automatic - inline - none example: automatic type: string x-enum-varnames: - AUTOMATIC - INLINE - NONE ToplistWidgetRequest: description: Updated top list widget. properties: apm_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. conditional_formats: description: List of conditional formats. example: [{"comparator": ">=", "palette": "blue", "value": 1.0}] items: $ref: "#/components/schemas/WidgetConditionalFormat" minItems: 1 type: array event_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array log_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true description: Widget query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: $ref: "#/components/schemas/WidgetSortBy" style: $ref: "#/components/schemas/WidgetRequestStyle" type: object ToplistWidgetScaling: description: Top list widget scaling definition. enum: - absolute - relative type: string x-enum-varnames: - ABSOLUTE - RELATIVE ToplistWidgetStacked: description: Top list widget stacked display options. properties: legend: $ref: "#/components/schemas/ToplistWidgetLegend" type: $ref: "#/components/schemas/ToplistWidgetStackedType" required: - type type: object ToplistWidgetStackedType: default: stacked description: Top list widget stacked display type. enum: - stacked example: stacked type: string x-enum-varnames: - STACKED ToplistWidgetStyle: description: Style customization for a top list widget. properties: display: $ref: "#/components/schemas/ToplistWidgetDisplay" palette: description: Color palette to apply to the widget. type: string scaling: $ref: "#/components/schemas/ToplistWidgetScaling" type: object TopologyMapWidgetDefinition: description: This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string requests: description: One or more Topology requests. items: $ref: "#/components/schemas/TopologyRequest" minItems: 1 type: array title: description: Title of your widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/TopologyMapWidgetDefinitionType" required: - type - requests type: object TopologyMapWidgetDefinitionType: default: topology_map description: Type of the topology map widget. enum: - topology_map example: topology_map type: string x-enum-varnames: - TOPOLOGY_MAP TopologyQuery: description: Query to service-based topology data sources like the service map or data streams. properties: data_source: $ref: "#/components/schemas/TopologyQueryDataSource" filters: description: Your environment and primary tag (or * if enabled for your account). example: ["env:prod", "az:us-east"] items: description: Environment or primary tag, generally in a key:value format type: string minItems: 1 type: array service: description: Name of the service example: myService type: string type: object TopologyQueryDataSource: description: Name of the data source enum: - data_streams - service_map type: string x-enum-varnames: - DATA_STREAMS - SERVICE_MAP TopologyRequest: description: Request that will return nodes and edges to be used by topology map. properties: query: $ref: "#/components/schemas/TopologyQuery" request_type: $ref: "#/components/schemas/TopologyRequestType" type: object TopologyRequestType: description: Widget request type. enum: - topology type: string x-enum-varnames: - TOPOLOGY TreeMapColorBy: default: "user" deprecated: true description: (deprecated) The attribute formerly used to determine color in the widget. enum: - user example: "user" type: string x-enum-varnames: - USER TreeMapGroupBy: deprecated: true description: (deprecated) The attribute formerly used to group elements in the widget. enum: - user - family - process example: "user" type: string x-enum-varnames: - USER - FAMILY - PROCESS TreeMapSizeBy: deprecated: true description: (deprecated) The attribute formerly used to determine size in the widget. enum: - pct_cpu - pct_mem example: "pct_cpu" type: string x-enum-varnames: - PCT_CPU - PCT_MEM TreeMapWidgetDefinition: description: The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. properties: color_by: $ref: "#/components/schemas/TreeMapColorBy" custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array description: description: The description of the widget. type: string group_by: $ref: "#/components/schemas/TreeMapGroupBy" requests: description: List of treemap widget requests. example: [{"aggregator": "sum", "data_source": "metrics", "name": "query1", "query": "sum:system.mem.total{*} by {service}"}] items: $ref: "#/components/schemas/TreeMapWidgetRequest" maxItems: 1 minItems: 1 type: array size_by: $ref: "#/components/schemas/TreeMapSizeBy" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string type: $ref: "#/components/schemas/TreeMapWidgetDefinitionType" required: - type - requests type: object TreeMapWidgetDefinitionType: default: treemap description: Type of the treemap widget. enum: - treemap example: treemap type: string x-enum-varnames: - TREEMAP TreeMapWidgetRequest: description: An updated treemap widget. properties: formulas: description: List of formulas that operate on queries. items: $ref: "#/components/schemas/WidgetFormula" type: array q: deprecated: true description: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" sort: $ref: "#/components/schemas/WidgetSortBy" style: $ref: "#/components/schemas/WidgetRequestStyle" type: object UsageAnalyzedLogsHour: description: The number of analyzed logs for each hour for a given organization. properties: analyzed_logs: description: Contains the number of analyzed logs. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageAnalyzedLogsResponse: description: A response containing the number of analyzed logs for each hour for a given organization. properties: usage: description: Get hourly usage for analyzed logs. items: $ref: "#/components/schemas/UsageAnalyzedLogsHour" type: array type: object UsageAttributionAggregates: description: An array of available aggregates. items: $ref: "#/components/schemas/UsageAttributionAggregatesBody" type: array UsageAttributionAggregatesBody: description: The object containing the aggregates. properties: agg_type: description: The aggregate type. example: "sum" type: string field: description: The field. example: "custom_timeseries_usage" type: string value: description: The value for a given field. format: double type: number type: object UsageAttributionTagNames: additionalProperties: description: |- A list of values that are associated with each tag key. - An empty list means the resource use wasn't tagged with the respective tag. - Multiple values means the respective tag was applied multiple times on the resource. - An `` value means the resource was tagged with the respective tag but did not have a value. items: description: A given tag in a list. example: "datadog-integrations-lab" type: string type: array description: |- Tag keys and values. A `null` value here means that the requested tag breakdown cannot be applied because it does not match the [tags configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started). In this scenario the API returns the total usage, not broken down by tags. nullable: true type: object UsageAuditLogsHour: description: Audit logs usage for a given organization for a given hour. properties: hour: description: The hour for the usage. format: date-time type: string lines_indexed: description: The total number of audit logs lines indexed during a given hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageAuditLogsResponse: description: Response containing the audit logs usage for each hour for a given organization. properties: usage: description: Get hourly usage for audit logs. items: $ref: "#/components/schemas/UsageAuditLogsHour" type: array type: object UsageBillableSummaryBody: description: Response with properties for each aggregated usage type. properties: account_billable_usage: description: The total account usage. format: int64 type: integer account_committed_usage: description: The total account committed usage. format: int64 type: integer account_on_demand_usage: description: The total account on-demand usage. format: int64 type: integer elapsed_usage_hours: description: Elapsed usage hours for some billable product. format: int64 type: integer first_billable_usage_hour: description: The first billable hour for the org. format: date-time type: string last_billable_usage_hour: description: The last billable hour for the org. format: date-time type: string org_billable_usage: description: The number of units used within the billable timeframe. format: int64 type: integer percentage_in_account: description: The percentage of account usage the org represents. format: double type: number usage_unit: description: Units pertaining to the usage. type: string type: object UsageBillableSummaryHour: description: Response with monthly summary of data billed by Datadog. properties: account_name: description: The account name. type: string account_public_id: description: The account public ID. type: string billing_plan: deprecated: true description: The billing plan (metadata). (Deprecated from June 2026) type: string end_date: description: Shows the last date of usage. format: date-time type: string num_orgs: description: The number of organizations. format: int64 type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string ratio_in_month: description: Shows usage aggregation for a billing period. format: double type: number region: description: The region of the organization. type: string start_date: description: Shows the first date of usage. format: date-time type: string usage: $ref: "#/components/schemas/UsageBillableSummaryKeys" type: object UsageBillableSummaryKeys: description: Response with aggregated usage types. properties: apm_fargate_average: $ref: "#/components/schemas/UsageBillableSummaryBody" apm_fargate_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" apm_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" apm_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" apm_profiler_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" apm_profiler_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" apm_trace_search_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" application_security_fargate_average: $ref: "#/components/schemas/UsageBillableSummaryBody" application_security_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" application_security_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" ci_pipeline_indexed_spans_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" ci_pipeline_maximum: $ref: "#/components/schemas/UsageBillableSummaryBody" ci_pipeline_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" ci_test_indexed_spans_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" ci_testing_maximum: $ref: "#/components/schemas/UsageBillableSummaryBody" ci_testing_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cloud_cost_management_average: $ref: "#/components/schemas/UsageBillableSummaryBody" cloud_cost_management_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cspm_container_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cspm_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cspm_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" custom_event_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cws_container_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cws_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" cws_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_normalized_queries_average: $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_normalized_queries_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_apm_and_profiler_average: $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_apm_and_profiler_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_average: $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_profiler_average: $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_profiler_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" incident_management_maximum: $ref: "#/components/schemas/UsageBillableSummaryBody" incident_management_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" infra_and_apm_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" infra_and_apm_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" infra_container_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" infra_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" infra_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" ingested_spans_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" ingested_timeseries_average: $ref: "#/components/schemas/UsageBillableSummaryBody" ingested_timeseries_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" iot_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" iot_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" lambda_function_average: $ref: "#/components/schemas/UsageBillableSummaryBody" lambda_function_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_forwarding_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_15day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_180day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_1day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_30day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_360day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_3day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_45day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_60day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_7day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_90day_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_custom_retention_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" logs_ingested_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" network_device_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" network_device_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" npm_flow_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" npm_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" npm_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" observability_pipeline_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" online_archive_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" prof_container_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" prof_host_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" prof_host_top99p: $ref: "#/components/schemas/UsageBillableSummaryBody" rum_lite_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" rum_replay_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" rum_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" rum_units_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" sensitive_data_scanner_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_apm_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_infra_average: $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_infra_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_invocation_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" siem_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" standard_timeseries_average: $ref: "#/components/schemas/UsageBillableSummaryBody" synthetics_api_tests_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" synthetics_app_testing_maximum: $ref: "#/components/schemas/UsageBillableSummaryBody" synthetics_browser_checks_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" timeseries_average: $ref: "#/components/schemas/UsageBillableSummaryBody" timeseries_sum: $ref: "#/components/schemas/UsageBillableSummaryBody" type: object UsageBillableSummaryResponse: description: Response with monthly summary of data billed by Datadog. properties: usage: description: An array of objects regarding usage of billable summary. items: $ref: "#/components/schemas/UsageBillableSummaryHour" type: array type: object UsageCIVisibilityHour: description: CI visibility usage in a given hour. properties: ci_pipeline_indexed_spans: description: The number of spans for pipelines in the queried hour. format: int64 nullable: true type: integer ci_test_indexed_spans: description: The number of spans for tests in the queried hour. format: int64 nullable: true type: integer ci_visibility_itr_committers: description: Shows the total count of all active Git committers for Intelligent Test Runner in the current month. A committer is active if they commit at least 3 times in a given month. format: int64 nullable: true type: integer ci_visibility_pipeline_committers: description: Shows the total count of all active Git committers for Pipelines in the current month. A committer is active if they commit at least 3 times in a given month. format: int64 nullable: true type: integer ci_visibility_test_committers: description: The total count of all active Git committers for tests in the current month. A committer is active if they commit at least 3 times in a given month. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageCIVisibilityResponse: description: CI visibility usage response properties: usage: description: Response containing CI visibility usage. items: $ref: "#/components/schemas/UsageCIVisibilityHour" type: array type: object UsageCWSHour: description: Cloud Workload Security usage for a given organization for a given hour. properties: cws_container_count: description: The total number of Cloud Workload Security container hours from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer cws_host_count: description: The total number of Cloud Workload Security host hours from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageCWSResponse: description: Response containing the Cloud Workload Security usage for each hour for a given organization. properties: usage: description: Get hourly usage for Cloud Workload Security. items: $ref: "#/components/schemas/UsageCWSHour" type: array type: object UsageCloudSecurityPostureManagementHour: description: Cloud Security Management Pro usage for a given organization for a given hour. properties: aas_host_count: description: The number of Cloud Security Management Pro Azure app services hosts during a given hour. format: double nullable: true type: number aws_host_count: description: The number of Cloud Security Management Pro AWS hosts during a given hour. format: double nullable: true type: number azure_host_count: description: The number of Cloud Security Management Pro Azure hosts during a given hour. format: double nullable: true type: number compliance_host_count: description: The number of Cloud Security Management Pro hosts during a given hour. format: double nullable: true type: number container_count: description: The total number of Cloud Security Management Pro containers during a given hour. format: double nullable: true type: number gcp_host_count: description: The number of Cloud Security Management Pro GCP hosts during a given hour. format: double nullable: true type: number host_count: description: The total number of Cloud Security Management Pro hosts during a given hour. format: double nullable: true type: number hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageCloudSecurityPostureManagementResponse: description: The response containing the Cloud Security Management Pro usage for each hour for a given organization. properties: usage: description: Get hourly usage for Cloud Security Management Pro. items: $ref: "#/components/schemas/UsageCloudSecurityPostureManagementHour" type: array type: object UsageCustomReportsAttributes: description: The response containing attributes for custom reports. properties: computed_on: description: The date the specified custom report was computed. type: string end_date: description: The ending date of custom report. type: string size: description: size format: int64 type: integer start_date: description: The starting date of custom report. type: string tags: description: A list of tags to apply to custom reports. items: description: A given tag in a list. example: "env" type: string type: array type: object UsageCustomReportsData: description: The response containing the date and type for custom reports. properties: attributes: $ref: "#/components/schemas/UsageCustomReportsAttributes" id: description: The date for specified custom reports. type: string type: $ref: "#/components/schemas/UsageReportsType" type: object UsageCustomReportsMeta: description: The object containing document metadata. properties: page: $ref: "#/components/schemas/UsageCustomReportsPage" type: object UsageCustomReportsPage: description: The object containing page total count. properties: total_count: description: Total page count. format: int64 type: integer type: object UsageCustomReportsResponse: description: Response containing available custom reports. properties: data: description: An array of available custom reports. items: $ref: "#/components/schemas/UsageCustomReportsData" type: array meta: $ref: "#/components/schemas/UsageCustomReportsMeta" type: object UsageDBMHour: description: Database Monitoring usage for a given organization for a given hour. properties: dbm_host_count: description: The total number of Database Monitoring host hours from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer dbm_queries_count: description: The total number of normalized Database Monitoring queries from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageDBMResponse: description: Response containing the Database Monitoring usage for each hour for a given organization. properties: usage: description: Get hourly usage for Database Monitoring items: $ref: "#/components/schemas/UsageDBMHour" type: array type: object UsageFargateHour: description: Number of Fargate tasks run and hourly usage. properties: apm_fargate_count: description: The high-water mark of APM ECS Fargate tasks during the given hour. format: int64 nullable: true type: integer appsec_fargate_count: description: The Application Security Monitoring ECS Fargate tasks during the given hour. format: int64 nullable: true type: integer avg_profiled_fargate_tasks: description: The average profiled task count for Fargate Profiling. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string tasks_count: description: The number of Fargate tasks run. format: int64 nullable: true type: integer type: object UsageFargateResponse: description: Response containing the number of Fargate tasks run and hourly usage. properties: usage: description: Array with the number of hourly Fargate tasks recorded for a given organization. items: $ref: "#/components/schemas/UsageFargateHour" type: array type: object UsageHostHour: description: Number of hosts/containers recorded for each hour for a given organization. properties: agent_host_count: description: |- Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. format: int64 nullable: true type: integer alibaba_host_count: description: |- Contains the total number of hosts that reported through Alibaba integration (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer apm_azure_app_service_host_count: description: Contains the total number of Azure App Services hosts using APM. format: int64 nullable: true type: integer apm_host_count: description: |- Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). format: int64 nullable: true type: integer aws_host_count: description: |- Contains the total number of hosts that reported through the AWS integration (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer azure_host_count: description: |- Contains the total number of hosts that reported through Azure integration (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer container_count: description: Shows the total number of containers reported by the Docker integration during the hour. format: int64 nullable: true type: integer gcp_host_count: description: |- Contains the total number of hosts that reported through the Google Cloud integration (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer heroku_host_count: description: Contains the total number of Heroku dynos reported by the Datadog Agent. format: int64 nullable: true type: integer host_count: description: |- Contains the total number of billable infrastructure hosts reporting during a given hour. This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time nullable: true type: string infra_azure_app_service: description: |- Contains the total number of hosts that reported through the Azure App Services integration (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer opentelemetry_apm_host_count: description: Contains the total number of hosts using APM reported by Datadog exporter for the OpenTelemetry Collector. format: int64 nullable: true type: integer opentelemetry_host_count: description: Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string vsphere_host_count: description: |- Contains the total number of hosts that reported through vSphere integration (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer type: object UsageHostsResponse: description: Host usage response. properties: usage: description: An array of objects related to host usage. items: $ref: "#/components/schemas/UsageHostHour" type: array type: object UsageIncidentManagementHour: description: Incident management usage for a given organization for a given hour. properties: hour: description: The hour for the usage. format: date-time type: string monthly_active_users: description: Contains the total number monthly active users from the start of the given hour's month until the given hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageIncidentManagementResponse: description: Response containing the incident management usage for each hour for a given organization. properties: usage: description: Get hourly usage for incident management. items: $ref: "#/components/schemas/UsageIncidentManagementHour" type: array type: object UsageIndexedSpansHour: description: The hours of indexed spans usage. properties: hour: description: The hour for the usage. format: date-time type: string indexed_events_count: description: Contains the number of spans indexed. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageIndexedSpansResponse: description: A response containing indexed spans usage. properties: usage: description: Array with the number of hourly traces indexed for a given organization. items: $ref: "#/components/schemas/UsageIndexedSpansHour" type: array type: object UsageIngestedSpansHour: description: Ingested spans usage for a given organization for a given hour. properties: hour: description: The hour for the usage. format: date-time type: string ingested_events_bytes: description: Contains the total number of bytes ingested for APM spans during a given hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageIngestedSpansResponse: description: Response containing the ingested spans usage for each hour for a given organization. properties: usage: description: Get hourly usage for ingested spans. items: $ref: "#/components/schemas/UsageIngestedSpansHour" type: array type: object UsageIoTHour: description: IoT usage for a given organization for a given hour. properties: hour: description: The hour for the usage. format: date-time type: string iot_device_count: description: The total number of IoT devices during a given hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageIoTResponse: description: Response containing the IoT usage for each hour for a given organization. properties: usage: description: Get hourly usage for IoT. items: $ref: "#/components/schemas/UsageIoTHour" type: array type: object UsageLambdaHour: description: |- Number of Lambda functions and sum of the invocations of all Lambda functions for each hour for a given organization. properties: func_count: description: Contains the number of different functions for each region and AWS account. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string invocations_sum: description: Contains the sum of invocations of all functions. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageLambdaResponse: description: |- Response containing the number of Lambda functions and sum of the invocations of all Lambda functions for each hour for a given organization. properties: usage: description: Get hourly usage for Lambda. items: $ref: "#/components/schemas/UsageLambdaHour" type: array type: object UsageLogsByIndexHour: description: Number of indexed logs for each hour and index for a given organization. properties: event_count: description: The total number of indexed logs for the queried hour. format: int64 type: integer hour: description: The hour for the usage. format: date-time type: string index_id: description: The index ID for this usage. type: string index_name: description: The user specified name for this index ID. type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string retention: description: The retention period (in days) for this index ID. format: int64 type: integer type: object UsageLogsByIndexResponse: description: Response containing the number of indexed logs for each hour and index for a given organization. properties: usage: description: An array of objects regarding hourly usage of logs by index response. items: $ref: "#/components/schemas/UsageLogsByIndexHour" type: array type: object UsageLogsByRetentionHour: description: The number of indexed logs for each hour for a given organization broken down by retention period. properties: indexed_events_count: description: Total logs indexed with this retention period during a given hour. format: int64 nullable: true type: integer live_indexed_events_count: description: Live logs indexed with this retention period during a given hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string rehydrated_indexed_events_count: description: Rehydrated logs indexed with this retention period during a given hour. format: int64 nullable: true type: integer retention: description: The retention period in days or "custom" for all custom retention usage. nullable: true type: string type: object UsageLogsByRetentionResponse: description: Response containing the indexed logs usage broken down by retention period for an organization during a given hour. properties: usage: description: Get hourly usage for indexed logs by retention period. items: $ref: "#/components/schemas/UsageLogsByRetentionHour" type: array type: object UsageLogsHour: description: Hour usage for logs. properties: billable_ingested_bytes: description: Contains the number of billable log bytes ingested. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string indexed_events_count: description: Contains the number of log events indexed. format: int64 nullable: true type: integer ingested_events_bytes: description: Contains the number of log bytes ingested. format: int64 nullable: true type: integer logs_forwarding_events_bytes: description: Contains the number of logs forwarded bytes (data available as of April 1st 2023) format: int64 nullable: true type: integer logs_live_indexed_count: description: Contains the number of live log events indexed (data available as of December 1, 2020). format: int64 nullable: true type: integer logs_live_ingested_bytes: description: Contains the number of live log bytes ingested (data available as of December 1, 2020). format: int64 nullable: true type: integer logs_rehydrated_indexed_count: description: Contains the number of rehydrated log events indexed (data available as of December 1, 2020). format: int64 nullable: true type: integer logs_rehydrated_ingested_bytes: description: Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageLogsResponse: description: Response containing the number of logs for each hour. properties: usage: description: An array of objects regarding hourly usage of logs. items: $ref: "#/components/schemas/UsageLogsHour" type: array type: object UsageMetricCategory: description: Contains the metric category. enum: - standard - custom type: string x-enum-varnames: - STANDARD - CUSTOM UsageNetworkFlowsHour: description: Number of netflow events indexed for each hour for a given organization. properties: hour: description: The hour for the usage. format: date-time type: string indexed_events_count: description: Contains the number of netflow events indexed. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageNetworkFlowsResponse: description: Response containing the number of netflow events indexed for each hour for a given organization. properties: usage: description: Get hourly usage for Network Flows. items: $ref: "#/components/schemas/UsageNetworkFlowsHour" type: array type: object UsageNetworkHostsHour: description: Number of active NPM hosts for each hour for a given organization. properties: host_count: description: Contains the number of active NPM hosts. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageNetworkHostsResponse: description: Response containing the number of active NPM hosts for each hour for a given organization. properties: usage: description: Get hourly usage for NPM hosts. items: $ref: "#/components/schemas/UsageNetworkHostsHour" type: array type: object UsageOnlineArchiveHour: description: Online Archive usage in a given hour. properties: hour: description: The hour for the usage. format: date-time type: string online_archive_events_count: description: Total count of online archived events within the hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageOnlineArchiveResponse: description: Online Archive usage response. properties: usage: description: Response containing Online Archive usage. items: $ref: "#/components/schemas/UsageOnlineArchiveHour" type: array type: object UsageProfilingHour: description: The number of profiled hosts for each hour for a given organization. properties: aas_count: description: Contains the total number of profiled Azure app services reporting during a given hour. format: int64 nullable: true type: integer avg_container_agent_count: description: Get average number of container agents for that hour. format: int64 nullable: true type: integer host_count: description: Contains the total number of profiled hosts reporting during a given hour. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageProfilingResponse: description: Response containing the number of profiled hosts for each hour for a given organization. properties: usage: description: Get hourly usage for profiled hosts. items: $ref: "#/components/schemas/UsageProfilingHour" type: array type: object UsageReportsType: default: reports description: The type of reports. enum: - reports example: "reports" type: string x-enum-varnames: - REPORTS UsageRumSessionsHour: description: Number of RUM sessions recorded for each hour for a given organization. properties: hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string replay_session_count: description: Contains the number of RUM Session Replay counts (data available beginning November 1, 2021). format: int64 type: integer session_count: description: Contains the number of browser RUM lite Sessions. format: int64 nullable: true type: integer session_count_android: description: Contains the number of mobile RUM sessions on Android (data available beginning December 1, 2020). format: int64 nullable: true type: integer session_count_flutter: description: Contains the number of mobile RUM sessions on Flutter (data available beginning March 1, 2023). format: int64 nullable: true type: integer session_count_ios: description: Contains the number of mobile RUM sessions on iOS (data available beginning December 1, 2020). format: int64 nullable: true type: integer session_count_reactnative: description: Contains the number of mobile RUM sessions on React Native (data available beginning May 1, 2022). format: int64 nullable: true type: integer type: object UsageRumSessionsResponse: description: Response containing the number of RUM sessions for each hour for a given organization. properties: usage: description: Get hourly usage for RUM sessions. items: $ref: "#/components/schemas/UsageRumSessionsHour" type: array type: object UsageRumUnitsHour: description: Number of RUM Units used for each hour for a given organization (data available as of November 1, 2021). properties: browser_rum_units: description: The number of browser RUM units. format: int64 nullable: true type: integer mobile_rum_units: description: The number of mobile RUM units. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string rum_units: description: Total RUM units across mobile and browser RUM. format: int64 nullable: true type: integer type: object UsageRumUnitsResponse: description: Response containing the number of RUM Units for each hour for a given organization. properties: usage: description: Get hourly usage for RUM Units. items: $ref: "#/components/schemas/UsageRumUnitsHour" type: array type: object UsageSDSHour: description: Sensitive Data Scanner usage for a given organization for a given hour. properties: apm_scanned_bytes: description: The total number of bytes scanned of APM usage across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer events_scanned_bytes: description: The total number of bytes scanned of Events usage across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string logs_scanned_bytes: description: The total number of bytes scanned of logs usage by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string rum_scanned_bytes: description: The total number of bytes scanned of RUM usage across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer total_scanned_bytes: description: The total number of bytes scanned across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer type: object UsageSDSResponse: description: Response containing the Sensitive Data Scanner usage for each hour for a given organization. properties: usage: description: Get hourly usage for Sensitive Data Scanner. items: $ref: "#/components/schemas/UsageSDSHour" type: array type: object UsageSNMPHour: description: The number of SNMP devices for each hour for a given organization. properties: hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string snmp_devices: description: Contains the number of SNMP devices. format: int64 nullable: true type: integer type: object UsageSNMPResponse: description: Response containing the number of SNMP devices for each hour for a given organization. properties: usage: description: Get hourly usage for SNMP devices. items: $ref: "#/components/schemas/UsageSNMPHour" type: array type: object UsageSort: default: start_date description: The field to sort by. enum: - computed_on - size - start_date - end_date type: string x-enum-varnames: - COMPUTED_ON - SIZE - START_DATE - END_DATE UsageSortDirection: default: desc description: The direction to sort by. enum: - desc - asc type: string x-enum-varnames: - DESC - ASC UsageSpecifiedCustomReportsAttributes: description: The response containing attributes for specified custom reports. properties: computed_on: description: The date the specified custom report was computed. type: string end_date: description: The ending date of specified custom report. type: string location: description: A downloadable file for the specified custom reporting file. example: "https://an-s3-or-gs-bucket.s3.amazonaws.com" type: string size: description: size format: int64 type: integer start_date: description: The starting date of specified custom report. type: string tags: description: A list of tags to apply to specified custom reports. items: description: A given tag in a list. example: "env" type: string type: array type: object UsageSpecifiedCustomReportsData: description: Response containing date and type for specified custom reports. properties: attributes: $ref: "#/components/schemas/UsageSpecifiedCustomReportsAttributes" id: description: The date for specified custom reports. type: string type: $ref: "#/components/schemas/UsageReportsType" type: object UsageSpecifiedCustomReportsMeta: description: The object containing document metadata. properties: page: $ref: "#/components/schemas/UsageSpecifiedCustomReportsPage" type: object UsageSpecifiedCustomReportsPage: description: The object containing page total count for specified ID. properties: total_count: description: Total page count. format: int64 type: integer type: object UsageSpecifiedCustomReportsResponse: description: Returns available specified custom reports. properties: data: $ref: "#/components/schemas/UsageSpecifiedCustomReportsData" meta: $ref: "#/components/schemas/UsageSpecifiedCustomReportsMeta" type: object UsageSummaryDate: description: |- Response with hourly report of all data billed by Datadog for all organizations. Newly added billing dimensions and usage types appear as untyped keys on the `additionalProperties` map instead of as typed fields. Call `GET /api/v2/usage/summary/available_fields` to enumerate every key returned at this response level—both typed fields and `additionalProperties` keys. properties: agent_host_top99p: description: Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. format: int64 type: integer ai_credits_agent_builder_ai_credits_sum: description: Shows the sum of all AI credits used by Agent Builder over all hours in the current date for all organizations. format: int64 type: integer ai_credits_bits_assistant_ai_credits_sum: description: Shows the sum of all AI credits used by Bits AI Assistant over all hours in the current date for all organizations. format: int64 type: integer ai_credits_bits_dev_ai_credits_sum: description: Shows the sum of all AI credits used by Bits AI Dev over all hours in the current date for all organizations. format: int64 type: integer ai_credits_bits_sre_ai_credits_sum: description: Shows the sum of all AI credits used by Bits AI SRE over all hours in the current date for all organizations. format: int64 type: integer ai_credits_sum: description: Shows the sum of all AI credits over all hours in the current date for all organizations. format: int64 type: integer apm_azure_app_service_host_top99p: description: Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. format: int64 type: integer apm_devsecops_host_top99p: description: Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org. format: int64 type: integer apm_enterprise_standalone_hosts_top99p: description: Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations. format: int64 type: integer apm_fargate_count_avg: description: Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer apm_host_top99p: description: Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. format: int64 type: integer apm_pro_standalone_hosts_top99p: description: Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations. format: int64 type: integer appsec_fargate_count_avg: description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer asm_serverless_sum: description: Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current date for all organizations. format: int64 type: integer audit_logs_lines_indexed_sum: deprecated: true description: Shows the sum of audit logs lines indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer audit_trail_enabled_hwm: description: Shows the number of organizations that had Audit Trail enabled in the current date. format: int64 type: integer audit_trail_event_forwarding_events_sum: description: Shows the sum of all Audit Trail event forwarding events over all hours in the current date for all organizations. format: int64 type: integer avg_profiled_fargate_tasks: description: The average total count for Fargate Container Profiler over all hours in the current date for all organizations. format: int64 type: integer aws_host_top99p: description: Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. format: int64 type: integer aws_lambda_func_count: description: Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. format: int64 type: integer aws_lambda_invocations_sum: description: Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. format: int64 type: integer azure_app_service_top99p: description: Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. format: int64 type: integer billable_ingested_bytes_sum: description: Shows the sum of all log bytes ingested over all hours in the current date for all organizations. format: int64 type: integer bits_ai_investigations_sum: description: Shows the sum of all Bits AI Investigations over all hours in the current date for all organizations. format: int64 type: integer browser_rum_lite_session_count_sum: deprecated: true description: Shows the sum of all browser lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_replay_session_count_sum: description: Shows the sum of all browser replay sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_units_sum: deprecated: true description: Shows the sum of all browser RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ccm_anthropic_spend_last: description: Shows the last value of Anthropic cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_aws_spend_last: description: Shows the last value of AWS cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_azure_spend_last: description: Shows the last value of Azure cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_confluent_spend_last: description: Shows the last value of Confluent cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_databricks_spend_last: description: Shows the last value of Databricks cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_elastic_spend_last: description: Shows the last value of Elastic cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_fastly_spend_last: description: Shows the last value of Fastly cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_gcp_spend_last: description: Shows the last value of GCP cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_github_spend_last: description: Shows the last value of GitHub cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_mongodb_spend_last: description: Shows the last value of MongoDB cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_oci_spend_last: description: Shows the last value of OCI cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_openai_spend_last: description: Shows the last value of OpenAI cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_snowflake_spend_last: description: Shows the last value of Snowflake cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ccm_spend_monitored_ent_last: description: Shows the last value of the amount of cloud spend monitored for Enterprise over all hours in the current date for all organizations. format: int64 type: integer ccm_spend_monitored_pro_last: description: Shows the last value of the amount of cloud spend monitored for Pro over all hours in the current date for all organizations. format: int64 type: integer ccm_twilio_spend_last: description: Shows the last value of Twilio cloud spend monitored over all hours in the current date for all organizations. format: int64 type: integer ci_pipeline_indexed_spans_sum: description: Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_test_indexed_spans_sum: description: Shows the sum of all CI test indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_itr_committers_hwm: description: Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_pipeline_committers_hwm: description: Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_test_committers_hwm: description: Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations. format: int64 type: integer cloud_cost_management_aws_host_count_avg: description: Host count average of Cloud Cost Management for AWS for the given date and given organization. format: int64 type: integer cloud_cost_management_azure_host_count_avg: description: Host count average of Cloud Cost Management for Azure for the given date and given organization. format: int64 type: integer cloud_cost_management_gcp_host_count_avg: description: Host count average of Cloud Cost Management for GCP for the given date and given organization. format: int64 type: integer cloud_cost_management_host_count_avg: description: Host count average of Cloud Cost Management for all cloud providers for the given date and given organization. format: int64 type: integer cloud_cost_management_oci_host_count_avg: description: Average host count for Cloud Cost Management on OCI for the given date and organization. format: int64 type: integer cloud_siem_events_sum: description: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org. format: int64 type: integer cloud_siem_indexed_logs_sum: description: Shows the sum of all Cloud SIEM Indexed Logs over all hours in the current date for the given org. format: int64 type: integer code_analysis_sa_committers_hwm: description: Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_analysis_sca_committers_hwm: description: Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_security_host_top99p: description: Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org. format: int64 type: integer container_avg: description: Shows the average of all distinct containers over all hours in the current date for all organizations. format: int64 type: integer container_excl_agent_avg: description: Shows the average of containers without the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer container_hwm: description: Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. format: int64 type: integer csm_container_enterprise_compliance_count_sum: description: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_cws_count_sum: description: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_total_count_sum: description: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aas_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aws_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_azure_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_compliance_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_cws_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_gcp_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_oci_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise OCI hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_total_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_hosts_agentless_scanners_sum: description: Shows the sum of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_hosts_agentless_scanners_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_oci_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro OCI hosts over all hours in the current date for the given org. format: int64 type: integer cspm_aas_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_aws_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_azure_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_container_avg: description: Shows the average number of Cloud Security Management Pro containers over all hours in the current date for all organizations. format: int64 type: integer cspm_container_hwm: description: Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for all organizations. format: int64 type: integer cspm_gcp_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_hosts_agentless_scanners_sum: description: Shows the sum of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_hosts_agentless_scanners_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for all organizations. format: int64 type: integer custom_ts_avg: description: Shows the average number of distinct custom metrics over all hours in the current date for all organizations. format: int64 type: integer cws_container_count_avg: description: Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations. format: int64 type: integer cws_fargate_task_avg: description: Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer cws_host_top99p: description: Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations. format: int64 type: integer data_jobs_monitoring_host_hr_sum: description: Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer data_stream_monitoring_host_count_sum: description: Shows the sum of all Data Streams Monitoring hosts over all hours in the current date for all organizations. format: int64 type: integer data_stream_monitoring_host_count_top99p: description: Shows the 99th percentile of all Data Streams Monitoring hosts over all hours in the current date for all organizations. format: int64 type: integer date: description: The date for the usage. format: date-time type: string dbm_host_top99p: description: Shows the 99th percentile of all Database Monitoring hosts over all hours in the current date for all organizations. format: int64 type: integer dbm_queries_count_avg: description: Shows the average of all normalized Database Monitoring queries over all hours in the current date for all organizations. format: int64 type: integer do_jobs_monitoring_orchestrators_job_hours_sum: description: Shows the sum of all orchestrator job hours over all hours in the current date for all organizations. format: int64 type: integer eph_infra_host_agent_sum: description: Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_alibaba_sum: description: Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_aws_sum: description: Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_azure_sum: description: Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_basic_infra_basic_agent_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier with the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer eph_infra_host_basic_infra_basic_vsphere_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier on vSphere over all hours in the current date for all organizations. format: int64 type: integer eph_infra_host_basic_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier over all hours in the current date for all organizations. format: int64 type: integer eph_infra_host_ent_sum: description: Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_gcp_sum: description: Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_heroku_sum: description: Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_aas_sum: description: Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_vsphere_sum: description: Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_apm_sum: description: Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_sum: description: Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_pro_sum: description: Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proplus_sum: description: Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proxmox_sum: description: Sum of all ephemeral infrastructure hosts for Proxmox over all hours in the current date for all organizations. format: int64 type: integer error_tracking_apm_error_events_sum: description: Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_error_events_sum: description: Shows the sum of all Error Tracking error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_events_sum: description: Shows the sum of all Error Tracking events over all hours in the current date for the given org. format: int64 type: integer error_tracking_rum_error_events_sum: description: Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_correlated_events_sum: description: Shows the sum of all Event Management correlated events over all hours in the current date for all organizations. format: int64 type: integer event_management_correlation_correlated_related_events_sum: description: Shows the sum of all Event Management correlated related events over all hours in the current date for all organizations. format: int64 type: integer event_management_correlation_sum: description: Shows the sum of all Event Management correlations over all hours in the current date for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_avg: description: The average number of Profiling Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_eks_avg: description: The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current date for all organizations. format: int64 type: integer fargate_tasks_count_avg: description: Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer fargate_tasks_count_hwm: description: Shows the average of all Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer feature_flags_config_requests_sum: description: Shows the sum of all Feature Flags Client-Side SDK config requests over all hours in the current date for all organizations. format: int64 type: integer flex_logs_compute_large_avg: description: Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_medium_avg: description: Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_small_avg: description: Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xlarge_avg: description: Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xsmall_avg: description: Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_avg: description: Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_index_avg: description: Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_retention_adjustment_avg: description: Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org. format: int64 type: integer flex_stored_logs_avg: description: Shows the average of all Flex Stored Logs over all hours in the current date for the given org. format: int64 type: integer forwarding_events_bytes_sum: description: Shows the sum of all log bytes forwarded over all hours in the current date for all organizations. format: int64 type: integer gcp_host_top99p: description: Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. format: int64 type: integer heroku_host_top99p: description: Shows the 99th percentile of all Heroku dynos over all hours in the current date for all organizations. format: int64 type: integer incident_management_monthly_active_users_hwm: description: Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations. format: int64 type: integer incident_management_seats_hwm: description: Shows the high-water mark of Incident Management seats over all hours on the current date for all organizations. format: int64 type: integer indexed_events_count_sum: description: Shows the sum of all log events indexed over all hours in the current date for all organizations. format: int64 type: integer indexed_points_sum: description: Shows the sum of all indexed custom metrics points over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_avg: description: Shows the average of all Infrastructure vCPU cores over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_avg: description: Shows the average of all default Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_basic_avg: description: Shows the average of all default basic Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_basic_sum: description: Shows the sum of all default basic Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_sum: description: Shows the sum of all default Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_aws_avg: description: Shows the average of all default Infrastructure host vCPU cores on AWS over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_aws_sum: description: Shows the sum of all default Infrastructure host vCPU cores on AWS over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_azure_avg: description: Shows the average of all default Infrastructure host vCPU cores on Azure over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_azure_sum: description: Shows the sum of all default Infrastructure host vCPU cores on Azure over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_gcp_avg: description: Shows the average of all default Infrastructure host vCPU cores on GCP over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_gcp_sum: description: Shows the sum of all default Infrastructure host vCPU cores on GCP over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_avg: description: Shows the average of all default Infrastructure host vCPU cores on Nutanix over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_basic_avg: description: Shows the average of all default basic Infrastructure host vCPU cores on Nutanix over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_basic_sum: description: Shows the sum of all default basic Infrastructure host vCPU cores on Nutanix over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_sum: description: Shows the sum of all default Infrastructure host vCPU cores on Nutanix over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_opentelemetry_avg: description: Shows the average of all default Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_opentelemetry_sum: description: Shows the sum of all default Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_agent_avg: description: Shows the average of all observed Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_agent_sum: description: Shows the sum of all observed Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_aws_avg: description: Shows the average of all observed Infrastructure host vCPU cores on AWS over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_aws_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on AWS over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_azure_avg: description: Shows the average of all observed Infrastructure host vCPU cores on Azure over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_azure_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on Azure over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_gcp_avg: description: Shows the average of all observed Infrastructure host vCPU cores on GCP over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_gcp_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on GCP over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_nutanix_avg: description: Shows the average of all observed Infrastructure host vCPU cores on Nutanix over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_nutanix_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on Nutanix over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_opentelemetry_avg: description: Shows the average of all observed Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_opentelemetry_sum: description: Shows the sum of all observed Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for all organizations. format: int64 type: integer infra_cpu_sum: description: Shows the sum of all Infrastructure vCPU cores over all hours in the current date for all organizations. format: int64 type: integer infra_edge_monitoring_devices_top99p: description: Shows the 99th percentile of all Edge Devices Monitoring devices over all hours in the current date for all organizations. format: int64 type: integer infra_host_basic_infra_basic_agent_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier with the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer infra_host_basic_infra_basic_vsphere_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier on vSphere over all hours in the current date for all organizations. format: int64 type: integer infra_host_basic_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier over all hours in the current date for all organizations. format: int64 type: integer infra_host_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. format: int64 type: integer infra_storage_mgmt_objects_count_avg: description: Shows the average number of storage management objects over all hours in the current date for all organizations. format: int64 type: integer ingest_points_sum: description: Shows the sum of all ingested custom metrics points over all hours in the current date for all organizations. format: int64 type: integer ingested_events_bytes_sum: description: Shows the sum of all log bytes ingested over all hours in the current date for all organizations. format: int64 type: integer iot_apm_host_sum: description: Shows the sum of all Application Performance Monitoring IoT hosts over all hours in the current date for all organizations. format: int64 type: integer iot_apm_host_top99p: description: Shows the 99th percentile of all Application Performance Monitoring IoT hosts over all hours in the current date for all organizations. format: int64 type: integer iot_device_sum: description: Shows the sum of all IoT devices over all hours in the current date for all organizations. format: int64 type: integer iot_device_top99p: description: Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. format: int64 type: integer llm_observability_15day_retention_spans_sum: description: Shows the sum of all LLM Observability 15-day retention spans over all hours in the current date for all organizations. format: int64 type: integer llm_observability_30day_retention_spans_sum: description: Shows the sum of all LLM Observability 30-day retention spans over all hours in the current date for all organizations. format: int64 type: integer llm_observability_60day_retention_spans_sum: description: Shows the sum of all LLM Observability 60-day retention spans over all hours in the current date for all organizations. format: int64 type: integer llm_observability_90day_retention_spans_sum: description: Shows the sum of all LLM Observability 90-day retention spans over all hours in the current date for all organizations. format: int64 type: integer llm_observability_min_spend_sum: description: Sum of all LLM observability minimum spend over all hours in the current date for all organizations. format: int64 type: integer llm_observability_sum: description: Sum of all LLM observability sessions over all hours in the current date for all organizations. format: int64 type: integer logs_archive_search_gb_scanned_sum: description: Shows the sum of all Logs Archive Search scanned data over all hours in the current date for all organizations. format: int64 type: integer metric_names_sum: description: Shows the sum of all custom metric names over all hours in the current date for all organizations. format: int64 type: integer mobile_rum_lite_session_count_sum: deprecated: true description: Shows the sum of all mobile lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_android_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_flutter_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_ios_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_reactnative_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_roku_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_sum: deprecated: true description: Shows the sum of all mobile RUM sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_units_sum: deprecated: true description: Shows the sum of all mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ndm_netflow_events_sum: description: Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org. format: int64 type: integer netflow_indexed_events_count_sum: deprecated: true description: Shows the sum of all Network flows indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer network_device_wireless_top99p: description: Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for all organizations. format: int64 type: integer network_path_sum: description: Shows the sum of all Network Path scheduled tests over all hours in the current date for all organizations. format: int64 type: integer npm_host_top99p: description: Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for all organizations. format: int64 type: integer observability_pipelines_bytes_processed_sum: description: Sum of all observability pipelines bytes processed over all hours in the current date for the given org. format: int64 type: integer oci_host_sum: description: Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer oci_host_top99p: description: Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer on_call_seat_hwm: description: Shows the high-water mark of On-Call seats over all hours in the current date for all organizations. format: int64 type: integer online_archive_events_count_sum: description: Sum of all online archived events over all hours in the current date for all organizations. format: int64 type: integer opentelemetry_apm_host_top99p: description: Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations. format: int64 type: integer opentelemetry_host_top99p: description: Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations. format: int64 type: integer orgs: description: Organizations associated with a user. items: $ref: "#/components/schemas/UsageSummaryDateOrg" type: array product_analytics_sum: description: Sum of all product analytics sessions over all hours in the current date for all organizations. format: int64 type: integer profiling_aas_count_top99p: description: Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations. format: int64 type: integer profiling_host_top99p: description: Shows the 99th percentile of all profiled hosts over all hours within the current date for all organizations. format: int64 type: integer proxmox_host_sum: description: Sum of all Proxmox hosts over all hours in the current date for all organizations. format: int64 type: integer proxmox_host_top99p: description: 99th percentile of all Proxmox hosts over all hours in the current date for all organizations. format: int64 type: integer published_app_hwm: description: Shows the high-water mark of all published applications over all hours in the current date for all organizations. format: int64 type: integer rum_browser_and_mobile_session_count: description: Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_browser_legacy_session_count_sum: description: Shows the sum of all browser RUM legacy sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_lite_session_count_sum: description: Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_replay_session_count_sum: description: Shows the sum of all browser RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_indexed_sessions_sum: description: Sum of all RUM indexed sessions over all hours in the current date for all organizations. format: int64 type: integer rum_ingested_sessions_sum: description: Sum of all RUM ingested sessions over all hours in the current date for all organizations. format: int64 type: integer rum_lite_session_count_sum: description: Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_android_sum: description: Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_flutter_sum: description: Shows the sum of all mobile RUM legacy Sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_ios_sum: description: Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_reactnative_sum: description: Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_roku_sum: description: Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_android_sum: description: Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_flutter_sum: description: Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_ios_sum: description: Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_kotlinmultiplatform_sum: description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for all organizations. format: int64 type: integer rum_mobile_lite_session_count_reactnative_sum: description: Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_roku_sum: description: Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_unity_sum: description: Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for all organizations. format: int64 type: integer rum_mobile_replay_session_count_android_sum: description: Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_ios_sum: description: Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_kotlinmultiplatform_sum: description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for all organizations. format: int64 type: integer rum_mobile_replay_session_count_reactnative_sum: description: Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org. format: int64 type: integer rum_replay_session_count_sum: description: Shows the sum of all RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_session_count_sum: deprecated: true description: Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_session_replay_add_on_sum: description: Sum of all RUM session replay add-on sessions over all hours in the current date for all organizations. format: int64 type: integer rum_total_session_count_sum: description: Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for all organizations. format: int64 type: integer rum_units_sum: deprecated: true description: Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer sca_fargate_count_avg: description: Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sca_fargate_count_hwm: description: Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sds_apm_scanned_bytes_sum: description: Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for all organizations. format: int64 type: integer sds_events_scanned_bytes_sum: description: Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for all organizations. format: int64 type: integer sds_logs_scanned_bytes_sum: description: Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer sds_rum_scanned_bytes_sum: description: Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for all organizations. format: int64 type: integer sds_total_scanned_bytes_sum: description: Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_appservice_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_azurefunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_containerapp_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_fargate_ecs_tasks_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudfunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudrun_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Kubernetes Engine Autopilot pods for the current date for all organizations. format: int64 type: integer serverless_apps_apm_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Kubernetes Engine Autopilot pods for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the current date for all organizations. format: int64 type: integer serverless_apps_azure_container_app_instances_avg: description: Shows the average number of Serverless Apps for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_azure_count_avg: description: Shows the average number of Serverless Apps for Azure for the given date and given org. format: int64 type: integer serverless_apps_azure_function_app_instances_avg: description: Shows the average number of Serverless Apps for Azure Function App instances for the current date for all organizations. format: int64 type: integer serverless_apps_azure_web_app_instances_avg: description: Shows the average number of Serverless Apps for Azure Web App instances for the current date for all organizations. format: int64 type: integer serverless_apps_dsm_fargate_tasks_avg: description: Shows the average number of DSM Fargate ECS tasks monitored under Serverless Apps DSM for the current date for all organizations. format: int64 type: integer serverless_apps_ecs_avg: description: Shows the average number of Serverless Apps for Elastic Container Service for the current date for all organizations. format: int64 type: integer serverless_apps_eks_avg: description: Shows the average number of Serverless Apps for Elastic Kubernetes Service for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_avg: description: Shows the average number of Serverless Apps excluding Fargate for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_container_app_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_function_app_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_web_app_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_functions_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_run_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_infra_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps excluding Fargate for Google Kubernetes Engine Autopilot pods for the current date for all organizations. format: int64 type: integer serverless_apps_google_cloud_functions_instances_avg: description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the current date for all organizations. format: int64 type: integer serverless_apps_google_cloud_run_instances_avg: description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_google_count_avg: description: Shows the average number of Serverless Apps for Google Cloud for the given date and given org. format: int64 type: integer serverless_apps_infra_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps for Google Kubernetes Engine Autopilot pods for the current date for all organizations. format: int64 type: integer serverless_apps_total_count_avg: description: Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org. format: int64 type: integer siem_12mo_retention_sum: description: Shows the sum of Cloud SIEM Indexed Logs (12-month retention) over all hours in the current date for the given org. format: int64 type: integer siem_6mo_retention_sum: description: Shows the sum of Cloud SIEM Indexed Logs (6-month retention) over all hours in the current date for the given org. format: int64 type: integer siem_analyzed_logs_add_on_count_sum: description: Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org. format: int64 type: integer snmp_device_count_sum: description: Shows the sum of all Network Device Monitoring devices over all hours in the current date for all organizations. format: int64 type: integer snmp_device_count_top99p: description: Shows the 99th percentile of all Network Device Monitoring devices over all hours in the current date for all organizations. format: int64 type: integer synthetics_browser_check_calls_count_sum: description: Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. format: int64 type: integer synthetics_check_calls_count_sum: description: Shows the sum of all Synthetic API tests over all hours in the current date for all organizations. format: int64 type: integer synthetics_mobile_test_runs_sum: description: Shows the sum of all Synthetic mobile application tests over all hours in the current date for all organizations. format: int64 type: integer synthetics_parallel_testing_max_slots_hwm: description: Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for all organizations. format: int64 type: integer trace_search_indexed_events_count_sum: description: Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. format: int64 type: integer twol_ingested_events_bytes_sum: description: Shows the sum of all ingested APM span bytes over all hours in the current date for all organizations. format: int64 type: integer universal_service_monitoring_host_top99p: description: Shows the 99th percentile of all universal service management hosts over all hours in the current date for the given org. format: int64 type: integer vsphere_host_top99p: description: Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. format: int64 type: integer vuln_management_host_count_top99p: description: Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org. format: int64 type: integer workflow_executions_usage_sum: description: Sum of all workflows executed over all hours in the current date for all organizations. format: int64 type: integer type: object UsageSummaryDateOrg: description: |- Global hourly report of all data billed by Datadog for a given organization. Newly added billing dimensions and usage types appear as untyped keys on the `additionalProperties` map instead of as typed fields. Call `GET /api/v2/usage/summary/available_fields` to enumerate every key returned at this response level—both typed fields and `additionalProperties` keys. properties: account_name: description: The account name. type: string account_public_id: description: The account public id. type: string agent_host_top99p: description: Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. format: int64 type: integer ai_credits_agent_builder_ai_credits_sum: description: Shows the sum of all AI credits used by Agent Builder over all hours in the current date for the given org. format: int64 type: integer ai_credits_bits_assistant_ai_credits_sum: description: Shows the sum of all AI credits used by Bits AI Assistant over all hours in the current date for the given org. format: int64 type: integer ai_credits_bits_dev_ai_credits_sum: description: Shows the sum of all AI credits used by Bits AI Dev over all hours in the current date for the given org. format: int64 type: integer ai_credits_bits_sre_ai_credits_sum: description: Shows the sum of all AI credits used by Bits AI SRE over all hours in the current date for the given org. format: int64 type: integer ai_credits_sum: description: Shows the sum of all AI credits over all hours in the current date for the given org. format: int64 type: integer apm_azure_app_service_host_top99p: description: Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. format: int64 type: integer apm_devsecops_host_top99p: description: Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org. format: int64 type: integer apm_enterprise_standalone_hosts_top99p: description: Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org. format: int64 type: integer apm_fargate_count_avg: description: Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org. format: int64 type: integer apm_host_top99p: description: Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. format: int64 type: integer apm_pro_standalone_hosts_top99p: description: Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org. format: int64 type: integer appsec_fargate_count_avg: description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org. format: int64 type: integer asm_serverless_sum: description: Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current month for the given org. format: int64 type: integer audit_logs_lines_indexed_sum: deprecated: true description: Shows the sum of all audit logs lines indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer audit_trail_enabled_hwm: description: Shows whether Audit Trail is enabled for the current date for the given org. format: int64 type: integer audit_trail_event_forwarding_events_sum: description: Shows the sum of all Audit Trail event forwarding events over all hours in the current date for the given org. format: int64 type: integer avg_profiled_fargate_tasks: description: The average total count for Fargate Container Profiler over all hours in the current month for the given org. format: int64 type: integer aws_host_top99p: description: Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. format: int64 type: integer aws_lambda_func_count: description: Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. format: int64 type: integer aws_lambda_invocations_sum: description: Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. format: int64 type: integer azure_app_service_top99p: description: Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. format: int64 type: integer billable_ingested_bytes_sum: description: Shows the sum of all log bytes ingested over all hours in the current date for the given org. format: int64 type: integer bits_ai_investigations_sum: description: Shows the sum of all Bits AI Investigations over all hours in the current date for the given org. format: int64 type: integer browser_rum_lite_session_count_sum: deprecated: true description: Shows the sum of all browser lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_replay_session_count_sum: description: Shows the sum of all browser replay sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_units_sum: deprecated: true description: Shows the sum of all browser RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer ccm_anthropic_spend_last: description: Shows the last value of Anthropic cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_aws_spend_last: description: Shows the last value of AWS cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_azure_spend_last: description: Shows the last value of Azure cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_confluent_spend_last: description: Shows the last value of Confluent cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_databricks_spend_last: description: Shows the last value of Databricks cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_elastic_spend_last: description: Shows the last value of Elastic cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_fastly_spend_last: description: Shows the last value of Fastly cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_gcp_spend_last: description: Shows the last value of GCP cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_github_spend_last: description: Shows the last value of GitHub cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_mongodb_spend_last: description: Shows the last value of MongoDB cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_oci_spend_last: description: Shows the last value of OCI cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_openai_spend_last: description: Shows the last value of OpenAI cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_snowflake_spend_last: description: Shows the last value of Snowflake cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ccm_spend_monitored_ent_last: description: Shows the last value of the amount of cloud spend monitored for Enterprise over all hours in the current date for the given org. format: int64 type: integer ccm_spend_monitored_pro_last: description: Shows the last value of the amount of cloud spend monitored for Pro over all hours in the current date for the given org. format: int64 type: integer ccm_twilio_spend_last: description: Shows the last value of Twilio cloud spend monitored over all hours in the current date for the given org. format: int64 type: integer ci_pipeline_indexed_spans_sum: description: Shows the sum of all CI pipeline indexed spans over all hours in the current date for the given org. format: int64 type: integer ci_test_indexed_spans_sum: description: Shows the sum of all CI test indexed spans over all hours in the current date for the given org. format: int64 type: integer ci_visibility_itr_committers_hwm: description: Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current date for the given org. format: int64 type: integer ci_visibility_pipeline_committers_hwm: description: Shows the high-water mark of all CI visibility pipeline committers over all hours in the current date for the given org. format: int64 type: integer ci_visibility_test_committers_hwm: description: Shows the high-water mark of all CI visibility test committers over all hours in the current date for the given org. format: int64 type: integer cloud_cost_management_aws_host_count_avg: description: Host count average of Cloud Cost Management for AWS for the given date and given org. format: int64 type: integer cloud_cost_management_azure_host_count_avg: description: Host count average of Cloud Cost Management for Azure for the given date and given org. format: int64 type: integer cloud_cost_management_gcp_host_count_avg: description: Host count average of Cloud Cost Management for GCP for the given date and given org. format: int64 type: integer cloud_cost_management_host_count_avg: description: Host count average of Cloud Cost Management for all cloud providers for the given date and given org. format: int64 type: integer cloud_cost_management_oci_host_count_avg: description: Average host count for Cloud Cost Management on OCI for the given date and organization. format: int64 type: integer cloud_siem_events_sum: description: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org. format: int64 type: integer cloud_siem_indexed_logs_sum: description: Shows the sum of all Cloud SIEM Indexed Logs over all hours in the current date for the given org. format: int64 type: integer code_analysis_sa_committers_hwm: description: Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_analysis_sca_committers_hwm: description: Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_security_host_top99p: description: Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org. format: int64 type: integer container_avg: description: Shows the average of all distinct containers over all hours in the current date for the given org. format: int64 type: integer container_excl_agent_avg: description: Shows the average of containers without the Datadog Agent over all hours in the current date for the given organization. format: int64 type: integer container_hwm: description: Shows the high-water mark of all distinct containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_compliance_count_sum: description: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_cws_count_sum: description: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_total_count_sum: description: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aas_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aws_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_azure_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_compliance_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_cws_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_gcp_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_oci_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise OCI hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_total_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_hosts_agentless_scanners_sum: description: Shows the sum of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_hosts_agentless_scanners_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_oci_host_count_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro OCI hosts over all hours in the current date for the given org. format: int64 type: integer cspm_aas_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for the given org. format: int64 type: integer cspm_aws_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for the given org. format: int64 type: integer cspm_azure_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for the given org. format: int64 type: integer cspm_container_avg: description: Shows the average number of Cloud Security Management Pro containers over all hours in the current date for the given org. format: int64 type: integer cspm_container_hwm: description: Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for the given org. format: int64 type: integer cspm_gcp_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for the given org. format: int64 type: integer cspm_host_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for the given org. format: int64 type: integer cspm_hosts_agentless_scanners_sum: description: Shows the sum of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for the given org. format: int64 type: integer cspm_hosts_agentless_scanners_top99p: description: Shows the 99th percentile of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current date for the given org. format: int64 type: integer custom_historical_ts_avg: description: Shows the average number of distinct historical custom metrics over all hours in the current date for the given org. format: int64 type: integer custom_live_ts_avg: description: Shows the average number of distinct live custom metrics over all hours in the current date for the given org. format: int64 type: integer custom_ts_avg: description: Shows the average number of distinct custom metrics over all hours in the current date for the given org. format: int64 type: integer cws_container_count_avg: description: Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org. format: int64 type: integer cws_fargate_task_avg: description: Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for the given org. format: int64 type: integer cws_host_top99p: description: Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org. format: int64 type: integer data_jobs_monitoring_host_hr_sum: description: Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer data_stream_monitoring_host_count_sum: description: Shows the sum of all Data Streams Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer data_stream_monitoring_host_count_top99p: description: Shows the 99th percentile of all Data Streams Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer dbm_host_top99p_sum: description: Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for the given org. format: int64 type: integer dbm_queries_avg_sum: description: Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for the given org. format: int64 type: integer do_jobs_monitoring_orchestrators_job_hours_sum: description: Shows the sum of all orchestrator job hours over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_agent_sum: description: Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_alibaba_sum: description: Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_aws_sum: description: Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_azure_sum: description: Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_basic_infra_basic_agent_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier with the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_basic_infra_basic_vsphere_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier on vSphere over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_basic_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_ent_sum: description: Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_gcp_sum: description: Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_heroku_sum: description: Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_aas_sum: description: Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_vsphere_sum: description: Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_apm_sum: description: Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_sum: description: Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_pro_sum: description: Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proplus_sum: description: Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proxmox_sum: description: Sum of all ephemeral infrastructure hosts for Proxmox over all hours in the current date for the given organization. format: int64 type: integer error_tracking_apm_error_events_sum: description: Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_error_events_sum: description: Shows the sum of all Error Tracking error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_events_sum: description: Shows the sum of all Error Tracking events over all hours in the current date for the given org. format: int64 type: integer error_tracking_rum_error_events_sum: description: Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_correlated_events_sum: description: Shows the sum of all Event Management correlated events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_correlated_related_events_sum: description: Shows the sum of all Event Management correlated related events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_sum: description: Shows the sum of all Event Management correlations over all hours in the current date for the given org. format: int64 type: integer fargate_container_profiler_profiling_fargate_avg: description: The average number of Profiling Fargate tasks over all hours in the current month for the given org. format: int64 type: integer fargate_container_profiler_profiling_fargate_eks_avg: description: The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for the given org. format: int64 type: integer fargate_tasks_count_avg: description: The average task count for Fargate. format: int64 type: integer fargate_tasks_count_hwm: description: Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. format: int64 type: integer feature_flags_config_requests_sum: description: Shows the sum of all Feature Flags Client-Side SDK config requests over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_large_avg: description: Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_medium_avg: description: Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_small_avg: description: Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xlarge_avg: description: Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xsmall_avg: description: Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_avg: description: Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_index_avg: description: Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_retention_adjustment_avg: description: Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org. format: int64 type: integer flex_stored_logs_avg: description: Shows the average of all Flex Stored Logs over all hours in the current date for the given org. format: int64 type: integer forwarding_events_bytes_sum: description: Shows the sum of all log bytes forwarded over all hours in the current date for the given org. format: int64 type: integer gcp_host_top99p: description: Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. format: int64 type: integer heroku_host_top99p: description: Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. format: int64 type: integer id: description: The organization id. type: string incident_management_monthly_active_users_hwm: description: Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org. format: int64 type: integer incident_management_seats_hwm: description: Shows the high-water mark of Incident Management seats over all hours on the current date for the given organization. format: int64 type: integer indexed_events_count_sum: deprecated: true description: Shows the sum of all log events indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer indexed_points_sum: description: Shows the sum of all indexed custom metrics points over all hours in the current date for the given org. format: int64 type: integer infra_cpu_avg: description: Shows the average of all Infrastructure vCPU cores over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_avg: description: Shows the average of all default Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_basic_avg: description: Shows the average of all default basic Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_basic_sum: description: Shows the sum of all default basic Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_sum: description: Shows the sum of all default Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_aws_avg: description: Shows the average of all default Infrastructure host vCPU cores on AWS over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_aws_sum: description: Shows the sum of all default Infrastructure host vCPU cores on AWS over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_azure_avg: description: Shows the average of all default Infrastructure host vCPU cores on Azure over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_azure_sum: description: Shows the sum of all default Infrastructure host vCPU cores on Azure over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_gcp_avg: description: Shows the average of all default Infrastructure host vCPU cores on GCP over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_gcp_sum: description: Shows the sum of all default Infrastructure host vCPU cores on GCP over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_avg: description: Shows the average of all default Infrastructure host vCPU cores on Nutanix over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_basic_avg: description: Shows the average of all default basic Infrastructure host vCPU cores on Nutanix over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_basic_sum: description: Shows the sum of all default basic Infrastructure host vCPU cores on Nutanix over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_sum: description: Shows the sum of all default Infrastructure host vCPU cores on Nutanix over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_opentelemetry_avg: description: Shows the average of all default Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for the given org. format: int64 type: integer infra_cpu_default_infra_host_vcpu_opentelemetry_sum: description: Shows the sum of all default Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_agent_avg: description: Shows the average of all observed Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_agent_sum: description: Shows the sum of all observed Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_aws_avg: description: Shows the average of all observed Infrastructure host vCPU cores on AWS over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_aws_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on AWS over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_azure_avg: description: Shows the average of all observed Infrastructure host vCPU cores on Azure over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_azure_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on Azure over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_gcp_avg: description: Shows the average of all observed Infrastructure host vCPU cores on GCP over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_gcp_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on GCP over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_nutanix_avg: description: Shows the average of all observed Infrastructure host vCPU cores on Nutanix over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_nutanix_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on Nutanix over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_opentelemetry_avg: description: Shows the average of all observed Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for the given org. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_opentelemetry_sum: description: Shows the sum of all observed Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current date for the given org. format: int64 type: integer infra_cpu_sum: description: Shows the sum of all Infrastructure vCPU cores over all hours in the current date for the given org. format: int64 type: integer infra_edge_monitoring_devices_top99p: description: Shows the 99th percentile of all Edge Devices Monitoring devices over all hours in the current date for the given org. format: int64 type: integer infra_host_basic_infra_basic_agent_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier with the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer infra_host_basic_infra_basic_vsphere_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier on vSphere over all hours in the current date for the given org. format: int64 type: integer infra_host_basic_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier over all hours in the current date for the given org. format: int64 type: integer infra_host_top99p: description: Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer infra_storage_mgmt_objects_count_avg: description: Shows the average number of storage management objects over all hours in the current date for the given org. format: int64 type: integer ingest_points_sum: description: Shows the sum of all ingested custom metrics points over all hours in the current date for the given org. format: int64 type: integer ingested_events_bytes_sum: description: Shows the sum of all log bytes ingested over all hours in the current date for the given org. format: int64 type: integer iot_apm_host_sum: description: Shows the sum of all Application Performance Monitoring IoT hosts over all hours in the current date for the given org. format: int64 type: integer iot_apm_host_top99p: description: Shows the 99th percentile of all Application Performance Monitoring IoT hosts over all hours in the current date for the given org. format: int64 type: integer iot_device_agg_sum: description: Shows the sum of all IoT devices over all hours in the current date for the given org. format: int64 type: integer iot_device_top99p_sum: description: Shows the 99th percentile of all IoT devices over all hours in the current date for the given org. format: int64 type: integer llm_observability_15day_retention_spans_sum: description: Shows the sum of all LLM Observability 15-day retention spans over all hours in the current date for the given org. format: int64 type: integer llm_observability_30day_retention_spans_sum: description: Shows the sum of all LLM Observability 30-day retention spans over all hours in the current date for the given org. format: int64 type: integer llm_observability_60day_retention_spans_sum: description: Shows the sum of all LLM Observability 60-day retention spans over all hours in the current date for the given org. format: int64 type: integer llm_observability_90day_retention_spans_sum: description: Shows the sum of all LLM Observability 90-day retention spans over all hours in the current date for the given org. format: int64 type: integer llm_observability_min_spend_sum: description: Shows the sum of all LLM Observability minimum spend over all hours in the current date for the given org. format: int64 type: integer llm_observability_sum: description: Shows the sum of all LLM observability sessions over all hours in the current date for the given org. format: int64 type: integer logs_archive_search_gb_scanned_sum: description: Shows the sum of all Logs Archive Search scanned data over all hours in the current date for the given org. format: int64 type: integer metric_names_sum: description: Shows the sum of all custom metric names over all hours in the current date for the given org. format: int64 type: integer mobile_rum_lite_session_count_sum: deprecated: true description: Shows the sum of all mobile lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_android_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_flutter_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_ios_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_reactnative_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_roku_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_sum: deprecated: true description: Shows the sum of all mobile RUM sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_units_sum: deprecated: true description: Shows the sum of all mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer name: description: The organization name. type: string ndm_netflow_events_sum: description: Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org. format: int64 type: integer netflow_indexed_events_count_sum: deprecated: true description: Shows the sum of all Network flows indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer network_device_wireless_top99p: description: Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for the given org. format: int64 type: integer network_path_sum: description: Shows the sum of all Network Path scheduled tests over all hours in the current date for the given org. format: int64 type: integer npm_host_top99p: description: Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for the given org. format: int64 type: integer observability_pipelines_bytes_processed_sum: description: Sum of all observability pipelines bytes processed over all hours in the current date for the given org. format: int64 type: integer oci_host_sum: description: Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer oci_host_top99p: description: Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer on_call_seat_hwm: description: Shows the high-water mark of On-Call seats over all hours in the current date for the given org. format: int64 type: integer online_archive_events_count_sum: description: Sum of all online archived events over all hours in the current date for the given org. format: int64 type: integer opentelemetry_apm_host_top99p: description: Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer opentelemetry_host_top99p: description: Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer product_analytics_sum: description: Shows the sum of all product analytics sessions over all hours in the current date for the given org. format: int64 type: integer profiling_aas_count_top99p: description: Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations. format: int64 type: integer profiling_host_top99p: description: Shows the 99th percentile of all profiled hosts over all hours within the current date for the given org. format: int64 type: integer proxmox_host_sum: description: Sum of all Proxmox hosts over all hours in the current date for the given organization. format: int64 type: integer proxmox_host_top99p: description: 99th percentile of all Proxmox hosts over all hours in the current date for the given organization. format: int64 type: integer public_id: description: The organization public id. type: string published_app_hwm: description: Shows the high-water mark of all published applications over all hours in the current date for the given org. format: int64 type: integer region: description: The region of the organization. type: string rum_browser_and_mobile_session_count: description: Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer rum_browser_legacy_session_count_sum: description: Shows the sum of all browser RUM legacy sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_lite_session_count_sum: description: Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_replay_session_count_sum: description: Shows the sum of all browser RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_indexed_sessions_sum: description: Shows the sum of all RUM indexed sessions over all hours in the current date for the given org. format: int64 type: integer rum_ingested_sessions_sum: description: Shows the sum of all RUM ingested sessions over all hours in the current date for the given org. format: int64 type: integer rum_lite_session_count_sum: description: Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_android_sum: description: Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_flutter_sum: description: Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_ios_sum: description: Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_reactnative_sum: description: Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_roku_sum: description: Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_android_sum: description: Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_flutter_sum: description: Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_ios_sum: description: Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_kotlinmultiplatform_sum: description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for the given org. format: int64 type: integer rum_mobile_lite_session_count_reactnative_sum: description: Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_roku_sum: description: Shows the sum of all mobile RUM lite sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_unity_sum: description: Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_android_sum: description: Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_ios_sum: description: Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_kotlinmultiplatform_sum: description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_reactnative_sum: description: Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org. format: int64 type: integer rum_replay_session_count_sum: description: Shows the sum of all RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_session_count_sum: deprecated: true description: Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer rum_session_replay_add_on_sum: description: Shows the sum of all RUM session replay add-on sessions over all hours in the current date for the given org. format: int64 type: integer rum_total_session_count_sum: description: Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for the given org. format: int64 type: integer rum_units_sum: deprecated: true description: Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer sca_fargate_count_avg: description: Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sca_fargate_count_hwm: description: Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sds_apm_scanned_bytes_sum: description: Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for the given org. format: int64 type: integer sds_events_scanned_bytes_sum: description: Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for the given org. format: int64 type: integer sds_logs_scanned_bytes_sum: description: Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for the given org. format: int64 type: integer sds_rum_scanned_bytes_sum: description: Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for the given org. format: int64 type: integer sds_total_scanned_bytes_sum: description: Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for the given org. format: int64 type: integer serverless_apps_apm_apm_azure_appservice_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_azure_azurefunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_azure_containerapp_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_fargate_ecs_tasks_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudfunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudrun_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Kubernetes Engine Autopilot pods for the given date and given org. format: int64 type: integer serverless_apps_apm_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Kubernetes Engine Autopilot pods for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_avg: description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the given date and given org. format: int64 type: integer serverless_apps_azure_container_app_instances_avg: description: Shows the average number of Serverless Apps for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_azure_count_avg: description: Shows the average number of Serverless Apps for Azure for the given date and given org. format: int64 type: integer serverless_apps_azure_function_app_instances_avg: description: Shows the average number of Serverless Apps for Azure Function App instances for the given date and given org. format: int64 type: integer serverless_apps_azure_web_app_instances_avg: description: Shows the average number of Serverless Apps for Azure Web App instances for the given date and given org. format: int64 type: integer serverless_apps_dsm_fargate_tasks_avg: description: Shows the average number of DSM Fargate ECS tasks monitored under Serverless Apps DSM for the given date and given org. format: int64 type: integer serverless_apps_ecs_avg: description: Shows the average number of Serverless Apps for Elastic Container Service for the given date and given org. format: int64 type: integer serverless_apps_eks_avg: description: Shows the average number of Serverless Apps for Elastic Kubernetes Service for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_avg: description: Shows the average number of Serverless Apps excluding Fargate for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_azure_container_app_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_azure_function_app_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_azure_web_app_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_functions_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_run_instances_avg: description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_infra_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps excluding Fargate for Google Kubernetes Engine Autopilot pods for the given date and given org. format: int64 type: integer serverless_apps_google_cloud_functions_instances_avg: description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the given date and given org. format: int64 type: integer serverless_apps_google_cloud_run_instances_avg: description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_google_count_avg: description: Shows the average number of Serverless Apps for Google Cloud for the given date and given org. format: int64 type: integer serverless_apps_infra_gcp_gke_autopilot_pods_avg: description: Shows the average number of Serverless Apps for Google Kubernetes Engine Autopilot pods for the given date and given org. format: int64 type: integer serverless_apps_total_count_avg: description: Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org. format: int64 type: integer siem_12mo_retention_sum: description: Shows the sum of Cloud SIEM Indexed Logs (12-month retention) over all hours in the current date for the given org. format: int64 type: integer siem_6mo_retention_sum: description: Shows the sum of Cloud SIEM Indexed Logs (6-month retention) over all hours in the current date for the given org. format: int64 type: integer siem_analyzed_logs_add_on_count_sum: description: Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org. format: int64 type: integer snmp_device_count_sum: description: Shows the sum of all Network Device Monitoring devices over all hours in the current date for the given org. format: int64 type: integer snmp_device_count_top99p: description: Shows the 99th percentile of all Network Device Monitoring devices over all hours in the current date for the given org. format: int64 type: integer synthetics_browser_check_calls_count_sum: description: Shows the sum of all Synthetic browser tests over all hours in the current date for the given org. format: int64 type: integer synthetics_check_calls_count_sum: description: Shows the sum of all Synthetic API tests over all hours in the current date for the given org. format: int64 type: integer synthetics_mobile_test_runs_sum: description: Shows the sum of all Synthetic mobile application tests over all hours in the current date for the given org. format: int64 type: integer synthetics_parallel_testing_max_slots_hwm: description: Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for the given org. format: int64 type: integer trace_search_indexed_events_count_sum: description: Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org. format: int64 type: integer twol_ingested_events_bytes_sum: description: Shows the sum of all ingested APM span bytes over all hours in the current date for the given org. format: int64 type: integer universal_service_monitoring_host_top99p: description: Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer vsphere_host_top99p: description: Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. format: int64 type: integer vuln_management_host_count_top99p: description: Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org. format: int64 type: integer workflow_executions_usage_sum: description: Sum of all workflows executed over all hours in the current date for the given org. format: int64 type: integer type: object UsageSummaryResponse: description: |- Response summarizing all usage aggregated across the months in the request for all organizations, and broken down by month and by organization. Newly added billing dimensions and usage types appear as untyped keys on the `additionalProperties` map instead of as typed fields. Call `GET /api/v2/usage/summary/available_fields` to enumerate every key returned at this response level—both typed fields and `additionalProperties` keys. properties: agent_host_top99p_sum: description: Shows the 99th percentile of all agent hosts over all hours in the current month for all organizations. format: int64 type: integer ai_credits_agent_builder_ai_credits_agg_sum: description: Shows the sum of all AI credits used by Agent Builder over all hours in the current month for all organizations. format: int64 type: integer ai_credits_agg_sum: description: Shows the sum of all AI credits over all hours in the current month for all organizations. format: int64 type: integer ai_credits_bits_assistant_ai_credits_agg_sum: description: Shows the sum of all AI credits used by Bits AI Assistant over all hours in the current month for all organizations. format: int64 type: integer ai_credits_bits_dev_ai_credits_agg_sum: description: Shows the sum of all AI credits used by Bits AI Dev over all hours in the current month for all organizations. format: int64 type: integer ai_credits_bits_sre_ai_credits_agg_sum: description: Shows the sum of all AI credits used by Bits AI SRE over all hours in the current month for all organizations. format: int64 type: integer apm_azure_app_service_host_top99p_sum: description: Shows the 99th percentile of all Azure app services using APM over all hours in the current month all organizations. format: int64 type: integer apm_devsecops_host_top99p_sum: description: Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current month for all organizations. format: int64 type: integer apm_enterprise_standalone_hosts_top99p_sum: description: Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations. format: int64 type: integer apm_fargate_count_avg_sum: description: Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer apm_host_top99p_sum: description: Shows the 99th percentile of all distinct APM hosts over all hours in the current month for all organizations. format: int64 type: integer apm_pro_standalone_hosts_top99p_sum: description: Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations. format: int64 type: integer appsec_fargate_count_avg_sum: description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer asm_serverless_agg_sum: description: Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current months for all organizations. format: int64 type: integer audit_logs_lines_indexed_agg_sum: deprecated: true description: Shows the sum of all audit logs lines indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer audit_trail_enabled_hwm_sum: description: Shows the total number of organizations that had Audit Trail enabled over a specific number of months. format: int64 type: integer audit_trail_event_forwarding_events_agg_sum: description: Shows the sum of all Audit Trail event forwarding events over all hours in the current month for all organizations. format: int64 type: integer avg_profiled_fargate_tasks_sum: description: The average total count for Fargate Container Profiler over all hours in the current month for all organizations. format: int64 type: integer aws_host_top99p_sum: description: Shows the 99th percentile of all AWS hosts over all hours in the current month for all organizations. format: int64 type: integer aws_lambda_func_count: description: Shows the average of the number of functions that executed 1 or more times each hour in the current month for all organizations. format: int64 type: integer aws_lambda_invocations_sum: description: Shows the sum of all AWS Lambda invocations over all hours in the current month for all organizations. format: int64 type: integer azure_app_service_top99p_sum: description: Shows the 99th percentile of all Azure app services over all hours in the current month for all organizations. format: int64 type: integer azure_host_top99p_sum: description: Shows the 99th percentile of all Azure hosts over all hours in the current month for all organizations. format: int64 type: integer billable_ingested_bytes_agg_sum: description: Shows the sum of all log bytes ingested over all hours in the current month for all organizations. format: int64 type: integer bits_ai_investigations_agg_sum: description: Shows the sum of all Bits AI Investigations over all hours in the current month for all organizations. format: int64 type: integer browser_rum_lite_session_count_agg_sum: deprecated: true description: Shows the sum of all browser lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_replay_session_count_agg_sum: description: Shows the sum of all browser replay sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_units_agg_sum: deprecated: true description: Shows the sum of all browser RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ccm_anthropic_spend_last_sum: description: Shows the sum of the last value of Anthropic cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_aws_spend_last_sum: description: Shows the sum of the last value of AWS cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_azure_spend_last_sum: description: Shows the sum of the last value of Azure cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_confluent_spend_last_sum: description: Shows the sum of the last value of Confluent cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_databricks_spend_last_sum: description: Shows the sum of the last value of Databricks cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_elastic_spend_last_sum: description: Shows the sum of the last value of Elastic cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_fastly_spend_last_sum: description: Shows the sum of the last value of Fastly cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_gcp_spend_last_sum: description: Shows the sum of the last value of GCP cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_github_spend_last_sum: description: Shows the sum of the last value of GitHub cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_mongodb_spend_last_sum: description: Shows the sum of the last value of MongoDB cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_oci_spend_last_sum: description: Shows the sum of the last value of OCI cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_openai_spend_last_sum: description: Shows the sum of the last value of OpenAI cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_snowflake_spend_last_sum: description: Shows the sum of the last value of Snowflake cloud spend monitored in the current month for all organizations. format: int64 type: integer ccm_spend_monitored_ent_last_sum: description: Shows the sum of the last value of the amount of cloud spend monitored for Enterprise in the current month for all organizations. format: int64 type: integer ccm_spend_monitored_pro_last_sum: description: Shows the sum of the last value of the amount of cloud spend monitored for Pro in the current month for all organizations. format: int64 type: integer ccm_twilio_spend_last_sum: description: Shows the sum of the last value of Twilio cloud spend monitored in the current month for all organizations. format: int64 type: integer ci_pipeline_indexed_spans_agg_sum: description: Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_test_indexed_spans_agg_sum: description: Shows the sum of all CI test indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_itr_committers_hwm_sum: description: Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_pipeline_committers_hwm_sum: description: Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_test_committers_hwm_sum: description: Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations. format: int64 type: integer cloud_cost_management_aws_host_count_avg_sum: description: Sum of the host count average for Cloud Cost Management for AWS. format: int64 type: integer cloud_cost_management_azure_host_count_avg_sum: description: Sum of the host count average for Cloud Cost Management for Azure. format: int64 type: integer cloud_cost_management_gcp_host_count_avg_sum: description: Sum of the host count average for Cloud Cost Management for GCP. format: int64 type: integer cloud_cost_management_host_count_avg_sum: description: Sum of the host count average for Cloud Cost Management for all cloud providers. format: int64 type: integer cloud_cost_management_oci_host_count_avg_sum: description: Sum of the average host counts for Cloud Cost Management on OCI. format: int64 type: integer cloud_siem_events_agg_sum: description: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current month for all organizations. format: int64 type: integer cloud_siem_indexed_logs_agg_sum: description: Shows the sum of all Cloud SIEM Indexed Logs over all hours in the current month for all organizations. format: int64 type: integer code_analysis_sa_committers_hwm_sum: description: Shows the high-water mark of all Static Analysis committers over all hours in the current month for all organizations. format: int64 type: integer code_analysis_sca_committers_hwm_sum: description: Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current month for all organizations. format: int64 type: integer code_security_host_top99p_sum: description: Shows the 99th percentile of all Code Security hosts over all hours in the current month for all organizations. format: int64 type: integer container_avg_sum: description: Shows the average of all distinct containers over all hours in the current month for all organizations. format: int64 type: integer container_excl_agent_avg_sum: description: Shows the average of the containers without the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer container_hwm_sum: description: Shows the sum of the high-water marks of all distinct containers over all hours in the current month for all organizations. format: int64 type: integer csm_container_enterprise_compliance_count_agg_sum: description: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current month for all organizations. format: int64 type: integer csm_container_enterprise_cws_count_agg_sum: description: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current month for all organizations. format: int64 type: integer csm_container_enterprise_total_count_agg_sum: description: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_aas_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_aws_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_azure_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_compliance_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_cws_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_gcp_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_oci_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise OCI hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_total_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_pro_hosts_agentless_scanners_agg_sum: description: Shows the sum of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_pro_hosts_agentless_scanners_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_pro_oci_host_count_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro OCI hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_aas_host_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_aws_host_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_azure_host_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_container_avg_sum: description: Shows the average number of Cloud Security Management Pro containers over all hours in the current month for all organizations. format: int64 type: integer cspm_container_hwm_sum: description: Shows the sum of the high-water marks of Cloud Security Management Pro containers over all hours in the current month for all organizations. format: int64 type: integer cspm_gcp_host_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_host_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_hosts_agentless_scanners_agg_sum: description: Shows the sum of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_hosts_agentless_scanners_top99p_sum: description: Shows the 99th percentile of all Cloud Security Management Pro Agentless scanner hosts over all hours in the current month for all organizations. format: int64 type: integer custom_historical_ts_sum: description: Shows the average number of distinct historical custom metrics over all hours in the current month for all organizations. format: int64 type: integer custom_live_ts_sum: description: Shows the average number of distinct live custom metrics over all hours in the current month for all organizations. format: int64 type: integer custom_ts_sum: description: Shows the average number of distinct custom metrics over all hours in the current month for all organizations. format: int64 type: integer cws_container_avg_sum: description: Shows the average of all distinct Cloud Workload Security containers over all hours in the current month for all organizations. format: int64 type: integer cws_fargate_task_avg_sum: description: Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer cws_host_top99p_sum: description: Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current month for all organizations. format: int64 type: integer data_jobs_monitoring_host_hr_agg_sum: description: Shows the sum of Data Jobs Monitoring hosts over all hours in the current months for all organizations format: int64 type: integer data_stream_monitoring_host_count_agg_sum: description: Shows the sum of all Data Streams Monitoring hosts over all hours in the current month for all organizations. format: int64 type: integer data_stream_monitoring_host_count_top99p_sum: description: Shows the 99th percentile of all Data Streams Monitoring hosts over all hours in the current month for all organizations. format: int64 type: integer dbm_host_top99p_sum: description: Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations. format: int64 type: integer dbm_queries_avg_sum: description: Shows the average of all distinct Database Monitoring Normalized Queries over all hours in the current month for all organizations. format: int64 type: integer do_jobs_monitoring_orchestrators_job_hours_agg_sum: description: Shows the sum of all orchestrator job hours over all hours in the current month for all organizations. format: int64 type: integer end_date: description: Shows the last date of usage in the current month for all organizations. format: date-time type: string eph_infra_host_agent_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_alibaba_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_aws_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_azure_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_basic_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_basic_infra_basic_agent_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier with the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_basic_infra_basic_vsphere_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts for Basic tier on vSphere over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_ent_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_gcp_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_heroku_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_only_aas_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_only_vsphere_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_opentelemetry_agg_sum: description: Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_opentelemetry_apm_agg_sum: description: Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_pro_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_proplus_agg_sum: description: Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_proxmox_agg_sum: description: Sum of all ephemeral infrastructure hosts for Proxmox over all hours in the current month for all organizations. format: int64 type: integer error_tracking_apm_error_events_agg_sum: description: Shows the sum of all Error Tracking APM error events over all hours in the current month for all organizations. format: int64 type: integer error_tracking_error_events_agg_sum: description: Shows the sum of all Error Tracking error events over all hours in the current month for all organizations. format: int64 type: integer error_tracking_events_agg_sum: description: Shows the sum of all Error Tracking events over all hours in the current months for all organizations. format: int64 type: integer error_tracking_rum_error_events_agg_sum: description: Shows the sum of all Error Tracking RUM error events over all hours in the current month for all organizations. format: int64 type: integer event_management_correlation_agg_sum: description: Shows the sum of all Event Management correlations over all hours in the current month for all organizations. format: int64 type: integer event_management_correlation_correlated_events_agg_sum: description: Shows the sum of all Event Management correlated events over all hours in the current month for all organizations. format: int64 type: integer event_management_correlation_correlated_related_events_agg_sum: description: Shows the sum of all Event Management correlated related events over all hours in the current month for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_avg_sum: description: The average number of Profiling Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_eks_avg_sum: description: The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for all organizations. format: int64 type: integer fargate_tasks_count_avg_sum: description: Shows the average of all Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer fargate_tasks_count_hwm_sum: description: Shows the sum of the high-water marks of all Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer feature_flags_config_requests_agg_sum: description: Shows the sum of all Feature Flags Client-Side SDK config requests over all hours in the current month for all organizations. format: int64 type: integer flex_logs_compute_large_avg_sum: description: Shows the average number of Flex Logs Compute Large Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_medium_avg_sum: description: Shows the average number of Flex Logs Compute Medium Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_small_avg_sum: description: Shows the average number of Flex Logs Compute Small Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_xlarge_avg_sum: description: Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_xsmall_avg_sum: description: Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_starter_avg_sum: description: Shows the average number of Flex Logs Starter Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_starter_storage_index_avg_sum: description: Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_starter_storage_retention_adjustment_avg_sum: description: Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current months for all organizations. format: int64 type: integer flex_stored_logs_avg_sum: description: Shows the average of all Flex Stored Logs over all hours in the current months for all organizations. format: int64 type: integer forwarding_events_bytes_agg_sum: description: Shows the sum of all logs forwarding bytes over all hours in the current month for all organizations (data available as of April 1, 2023) format: int64 type: integer gcp_host_top99p_sum: description: Shows the 99th percentile of all GCP hosts over all hours in the current month for all organizations. format: int64 type: integer heroku_host_top99p_sum: description: Shows the 99th percentile of all Heroku dynos over all hours in the current month for all organizations. format: int64 type: integer incident_management_monthly_active_users_hwm_sum: description: Shows sum of the high-water marks of incident management monthly active users in the current month for all organizations. format: int64 type: integer incident_management_seats_hwm_sum: description: Shows the sum of the high-water marks of Incident Management seats over all hours in the current month for all organizations. format: int64 type: integer indexed_events_count_agg_sum: deprecated: true description: Shows the sum of all log events indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer indexed_points_agg_sum: description: Shows the sum of all indexed custom metrics points over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_agg_sum: description: Shows the sum of all Infrastructure vCPU cores over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_avg_sum: description: Shows the average of all Infrastructure vCPU cores over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_agg_sum: description: Shows the sum of all default Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_avg_sum: description: Shows the average of all default Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_basic_agg_sum: description: Shows the sum of all default basic Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_agent_basic_avg_sum: description: Shows the average of all default basic Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_aws_agg_sum: description: Shows the sum of all default Infrastructure host vCPU cores on AWS over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_aws_avg_sum: description: Shows the average of all default Infrastructure host vCPU cores on AWS over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_azure_agg_sum: description: Shows the sum of all default Infrastructure host vCPU cores on Azure over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_azure_avg_sum: description: Shows the average of all default Infrastructure host vCPU cores on Azure over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_gcp_agg_sum: description: Shows the sum of all default Infrastructure host vCPU cores on GCP over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_gcp_avg_sum: description: Shows the average of all default Infrastructure host vCPU cores on GCP over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_agg_sum: description: Shows the sum of all default Infrastructure host vCPU cores on Nutanix over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_avg_sum: description: Shows the average of all default Infrastructure host vCPU cores on Nutanix over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_basic_agg_sum: description: Shows the sum of all default basic Infrastructure host vCPU cores on Nutanix over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_nutanix_basic_avg_sum: description: Shows the average of all default basic Infrastructure host vCPU cores on Nutanix over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_opentelemetry_agg_sum: description: Shows the sum of all default Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_default_infra_host_vcpu_opentelemetry_avg_sum: description: Shows the average of all default Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_agent_agg_sum: description: Shows the sum of all observed Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_agent_avg_sum: description: Shows the average of all observed Infrastructure host vCPU cores reported by the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_aws_agg_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on AWS over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_aws_avg_sum: description: Shows the average of all observed Infrastructure host vCPU cores on AWS over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_azure_agg_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on Azure over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_azure_avg_sum: description: Shows the average of all observed Infrastructure host vCPU cores on Azure over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_gcp_agg_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on GCP over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_gcp_avg_sum: description: Shows the average of all observed Infrastructure host vCPU cores on GCP over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_nutanix_agg_sum: description: Shows the sum of all observed Infrastructure host vCPU cores on Nutanix over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_nutanix_avg_sum: description: Shows the average of all observed Infrastructure host vCPU cores on Nutanix over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_opentelemetry_agg_sum: description: Shows the sum of all observed Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current month for all organizations. format: int64 type: integer infra_cpu_observed_infra_host_vcpu_opentelemetry_avg_sum: description: Shows the average of all observed Infrastructure host vCPU cores reported by OpenTelemetry over all hours in the current month for all organizations. format: int64 type: integer infra_edge_monitoring_devices_top99p_sum: description: Shows the 99th percentile of all Edge Devices Monitoring devices over all hours in the current month for all organizations. format: int64 type: integer infra_host_basic_infra_basic_agent_top99p_sum: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier with the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer infra_host_basic_infra_basic_vsphere_top99p_sum: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier on vSphere over all hours in the current month for all organizations. format: int64 type: integer infra_host_basic_top99p_sum: description: Shows the 99th percentile of all distinct infrastructure hosts for Basic tier over all hours in the current month for all organizations. format: int64 type: integer infra_host_top99p_sum: description: Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current month for all organizations. format: int64 type: integer infra_storage_mgmt_objects_count_avg_sum: description: Shows the average number of storage management objects over all hours in the current month for all organizations. format: int64 type: integer ingest_points_agg_sum: description: Shows the sum of all ingested custom metrics points over all hours in the current month for all organizations. format: int64 type: integer ingested_events_bytes_agg_sum: description: Shows the sum of all log bytes ingested over all hours in the current month for all organizations. format: int64 type: integer iot_apm_host_agg_sum: description: Shows the sum of all Application Performance Monitoring IoT hosts over all hours in the current month for all organizations. format: int64 type: integer iot_apm_host_top99p_sum: description: Shows the 99th percentile of all Application Performance Monitoring IoT hosts over all hours in the current month for all organizations. format: int64 type: integer iot_device_agg_sum: description: Shows the sum of all IoT devices over all hours in the current month for all organizations. format: int64 type: integer iot_device_top99p_sum: description: Shows the 99th percentile of all IoT devices over all hours in the current month of all organizations. format: int64 type: integer last_updated: description: Shows the most recent hour in the current month for all organizations for which all usages were calculated. format: date-time type: string live_indexed_events_agg_sum: deprecated: true description: Shows the sum of all live logs indexed over all hours in the current month for all organization (To be deprecated on October 1st, 2024). format: int64 type: integer live_ingested_bytes_agg_sum: description: Shows the sum of all live logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020). format: int64 type: integer llm_observability_15day_retention_spans_agg_sum: description: Shows the sum of all LLM Observability 15-day retention spans over all hours in the current month for all organizations. format: int64 type: integer llm_observability_30day_retention_spans_agg_sum: description: Shows the sum of all LLM Observability 30-day retention spans over all hours in the current month for all organizations. format: int64 type: integer llm_observability_60day_retention_spans_agg_sum: description: Shows the sum of all LLM Observability 60-day retention spans over all hours in the current month for all organizations. format: int64 type: integer llm_observability_90day_retention_spans_agg_sum: description: Shows the sum of all LLM Observability 90-day retention spans over all hours in the current month for all organizations. format: int64 type: integer llm_observability_agg_sum: description: Sum of all LLM observability sessions for all hours in the current month for all organizations. format: int64 type: integer llm_observability_min_spend_agg_sum: description: Minimum spend for LLM observability sessions for all hours in the current month for all organizations. format: int64 type: integer logs_archive_search_gb_scanned_agg_sum: description: Shows the sum of all Logs Archive Search scanned data over all hours in the current month for all organizations. format: int64 type: integer logs_by_retention: $ref: "#/components/schemas/LogsByRetention" metric_names_agg_sum: description: Shows the sum of all custom metric names over all hours in the current month for all organizations. format: int64 type: integer mobile_rum_lite_session_count_agg_sum: deprecated: true description: Shows the sum of all mobile lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_agg_sum: deprecated: true description: Shows the sum of all mobile RUM sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_android_agg_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Android over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_flutter_agg_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_ios_agg_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on iOS over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_reactnative_agg_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on React Native over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_roku_agg_sum: deprecated: true description: Shows the sum of all mobile RUM sessions on Roku over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_units_agg_sum: deprecated: true description: Shows the sum of all mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ndm_netflow_events_agg_sum: description: Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current month for all organizations. format: int64 type: integer netflow_indexed_events_count_agg_sum: deprecated: true description: Shows the sum of all Network flows indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer network_device_wireless_top99p_sum: description: Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current month for all organizations. format: int64 type: integer network_path_agg_sum: description: Shows the sum of all Network Path scheduled tests over all hours in the current month for all organizations. format: int64 type: integer npm_host_top99p_sum: description: Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current month for all organizations. format: int64 type: integer observability_pipelines_bytes_processed_agg_sum: description: Sum of all observability pipelines bytes processed over all hours in the current month for all organizations. format: int64 type: integer oci_host_agg_sum: description: Shows the sum of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations format: int64 type: integer oci_host_top99p_sum: description: Shows the 99th percentile of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations format: int64 type: integer on_call_seat_hwm_sum: description: Shows the sum of the high-water marks of On-Call seats over all hours in the current month for all organizations. format: int64 type: integer online_archive_events_count_agg_sum: description: Sum of all online archived events over all hours in the current month for all organizations. format: int64 type: integer opentelemetry_apm_host_top99p_sum: description: Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer opentelemetry_host_top99p_sum: description: Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer product_analytics_agg_sum: description: Sum of all product analytics sessions for all hours in the current month for all organizations. format: int64 type: integer profiling_aas_count_top99p_sum: description: Shows the 99th percentile of all profiled Azure app services over all hours in the current month for all organizations. format: int64 type: integer profiling_container_agent_count_avg: description: Shows the average number of profiled containers over all hours in the current month for all organizations. format: int64 type: integer profiling_host_count_top99p_sum: description: Shows the 99th percentile of all profiled hosts over all hours in the current month for all organizations. format: int64 type: integer proxmox_host_agg_sum: description: Sum of all Proxmox hosts over all hours in the current month for all organizations. format: int64 type: integer proxmox_host_top99p_sum: description: Sum of the 99th percentile of all Proxmox hosts over all hours in the current month for all organizations. format: int64 type: integer published_app_hwm_sum: description: Shows the high-water mark of all published applications over all hours in the current month for all organizations. format: int64 type: integer rehydrated_indexed_events_agg_sum: deprecated: true description: Shows the sum of all rehydrated logs indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rehydrated_ingested_bytes_agg_sum: description: Shows the sum of all rehydrated logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020). format: int64 type: integer rum_browser_and_mobile_session_count: description: Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_browser_legacy_session_count_agg_sum: description: Shows the sum of all browser RUM legacy sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_lite_session_count_agg_sum: description: Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_replay_session_count_agg_sum: description: Shows the sum of all browser RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_indexed_sessions_agg_sum: description: Sum of all RUM indexed sessions for all hours in the current month for all organizations. format: int64 type: integer rum_ingested_sessions_agg_sum: description: Sum of all RUM ingested sessions for all hours in the current month for all organizations. format: int64 type: integer rum_lite_session_count_agg_sum: description: Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_android_agg_sum: description: Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_flutter_agg_sum: description: Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_ios_agg_sum: description: Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_reactnative_agg_sum: description: Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_roku_agg_sum: description: Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_android_agg_sum: description: Shows the sum of all mobile RUM lite sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_flutter_agg_sum: description: Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_ios_agg_sum: description: Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_kotlinmultiplatform_agg_sum: description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_lite_session_count_reactnative_agg_sum: description: Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_roku_agg_sum: description: Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_unity_agg_sum: description: Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_android_agg_sum: description: Shows the sum of all mobile RUM replay sessions on Android over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_ios_agg_sum: description: Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_kotlinmultiplatform_agg_sum: description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_reactnative_agg_sum: description: Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current month for all organizations. format: int64 type: integer rum_replay_session_count_agg_sum: description: Shows the sum of all RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_session_count_agg_sum: deprecated: true description: Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_session_replay_add_on_agg_sum: description: Sum of all RUM session replay add-on sessions for all hours in the current month for all organizations. format: int64 type: integer rum_total_session_count_agg_sum: description: Shows the sum of RUM sessions (browser and mobile) over all hours in the current month for all organizations. format: int64 type: integer rum_units_agg_sum: deprecated: true description: Shows the sum of all browser and mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer sca_fargate_count_avg_sum: description: Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations. format: int64 type: integer sca_fargate_count_hwm_sum: description: Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations. format: int64 type: integer sds_apm_scanned_bytes_sum: description: Sum of all APM bytes scanned with sensitive data scanner in the current month for all organizations. format: int64 type: integer sds_events_scanned_bytes_sum: description: Sum of all event stream events bytes scanned with sensitive data scanner in the current month for all organizations. format: int64 type: integer sds_logs_scanned_bytes_sum: description: Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer sds_rum_scanned_bytes_sum: description: Sum of all RUM bytes scanned with sensitive data scanner in the current month for all organizations. format: int64 type: integer sds_total_scanned_bytes_sum: description: Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_appservice_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_azurefunction_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_containerapp_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_fargate_ecs_tasks_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudfunction_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudrun_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_gke_autopilot_pods_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Kubernetes Engine Autopilot pods in the current month for all organizations. format: int64 type: integer serverless_apps_apm_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_gke_autopilot_pods_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Kubernetes Engine Autopilot pods in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_avg_sum: description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate in the current month for all organizations. format: int64 type: integer serverless_apps_azure_container_app_instances_avg_sum: description: Sum of the average number of Serverless Apps for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_azure_count_avg_sum: description: Sum of the average number of Serverless Apps for Azure in the current month for all organizations. format: int64 type: integer serverless_apps_azure_function_app_instances_avg_sum: description: Sum of the average number of Serverless Apps for Azure Function App instances in the current month for all organizations. format: int64 type: integer serverless_apps_azure_web_app_instances_avg_sum: description: Sum of the average number of Serverless Apps for Azure Web App instances in the current month for all organizations. format: int64 type: integer serverless_apps_dsm_fargate_tasks_avg_sum: description: Sum of the average number of DSM Fargate ECS tasks monitored under Serverless Apps DSM in the current month for all organizations. format: int64 type: integer serverless_apps_ecs_avg_sum: description: Sum of the average number of Serverless Apps for Elastic Container Service in the current month for all organizations. format: int64 type: integer serverless_apps_eks_avg_sum: description: Sum of the average number of Serverless Apps for Elastic Kubernetes Service in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_container_app_instances_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_function_app_instances_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate for Azure Function App instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_web_app_instances_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate for Azure Web App instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_functions_instances_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_run_instances_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_infra_gcp_gke_autopilot_pods_avg_sum: description: Sum of the average number of Serverless Apps excluding Fargate for Google Kubernetes Engine Autopilot pods in the current month for all organizations. format: int64 type: integer serverless_apps_google_cloud_functions_instances_avg_sum: description: Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances in the current month for all organizations. format: int64 type: integer serverless_apps_google_cloud_run_instances_avg_sum: description: Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_google_count_avg_sum: description: Sum of the average number of Serverless Apps for Google Cloud in the current month for all organizations. format: int64 type: integer serverless_apps_infra_gcp_gke_autopilot_pods_avg_sum: description: Sum of the average number of Serverless Apps for Google Kubernetes Engine Autopilot pods in the current month for all organizations. format: int64 type: integer serverless_apps_total_count_avg_sum: description: Sum of the average number of Serverless Apps for Azure and Google Cloud in the current month for all organizations. format: int64 type: integer siem_12mo_retention_agg_sum: description: Shows the sum of Cloud SIEM Indexed Logs (12-month retention) over all hours in the current month for all organizations. format: int64 type: integer siem_6mo_retention_agg_sum: description: Shows the sum of Cloud SIEM Indexed Logs (6-month retention) over all hours in the current month for all organizations. format: int64 type: integer siem_analyzed_logs_add_on_count_agg_sum: description: Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current month for all organizations. format: int64 type: integer snmp_device_count_agg_sum: description: Shows the sum of all Network Device Monitoring devices over all hours in the current month for all organizations. format: int64 type: integer snmp_device_count_top99p_sum: description: Shows the 99th percentile of all Network Device Monitoring devices over all hours in the current month for all organizations. format: int64 type: integer start_date: description: Shows the first date of usage in the current month for all organizations. format: date-time type: string synthetics_browser_check_calls_count_agg_sum: description: Shows the sum of all Synthetic browser tests over all hours in the current month for all organizations. format: int64 type: integer synthetics_check_calls_count_agg_sum: description: Shows the sum of all Synthetic API tests over all hours in the current month for all organizations. format: int64 type: integer synthetics_mobile_test_runs_agg_sum: description: Shows the sum of Synthetic mobile application tests over all hours in the current month for all organizations. format: int64 type: integer synthetics_parallel_testing_max_slots_hwm_sum: description: Shows the sum of the high-water marks of used synthetics parallel testing slots over all hours in the current month for all organizations. format: int64 type: integer trace_search_indexed_events_count_agg_sum: description: Shows the sum of all Indexed Spans indexed over all hours in the current month for all organizations. format: int64 type: integer twol_ingested_events_bytes_agg_sum: description: Shows the sum of all ingested APM span bytes over all hours in the current month for all organizations. format: int64 type: integer universal_service_monitoring_host_top99p_sum: description: Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current month for all organizations. format: int64 type: integer usage: description: An array of objects regarding hourly usage. items: $ref: "#/components/schemas/UsageSummaryDate" type: array vsphere_host_top99p_sum: description: Shows the 99th percentile of all vSphere hosts over all hours in the current month for all organizations. format: int64 type: integer vuln_management_host_count_top99p_sum: description: Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current month for all organizations. format: int64 type: integer workflow_executions_usage_agg_sum: description: Sum of all workflows executed over all hours in the current month for all organizations. format: int64 type: integer type: object UsageSyntheticsAPIHour: description: Number of Synthetics API tests run for each hour for a given organization. properties: check_calls_count: description: Contains the number of Synthetics API tests run. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageSyntheticsAPIResponse: description: Response containing the number of Synthetics API tests run for each hour for a given organization. properties: usage: description: Get hourly usage for Synthetics API tests. items: $ref: "#/components/schemas/UsageSyntheticsAPIHour" type: array type: object UsageSyntheticsBrowserHour: description: Number of Synthetics Browser tests run for each hour for a given organization. properties: browser_check_calls_count: description: Contains the number of Synthetics Browser tests run. format: int64 nullable: true type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageSyntheticsBrowserResponse: description: Response containing the number of Synthetics Browser tests run for each hour for a given organization. properties: usage: description: Get hourly usage for Synthetics Browser tests. items: $ref: "#/components/schemas/UsageSyntheticsBrowserHour" type: array type: object UsageSyntheticsHour: description: The number of synthetics tests run for each hour for a given organization. properties: check_calls_count: description: Contains the number of Synthetics API tests run. format: int64 type: integer hour: description: The hour for the usage. format: date-time type: string org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageSyntheticsResponse: description: Response containing the number of Synthetics API tests run for each hour for a given organization. properties: usage: description: Array with the number of hourly Synthetics test run for a given organization. items: $ref: "#/components/schemas/UsageSyntheticsHour" type: array type: object UsageTimeseriesHour: description: The hourly usage of timeseries. properties: hour: description: The hour for the usage. format: date-time type: string num_custom_input_timeseries: description: Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). format: int64 type: integer num_custom_output_timeseries: description: Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). format: int64 type: integer num_custom_timeseries: description: Contains sum of non-aggregation custom metrics and custom metrics that are outputs for aggregations. format: int64 type: integer org_name: description: The organization name. type: string public_id: description: The organization public ID. type: string type: object UsageTimeseriesResponse: description: Response containing hourly usage of timeseries. properties: usage: description: An array of objects regarding hourly usage of timeseries. items: $ref: "#/components/schemas/UsageTimeseriesHour" type: array type: object UsageTopAvgMetricsHour: description: Number of hourly recorded custom metrics for a given organization. properties: avg_metric_hour: description: Average number of timeseries per hour in which the metric occurs. format: int64 type: integer max_metric_hour: description: Maximum number of timeseries per hour in which the metric occurs. format: int64 type: integer metric_category: $ref: "#/components/schemas/UsageMetricCategory" metric_name: description: Contains the custom metric name. type: string type: object UsageTopAvgMetricsMetadata: description: The object containing document metadata. properties: day: description: The day value from the user request that contains the returned usage data. (If day was used the request) format: date-time type: string month: description: The month value from the user request that contains the returned usage data. (If month was used the request) format: date-time type: string pagination: $ref: "#/components/schemas/UsageTopAvgMetricsPagination" type: object UsageTopAvgMetricsPagination: description: The metadata for the current pagination. properties: limit: description: Maximum amount of records to be returned. format: int64 type: integer 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 total_number_of_records: description: Total number of records. format: int64 nullable: true type: integer type: object UsageTopAvgMetricsResponse: description: Response containing the number of hourly recorded custom metrics for a given organization. properties: metadata: $ref: "#/components/schemas/UsageTopAvgMetricsMetadata" usage: description: Number of hourly recorded custom metrics for a given organization. items: $ref: "#/components/schemas/UsageTopAvgMetricsHour" type: array type: object User: description: Create, edit, and disable users. properties: access_role: $ref: "#/components/schemas/AccessRole" disabled: description: The new disabled status of the user. example: false type: boolean email: description: The new email of the user. example: test@datadoghq.com type: string handle: description: The user handle, must be a valid email. example: test@datadoghq.com type: string icon: description: Gravatar icon associated to the user. example: /path/to/matching/gravatar/icon readOnly: true type: string name: description: The name of the user. example: test user type: string verified: description: Whether or not the user logged in Datadog at least once. example: true readOnly: true type: boolean type: object UserDisableResponse: description: Array of user disabled for a given organization. properties: message: description: Information pertaining to a user disabled for a given organization. type: string type: object UserJourneyFormulaCompute: additionalProperties: false description: Compute configuration for User Journey formula queries. properties: aggregation: $ref: "#/components/schemas/FormulaAndFunctionEventAggregation" interval: description: Time bucket interval in milliseconds for time series queries. example: 60000 format: double type: number metric: $ref: "#/components/schemas/UserJourneyFormulaComputeMetric" target: $ref: "#/components/schemas/UserJourneySearchTarget" required: - aggregation type: object UserJourneyFormulaComputeMetric: description: Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. enum: - __dd.conversion - __dd.conversion_rate - __dd.time_to_convert example: __dd.conversion_rate type: string x-enum-varnames: - CONVERSION - CONVERSION_RATE - TIME_TO_CONVERT UserJourneyFormulaGroupBy: description: Group by configuration for User Journey formula queries. properties: facet: description: Facet name to group by. example: "@usr.email" type: string limit: description: Maximum number of groups to return. example: 10 format: int32 maximum: 10000 type: integer should_exclude_missing: description: Whether to exclude events missing the group-by facet. type: boolean sort: $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort" target: $ref: "#/components/schemas/UserJourneySearchTarget" required: - facet type: object UserJourneyJoinKeys: description: Join keys for user journey queries. properties: primary: description: Primary join key. example: "@session.id" type: string secondary: description: Secondary join keys. items: description: A secondary join key. type: string type: array required: - primary type: object UserJourneySearch: additionalProperties: false description: User journey search configuration. properties: expression: description: Expression string. example: "node_0 -> node_1" type: string filters: $ref: "#/components/schemas/UserJourneySearchFilters" join_keys: $ref: "#/components/schemas/UserJourneyJoinKeys" node_objects: additionalProperties: $ref: "#/components/schemas/ProductAnalyticsBaseQuery" description: Node objects mapping. type: object step_aliases: additionalProperties: type: string description: Step aliases mapping. type: object required: - node_objects - expression type: object UserJourneySearchFilters: description: Filters for user journey search. properties: audience_filters: $ref: "#/components/schemas/ProductAnalyticsAudienceFilters" graph_filters: description: Graph filters. items: $ref: "#/components/schemas/UserJourneySearchGraphFilter" description: A graph filter for user journey search. type: array string_filter: description: String filter. example: "@session.type:user" type: string type: object UserJourneySearchGraphFilter: description: Graph filter for user journey search. properties: name: description: Filter name. example: "count" type: string operator: description: Filter operator. example: "gt" type: string target: $ref: "#/components/schemas/UserJourneySearchTarget" value: description: Filter value. example: 1 format: int64 type: integer type: object UserJourneySearchTarget: description: Target for user journey search. properties: end: description: End value. example: "node_1" type: string start: description: Start value. example: "node_0" type: string type: description: Target type. example: "step" type: string value: description: Target value. example: "node_0" type: string required: - type type: object UserListResponse: description: Array of Datadog users for a given organization. properties: users: description: Array of users. items: $ref: "#/components/schemas/User" type: array type: object UserResponse: description: A Datadog User. properties: user: $ref: "#/components/schemas/User" type: object Version: description: Version of the updated signal. If server side version is higher, update will be rejected. example: 0 format: int64 type: integer ViewingPreferences: description: The viewing preferences for a shared dashboard. properties: high_density: description: Whether the widgets on the shared dashboard should be displayed with high density. type: boolean theme: $ref: "#/components/schemas/ViewingPreferencesTheme" type: object ViewingPreferencesTheme: description: The theme of the shared dashboard view. "system" follows your system's default viewing theme. enum: - "system" - "light" - "dark" type: string x-enum-varnames: - SYSTEM - LIGHT - DARK WebhooksIntegration: description: Datadog-Webhooks integration. properties: custom_headers: description: |- If `null`, uses no header. If given a JSON payload, these will be headers attached to your webhook. nullable: true type: string encode_as: $ref: "#/components/schemas/WebhooksIntegrationEncoding" name: description: |- The name of the webhook. It corresponds with ``. Learn more on how to use it in [monitor notifications](https://docs.datadoghq.com/monitors/notify). example: WEBHOOK_NAME type: string payload: description: |- If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). nullable: true type: string url: description: URL of the webhook. example: https://example.com/webhook type: string required: - name - url type: object WebhooksIntegrationCustomVariable: description: Custom variable for Webhook integration. properties: is_secret: description: |- Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. example: true type: boolean name: description: The name of the variable. It corresponds with ``. example: CUSTOM_VARIABLE_NAME type: string value: description: Value of the custom variable. example: CUSTOM_VARIABLE_VALUE type: string required: - name - value - is_secret type: object WebhooksIntegrationCustomVariableResponse: description: Custom variable for Webhook integration. properties: is_secret: description: |- Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. example: true type: boolean name: description: The name of the variable. It corresponds with ``. It must only contains upper-case characters, integers or underscores. example: CUSTOM_VARIABLE_NAME type: string value: description: Value of the custom variable. It won't be returned if the variable is secret. example: CUSTOM_VARIABLE_VALUE type: string required: - name - is_secret type: object WebhooksIntegrationCustomVariableUpdateRequest: description: |- Update request of a custom variable object. *All properties are optional.* properties: is_secret: description: |- Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. type: boolean name: description: The name of the variable. It corresponds with ``. It must only contains upper-case characters, integers or underscores. example: CUSTOM_VARIABLE_NAME type: string value: description: Value of the custom variable. example: CUSTOM_VARIABLE_VALUE type: string type: object WebhooksIntegrationEncoding: default: json description: Encoding type. Can be given either `json` or `form`. enum: - json - form type: string x-enum-varnames: - JSON - FORM WebhooksIntegrationUpdateRequest: description: |- Update request of a Webhooks integration object. *All properties are optional.* properties: custom_headers: description: |- If `null`, uses no header. If given a JSON payload, these will be headers attached to your webhook. type: string encode_as: $ref: "#/components/schemas/WebhooksIntegrationEncoding" name: description: |- The name of the webhook. It corresponds with ``. Learn more on how to use it in [monitor notifications](https://docs.datadoghq.com/monitors/notify). example: WEBHOOK_NAME type: string payload: description: |- If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). nullable: true type: string url: description: URL of the webhook. example: https://example.com/webhook type: string type: object Widget: description: |- Information about widget. **Note**: The `layout` property is required for widgets in dashboards with `free` `layout_type`. For the **new dashboard layout**, the `layout` property depends on the `reflow_type` of the dashboard. - If `reflow_type` is `fixed`, `layout` is required. - If `reflow_type` is `auto`, `layout` should not be set. properties: definition: $ref: "#/components/schemas/WidgetDefinition" id: description: ID of the widget. format: int64 type: integer layout: $ref: "#/components/schemas/WidgetLayout" required: - definition type: object WidgetAggregator: description: Aggregator used for the request. enum: - avg - last - max - min - sum - percentile type: string x-enum-varnames: - AVERAGE - LAST - MAXIMUM - MINIMUM - SUM - PERCENTILE WidgetAxis: description: Axis controls for the widget. properties: include_zero: description: Set to `true` to include zero. type: boolean label: description: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. type: string max: default: auto description: Specifies maximum numeric value to show on the axis. Defaults to `auto`. type: string min: default: auto description: Specifies minimum numeric value to show on the axis. Defaults to `auto`. type: string scale: default: linear description: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). type: string type: object WidgetBackgroundColor: description: "Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`." type: string WidgetChangeType: description: Show the absolute or the relative change. enum: - absolute - relative type: string x-enum-varnames: - ABSOLUTE - RELATIVE WidgetColorPreference: description: Which color to use on the widget. enum: - background - text type: string x-enum-varnames: - BACKGROUND - TEXT WidgetComparator: description: Comparator to apply. enum: - "=" - ">" - ">=" - "<" - "<=" example: ">" type: string x-enum-varnames: - EQUAL_TO - GREATER_THAN - GREATER_THAN_OR_EQUAL_TO - LESS_THAN - LESS_THAN_OR_EQUAL_TO WidgetCompareTo: description: Timeframe used for the change comparison. enum: - hour_before - day_before - week_before - month_before type: string x-enum-varnames: - HOUR_BEFORE - DAY_BEFORE - WEEK_BEFORE - MONTH_BEFORE WidgetConditionalFormat: description: Define a conditional format for the widget. properties: comparator: $ref: "#/components/schemas/WidgetComparator" custom_bg_color: description: Color palette to apply to the background, same values available as palette. type: string custom_fg_color: description: Color palette to apply to the foreground, same values available as palette. type: string hide_value: description: True hides values. type: boolean image_url: description: Displays an image as the background. type: string metric: description: Metric from the request to correlate this conditional format with. type: string palette: $ref: "#/components/schemas/WidgetPalette" timeframe: description: Defines the displayed timeframe. type: string value: description: Value for the comparator. example: 0.0 format: double type: number required: - comparator - value - palette type: object WidgetCustomLink: description: Custom links help you connect a data value to a URL, like a Datadog page or your AWS console. properties: is_hidden: description: The flag for toggling context menu link visibility. type: boolean label: description: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. example: "Search logs for {{host}}" type: string link: description: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. example: "https://app.datadoghq.com/logs?query={{host}}" type: string override_label: description: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. example: "logs" type: string type: object WidgetDefinition: description: >- [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). oneOf: - $ref: "#/components/schemas/AlertGraphWidgetDefinition" - $ref: "#/components/schemas/AlertValueWidgetDefinition" - $ref: "#/components/schemas/BarChartWidgetDefinition" - $ref: "#/components/schemas/ChangeWidgetDefinition" - $ref: "#/components/schemas/CheckStatusWidgetDefinition" - $ref: "#/components/schemas/CohortWidgetDefinition" - $ref: "#/components/schemas/DistributionWidgetDefinition" - $ref: "#/components/schemas/EventStreamWidgetDefinition" - $ref: "#/components/schemas/EventTimelineWidgetDefinition" - $ref: "#/components/schemas/FreeTextWidgetDefinition" - $ref: "#/components/schemas/FunnelWidgetDefinition" - $ref: "#/components/schemas/ProductAnalyticsFunnelWidgetDefinition" - $ref: "#/components/schemas/GeomapWidgetDefinition" - $ref: "#/components/schemas/GroupWidgetDefinition" - $ref: "#/components/schemas/HeatMapWidgetDefinition" - $ref: "#/components/schemas/HostMapWidgetDefinition" - $ref: "#/components/schemas/IFrameWidgetDefinition" - $ref: "#/components/schemas/ImageWidgetDefinition" - $ref: "#/components/schemas/ListStreamWidgetDefinition" - $ref: "#/components/schemas/LogStreamWidgetDefinition" - $ref: "#/components/schemas/MonitorSummaryWidgetDefinition" - $ref: "#/components/schemas/NoteWidgetDefinition" - $ref: "#/components/schemas/PowerpackWidgetDefinition" - $ref: "#/components/schemas/PointPlotWidgetDefinition" - $ref: "#/components/schemas/QueryValueWidgetDefinition" - $ref: "#/components/schemas/RetentionCurveWidgetDefinition" - $ref: "#/components/schemas/RunWorkflowWidgetDefinition" - $ref: "#/components/schemas/SLOListWidgetDefinition" - $ref: "#/components/schemas/SLOWidgetDefinition" - $ref: "#/components/schemas/ScatterPlotWidgetDefinition" - $ref: "#/components/schemas/SankeyWidgetDefinition" - $ref: "#/components/schemas/ServiceMapWidgetDefinition" - $ref: "#/components/schemas/ServiceSummaryWidgetDefinition" - $ref: "#/components/schemas/SplitGraphWidgetDefinition" - $ref: "#/components/schemas/SunburstWidgetDefinition" - $ref: "#/components/schemas/TableWidgetDefinition" - $ref: "#/components/schemas/TimeseriesWidgetDefinition" - $ref: "#/components/schemas/ToplistWidgetDefinition" - $ref: "#/components/schemas/TopologyMapWidgetDefinition" - $ref: "#/components/schemas/TreeMapWidgetDefinition" - $ref: "#/components/schemas/WildcardWidgetDefinition" WidgetDisplayType: description: Type of display to use for the request. enum: - area - bars - line - overlay type: string x-enum-varnames: - AREA - BARS - LINE - OVERLAY WidgetEvent: deprecated: true description: |- Event overlay control options. See the dedicated [Events JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/widget_json/#events-schema) to learn how to build the ``. properties: q: description: Query definition. example: "" type: string tags_execution: description: The execution method for multi-value filters. type: string required: - q type: object WidgetEventSize: description: Size to use to display an event. enum: - s - l type: string x-enum-varnames: - SMALL - LARGE WidgetFieldSort: description: Which column and order to sort by properties: column: description: Facet path for the column example: "" type: string order: $ref: "#/components/schemas/WidgetSort" required: - column - order type: object WidgetFormula: description: Formula to be used in a widget query. properties: alias: description: Expression alias. type: string cell_display_mode: $ref: "#/components/schemas/TableWidgetCellDisplayMode" cell_display_mode_options: $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptions" conditional_formats: description: List of conditional formats. items: $ref: "#/components/schemas/WidgetConditionalFormat" type: array formula: description: String expression built from queries, formulas, and functions. example: "func(a) + b" type: string limit: $ref: "#/components/schemas/WidgetFormulaLimit" number_format: $ref: "#/components/schemas/WidgetNumberFormat" style: $ref: "#/components/schemas/WidgetFormulaStyle" required: - formula type: object WidgetFormulaCellDisplayModeOptions: description: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). properties: trend_type: $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptionsTrendType" y_scale: $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptionsYScale" type: object WidgetFormulaCellDisplayModeOptionsTrendType: description: Trend type for the cell display mode options. enum: - area - line - bars example: area type: string x-enum-varnames: - AREA - LINE - BARS WidgetFormulaCellDisplayModeOptionsYScale: description: Y scale for the cell display mode options. enum: - shared - independent example: shared type: string x-enum-varnames: - SHARED - INDEPENDENT WidgetFormulaLimit: description: Options for limiting results returned. properties: count: description: Number of results to return. format: int64 type: integer order: $ref: "#/components/schemas/QuerySortOrder" type: object WidgetFormulaSort: description: The formula to sort the widget by. properties: index: description: The index of the formula to sort by. example: 0 format: int64 minimum: 0 type: integer order: $ref: "#/components/schemas/WidgetSort" type: $ref: "#/components/schemas/FormulaType" required: ["type", "index", "order"] type: object WidgetFormulaStyle: description: Styling options for widget formulas. properties: palette: description: The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors example: "classic" type: string palette_index: description: Index specifying which color to use within the palette. example: 1 format: int64 type: integer type: object WidgetGroupSort: description: The group to sort the widget by. properties: name: description: The name of the group. example: "group_name" type: string order: $ref: "#/components/schemas/WidgetSort" type: $ref: "#/components/schemas/GroupType" required: ["type", "name", "order"] type: object WidgetGrouping: description: The kind of grouping to use. enum: - check - cluster example: check type: string x-enum-varnames: - CHECK - CLUSTER WidgetHistogramRequestType: description: Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:` for points distributions. enum: - histogram example: histogram type: string x-enum-varnames: - HISTOGRAM WidgetHorizontalAlign: description: Horizontal alignment. enum: - center - left - right type: string x-enum-varnames: - CENTER - LEFT - RIGHT WidgetImageSizing: description: |- How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note**: `zoom`, `fit` and `center` values are deprecated. enum: - fill - contain - cover - none - scale-down - zoom - fit - center type: string x-enum-varnames: - FILL - CONTAIN - COVER - NONE - SCALEDOWN - ZOOM - FIT - CENTER WidgetLayout: description: The layout for a widget on a `free` or **new dashboard layout** dashboard. properties: height: description: The height of the widget. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer is_column_break: description: |- Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. type: boolean width: description: The width of the widget. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer x: description: The position of the widget on the x (horizontal) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer y: description: The position of the widget on the y (vertical) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer required: - x - y - width - height type: object WidgetLayoutType: description: Layout type of the group. enum: - ordered example: ordered type: string x-enum-varnames: - ORDERED WidgetLegacyLiveSpan: additionalProperties: false description: Wrapper for live span properties: hide_incomplete_cost_data: description: Whether to hide incomplete cost data in the widget. type: boolean live_span: $ref: "#/components/schemas/WidgetLiveSpan" type: object WidgetLegendSize: description: Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". type: string WidgetLineType: description: Type of lines displayed. enum: - dashed - dotted - solid type: string x-enum-varnames: - DASHED - DOTTED - SOLID WidgetLineWidth: description: Width of line displayed. enum: - normal - thick - thin type: string x-enum-varnames: - NORMAL - THICK - THIN WidgetLiveSpan: description: The available timeframes depend on the widget you are using. enum: - 1m - 5m - 10m - 15m - 30m - 1h - 4h - 1d - 2d - 1w - 1mo - 3mo - 6mo - week_to_date - month_to_date - 1y - alert example: 5m type: string x-enum-varnames: - PAST_ONE_MINUTE - PAST_FIVE_MINUTES - PAST_TEN_MINUTES - PAST_FIFTEEN_MINUTES - PAST_THIRTY_MINUTES - PAST_ONE_HOUR - PAST_FOUR_HOURS - PAST_ONE_DAY - PAST_TWO_DAYS - PAST_ONE_WEEK - PAST_ONE_MONTH - PAST_THREE_MONTHS - PAST_SIX_MONTHS - WEEK_TO_DATE - MONTH_TO_DATE - PAST_ONE_YEAR - ALERT WidgetLiveSpanUnit: description: Unit of the time span. enum: - minute - hour - day - week - month - year example: minute type: string x-enum-varnames: - MINUTE - HOUR - DAY - WEEK - MONTH - YEAR WidgetMargin: description: |- Size of the margins around the image. **Note**: `small` and `large` values are deprecated. enum: - sm - md - lg - small - large type: string x-enum-varnames: - SM - MD - LG - SMALL - LARGE WidgetMarker: description: Markers allow you to add visual conditional formatting for your graphs. properties: display_type: description: |- Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. example: "error dashed" type: string label: description: Label to display over the marker. example: "Error threshold" type: string time: description: Timestamp for the widget. type: string value: description: |- Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90). example: "y = 15" type: string required: - value type: object WidgetMessageDisplay: description: Amount of log lines to display enum: - inline - expanded-md - expanded-lg type: string x-enum-varnames: - INLINE - EXPANDED_MEDIUM - EXPANDED_LARGE WidgetMonitorSummaryDisplayFormat: description: What to display on the widget. enum: - counts - countsAndList - list type: string x-enum-varnames: - COUNTS - COUNTS_AND_LIST - LIST WidgetMonitorSummarySort: description: Widget sorting methods. enum: - name - group - status - tags - triggered - "group,asc" - "group,desc" - "name,asc" - "name,desc" - "status,asc" - "status,desc" - "tags,asc" - "tags,desc" - "triggered,asc" - "triggered,desc" - "priority,asc" - "priority,desc" example: name,asc type: string x-enum-varnames: - NAME - GROUP - STATUS - TAGS - TRIGGERED - GROUP_ASCENDING - GROUP_DESCENDING - NAME_ASCENDING - NAME_DESCENDING - STATUS_ASCENDING - STATUS_DESCENDING - TAGS_ASCENDING - TAGS_DESCENDING - TRIGGERED_ASCENDING - TRIGGERED_DESCENDING - PRIORITY_ASCENDING - PRIORITY_DESCENDING WidgetNewFixedSpan: description: Used for fixed span times, such as 'March 1 to March 7'. properties: from: description: Start time in milliseconds since epoch. example: 1712080128000 format: int64 minimum: 0 type: integer hide_incomplete_cost_data: description: Whether to hide incomplete cost data in the widget. type: boolean to: description: End time in milliseconds since epoch. example: 1712083128000 format: int64 minimum: 0 type: integer type: $ref: "#/components/schemas/WidgetNewFixedSpanType" required: - type - from - to type: object WidgetNewFixedSpanType: description: Type "fixed" denotes a fixed span. enum: ["fixed"] example: "fixed" type: string x-enum-varnames: - FIXED WidgetNewLiveSpan: description: Used for arbitrary live span times, such as 17 minutes or 6 hours. properties: hide_incomplete_cost_data: description: Whether to hide incomplete cost data in the widget. type: boolean type: $ref: "#/components/schemas/WidgetNewLiveSpanType" unit: $ref: "#/components/schemas/WidgetLiveSpanUnit" value: description: Value of the time span. example: 4 format: int64 minimum: 1 type: integer required: - type - value - unit type: object WidgetNewLiveSpanType: description: Type "live" denotes a live span in the new format. enum: ["live"] example: "live" type: string x-enum-varnames: - LIVE WidgetNodeType: description: Which type of node to use in the map. enum: - host - container type: string x-enum-varnames: - HOST - CONTAINER WidgetNumberFormat: description: Number format options for the widget. properties: unit: $ref: "#/components/schemas/NumberFormatUnit" unit_scale: $ref: "#/components/schemas/NumberFormatUnitScale" type: object WidgetOrderBy: description: What to order by. enum: - change - name - present - past type: string x-enum-varnames: - CHANGE - NAME - PRESENT - PAST WidgetPalette: description: Color palette to apply. enum: - blue - custom_bg - custom_image - custom_text - gray_on_white - grey - green - orange - red - red_on_white - white_on_gray - white_on_green - green_on_white - white_on_red - white_on_yellow - yellow_on_white - black_on_light_yellow - black_on_light_green - black_on_light_red example: blue type: string x-enum-varnames: - BLUE - CUSTOM_BACKGROUND - CUSTOM_IMAGE - CUSTOM_TEXT - GRAY_ON_WHITE - GREY - GREEN - ORANGE - RED - RED_ON_WHITE - WHITE_ON_GRAY - WHITE_ON_GREEN - GREEN_ON_WHITE - WHITE_ON_RED - WHITE_ON_YELLOW - YELLOW_ON_WHITE - BLACK_ON_LIGHT_YELLOW - BLACK_ON_LIGHT_GREEN - BLACK_ON_LIGHT_RED WidgetRequestStyle: description: Define request widget style. properties: line_type: $ref: "#/components/schemas/WidgetLineType" line_width: $ref: "#/components/schemas/WidgetLineWidth" order_by: $ref: "#/components/schemas/WidgetStyleOrderBy" palette: description: Color palette to apply to the widget. type: string type: object WidgetServiceSummaryDisplayFormat: description: Number of columns to display. enum: - one_column - two_column - three_column type: string x-enum-varnames: - ONE_COLUMN - TWO_COLUMN - THREE_COLUMN WidgetSizeFormat: description: Size of the widget. enum: - small - medium - large type: string x-enum-varnames: - SMALL - MEDIUM - LARGE WidgetSort: description: Widget sorting methods. enum: - asc - desc example: desc type: string x-enum-varnames: - ASCENDING - DESCENDING WidgetSortBy: description: The controls for sorting the widget. properties: count: description: The number of items to limit the widget to. format: int64 minimum: 0 type: integer order_by: description: The array of items to sort the widget by in order. items: $ref: "#/components/schemas/WidgetSortOrderBy" type: array type: object WidgetSortOrderBy: description: "The item to sort the widget by." oneOf: - $ref: "#/components/schemas/WidgetFormulaSort" - $ref: "#/components/schemas/WidgetGroupSort" WidgetStyle: description: Widget style definition. properties: palette: description: Color palette to apply to the widget. type: string type: object WidgetStyleOrderBy: description: |- How to order series in timeseries visualizations. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) enum: - tags - values type: string x-enum-varnames: - TAGS - VALUES WidgetSummaryType: description: Which summary type should be used. enum: - monitors - groups - combined type: string x-enum-varnames: - MONITORS - GROUPS - COMBINED WidgetTextAlign: description: How to align the text on the widget. enum: - center - left - right type: string x-enum-varnames: - CENTER - LEFT - RIGHT WidgetTickEdge: description: Define how you want to align the text on the widget. enum: - bottom - left - right - top type: string x-enum-varnames: - BOTTOM - LEFT - RIGHT - TOP WidgetTime: description: Time setting for the widget. oneOf: - $ref: "#/components/schemas/WidgetLegacyLiveSpan" - $ref: "#/components/schemas/WidgetNewLiveSpan" - $ref: "#/components/schemas/WidgetNewFixedSpan" WidgetTimeWindows: description: Define a time window. enum: - 7d - 30d - 90d - week_to_date - previous_week - month_to_date - previous_month - global_time type: string x-enum-varnames: - SEVEN_DAYS - THIRTY_DAYS - NINETY_DAYS - WEEK_TO_DATE - PREVIOUS_WEEK - MONTH_TO_DATE - PREVIOUS_MONTH - GLOBAL_TIME WidgetVerticalAlign: description: Vertical alignment. enum: - center - top - bottom type: string x-enum-varnames: - CENTER - TOP - BOTTOM WidgetViewMode: description: Define how you want the SLO to be displayed. enum: - overall - component - both type: string x-enum-varnames: - OVERALL - COMPONENT - BOTH WidgetVizType: description: Whether to display the Alert Graph as a timeseries or a top list. enum: - timeseries - toplist example: timeseries type: string x-enum-varnames: - TIMESERIES - TOPLIST WildcardWidgetDefinition: description: >- Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations. properties: custom_links: description: List of custom links. items: $ref: "#/components/schemas/WidgetCustomLink" type: array requests: description: List of data requests for the wildcard widget. example: [{"formulas": ["formula": "query1"], "queries": [{"aggregator": "avg", "data_source": "metrics", "name": "query1", "query": "avg:system.cpu.user{*} by {env}"}], "response_format": "scalar"}] items: $ref: "#/components/schemas/WildcardWidgetRequest" type: array specification: $ref: "#/components/schemas/WildcardWidgetSpecification" time: $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: $ref: "#/components/schemas/WildcardWidgetDefinitionType" required: - type - requests - specification type: object WildcardWidgetDefinitionType: default: wildcard description: Type of the wildcard widget. enum: - wildcard example: wildcard type: string x-enum-varnames: - WILDCARD WildcardWidgetRequest: description: >- Request object for the wildcard widget. Each variant represents a distinct data-fetching pattern: scalar formulas, timeseries formulas, list streams, and histograms. oneOf: - $ref: "#/components/schemas/TreeMapWidgetRequest" - $ref: "#/components/schemas/TimeseriesWidgetRequest" - $ref: "#/components/schemas/ListStreamWidgetRequest" - $ref: "#/components/schemas/DistributionWidgetRequest" WildcardWidgetSpecification: description: >- Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference. properties: contents: description: The Vega or Vega-Lite JSON specification object. example: {"$schema": "https://vega.github.io/schema/vega-lite/v5.json", "data": {"name": "table1"}, "description": "A simple bar chart", "encoding": {"x": {"field": "env", "sort": "-y", "type": "nominal"}, "y": {"field": "query1", "type": "quantitative"}}, "mark": "bar"} type: object type: $ref: "#/components/schemas/WildcardWidgetSpecificationType" required: - type - contents type: object WildcardWidgetSpecificationType: description: Type of specification used by the wildcard widget. enum: - vega - vega-lite example: vega-lite type: string x-enum-varnames: - VEGA - VEGA_LITE 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. billing_read: View your organization's billing information. 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). coterm_read: Read terminal recordings. coterm_write: Write terminal recordings. 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. 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_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 apiKeyAuthQuery: description: Deprecated API Key as query argument. in: query name: api_key type: apiKey x-auth-id-alias: apiKeyAuth 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 appKeyAuthQuery: description: Deprecated APP Key as query argument. in: query name: application_key type: apiKey x-auth-id-alias: appKeyAuth x-env-name: DD_APP_KEY bearerAuth: scheme: bearer type: http x-env-name: DD_BEARER_TOKEN info: contact: email: support@datadoghq.com name: Datadog Support url: https://www.datadoghq.com/support/ description: Collection of all Datadog Public endpoints. title: Datadog API V1 Collection version: "1.0" openapi: 3.0.0 paths: /: get: description: Get information about Datadog IP ranges. operationId: GetIPRanges responses: "200": content: application/json: examples: default: value: agents: prefixes_ipv4: - "1.2.3.4/32" prefixes_ipv6: [] api: prefixes_ipv4: - "1.2.3.4/32" prefixes_ipv6: [] apm: prefixes_ipv4: - "1.2.3.4/32" prefixes_ipv6: [] logs: prefixes_ipv4: - "1.2.3.4/32" prefixes_ipv6: [] modified: "2019-10-31-20-00-00" process: prefixes_ipv4: - "1.2.3.4/32" prefixes_ipv6: [] version: 11 webhooks: prefixes_ipv4: - "1.2.3.4/32" prefixes_ipv6: [] schema: $ref: "#/components/schemas/IPRanges" description: OK "429": $ref: "#/components/responses/TooManyRequestsResponse" security: [] 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 - ap2.datadoghq.com - datadoghq.eu - ddog-gov.com - us2.ddog-gov.com x-enum-varnames: - US1 - US3 - US5 - AP1 - AP2 - EU1 - GOV - US2_GOV subdomain: default: ip-ranges description: The subdomain where the API is deployed. - url: "{protocol}://{name}" variables: name: default: ip-ranges.datadoghq.com description: Full site DNS name. protocol: default: https description: The protocol for accessing the API. - url: https://{subdomain}.datadoghq.com variables: subdomain: default: ip-ranges description: The subdomain where the API is deployed. summary: List IP Ranges tags: - IP Ranges /api/v1/api_key: get: description: |- Get all API keys available for your account. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: ListAPIKeys responses: "200": content: application/json: examples: default: value: api_keys: - created: "2024-01-01T00:00:00+00:00" created_by: test@example.com key: abc123example456key789placeholder0 name: app_key schema: $ref: "#/components/schemas/ApiKeyListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all API keys tags: - Key Management "x-permission": operator: OR permissions: - api_keys_read post: description: |- Creates an API key with a given name. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: CreateAPIKey requestBody: content: application/json: examples: default: value: name: example key schema: $ref: "#/components/schemas/ApiKey" required: true responses: "200": content: application/json: examples: default: value: api_key: created: "2024-01-01T00:00:00+00:00" created_by: test@example.com key: abc123example456key789placeholder0 name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an API key tags: - Key Management x-codegen-request-body-name: body "x-permission": operator: OR permissions: - api_keys_write /api/v1/api_key/{key}: delete: description: |- Delete a given API key. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: DeleteAPIKey parameters: - description: The specific API key you are working with. in: path name: key required: true schema: type: string responses: "200": content: application/json: examples: default: value: api_key: created: "2024-01-01T00:00:00+00:00" created_by: test@example.com key: abc123example456key789placeholder0 name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an API key tags: - Key Management "x-permission": operator: OR permissions: - api_keys_delete get: description: |- Get a given API key. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: GetAPIKey parameters: - description: The specific API key you are working with. in: path name: key required: true schema: type: string responses: "200": content: application/json: examples: default: value: api_key: created: "2024-01-01T00:00:00+00:00" created_by: test@example.com key: abc123example456key789placeholder0 name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get API key tags: - Key Management "x-permission": operator: OR permissions: - api_keys_read put: description: |- Edit an API key name. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: UpdateAPIKey parameters: - description: The specific API key you are working with. in: path name: key required: true schema: type: string requestBody: content: application/json: examples: default: value: name: example key schema: $ref: "#/components/schemas/ApiKey" required: true responses: "200": content: application/json: examples: default: value: api_key: created: "2024-01-01T00:00:00+00:00" created_by: test@example.com key: abc123example456key789placeholder0 name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an API key tags: - Key Management x-codegen-request-body-name: body "x-permission": operator: OR permissions: - api_keys_write /api/v1/application_key: get: description: |- Get all application keys available for your Datadog account. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: ListApplicationKeys responses: "200": content: application/json: examples: default: value: application_keys: - hash: 1234512345123459cda4eb9ced49a3d84fd0138c name: app_key owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all application keys tags: - Key Management "x-permission": operator: OR permissions: - org_app_keys_read - user_app_keys post: description: |- Create an application key with a given name. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: CreateApplicationKey requestBody: content: application/json: examples: default: value: name: example key schema: $ref: "#/components/schemas/ApplicationKey" required: true responses: "200": content: application/json: examples: default: value: application_key: hash: 1234512345123459cda4eb9ced49a3d84fd0138c name: app_key owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an application key tags: - Key Management x-codegen-request-body-name: body "x-permission": operator: OR permissions: - user_app_keys /api/v1/application_key/{key}: delete: description: |- Delete a given application key. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: DeleteApplicationKey parameters: - description: The specific APP key you are working with. in: path name: key required: true schema: type: string responses: "200": content: application/json: examples: default: value: application_key: hash: 1234512345123459cda4eb9ced49a3d84fd0138c name: app_key owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an application key tags: - Key Management "x-permission": operator: OR permissions: - org_app_keys_write - user_app_keys get: description: |- Get a given application key. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: GetApplicationKey parameters: - description: The specific APP key you are working with. in: path name: key required: true schema: type: string responses: "200": content: application/json: examples: default: value: application_key: hash: 1234512345123459cda4eb9ced49a3d84fd0138c name: app_key owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an application key tags: - Key Management "x-permission": operator: OR permissions: - org_app_keys_read - user_app_keys put: description: |- Edit an application key name. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead. operationId: UpdateApplicationKey parameters: - description: The specific APP key you are working with. in: path name: key required: true schema: type: string requestBody: content: application/json: examples: default: value: name: example key schema: $ref: "#/components/schemas/ApplicationKey" required: true responses: "200": content: application/json: examples: default: value: application_key: hash: 1234512345123459cda4eb9ced49a3d84fd0138c name: app_key owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an application key tags: - Key Management x-codegen-request-body-name: body "x-permission": operator: OR permissions: - org_app_keys_write - user_app_keys /api/v1/check_run: post: description: |- Submit a list of Service Checks. **Notes**: - A valid API key is required. - Service checks can be submitted up to 10 minutes in the past. operationId: SubmitServiceCheck requestBody: content: application/json: examples: default: value: - check: app.ok host_name: app.host1 message: app is running status: 0 tags: - "environment:test" schema: $ref: "#/components/schemas/ServiceChecks" description: Service Check request body. required: true responses: "202": content: text/json: examples: default: value: status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted "400": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "408": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Request timeout "413": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Payload too large "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] summary: Submit a Service Check tags: - Service Checks x-codegen-request-body-name: body /api/v1/daily_custom_reports: get: deprecated: true description: |- Get daily custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetDailyCustomReports parameters: - description: The number of files to return in the response. `[default=60]`. in: query name: page[size] required: false schema: format: int64 type: integer - description: The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. in: query name: page[number] required: false schema: format: int64 type: integer - description: "The direction to sort by: `[desc, asc]`." in: query name: sort_dir required: false schema: $ref: "#/components/schemas/UsageSortDirection" - description: "The field to sort by: `[computed_on, size, start_date, end_date]`." in: query name: sort required: false schema: $ref: "#/components/schemas/UsageSort" responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: data: - attributes: computed_on: "2024-01-02" end_date: "2024-01-01" size: 1024 start_date: "2024-01-01" tags: - env id: "2024-01-01" type: reports meta: page: total_count: 1 schema: $ref: "#/components/schemas/UsageCustomReportsResponse" description: OK "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 summary: Get the list of available daily custom reports tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/daily_custom_reports/{report_id}: get: deprecated: true description: |- Get specified daily custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetSpecifiedDailyCustomReports parameters: - description: Date of the report in the format `YYYY-MM-DD`. in: path name: report_id required: true schema: type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: data: attributes: computed_on: "2024-01-02" end_date: "2024-01-01" location: "https://example.s3.amazonaws.com/report.csv" size: 1024 start_date: "2024-01-01" tags: - env id: "2024-01-01" type: reports meta: page: total_count: 1 schema: $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse" description: OK "403": content: application/json;datetime-format=rfc3339: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized "404": content: application/json;datetime-format=rfc3339: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": content: application/json;datetime-format=rfc3339: schema: $ref: "#/components/schemas/APIErrorResponse" description: Too many requests summary: Get specified daily custom reports tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/dashboard: delete: description: Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed). operationId: DeleteDashboards requestBody: content: application/json: examples: default: value: data: - id: 123-abc-456 type: dashboard - id: 789-def-101 type: dashboard json-request-body: value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]} schema: $ref: "#/components/schemas/DashboardBulkDeleteRequest" description: Delete dashboards request body. required: true responses: "204": description: No Content "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Dashboards Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Delete dashboards tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_write get: description: |- Get all dashboards. **Note**: This query will only return custom created or cloned dashboards. This query will not return preset dashboards. operationId: ListDashboards parameters: - description: |- When `true`, this query only returns shared custom created or cloned dashboards. in: query name: filter[shared] required: false schema: type: boolean - description: |- When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`. in: query name: filter[deleted] required: false schema: type: boolean - description: The maximum number of dashboards returned in the list. in: query name: count required: false schema: default: 100 format: int64 type: integer - description: The specific offset to use as the beginning of the returned response. in: query name: start required: false schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: dashboards: - author_handle: test@example.com created_at: "2024-01-01T00:00:00+00:00" id: abc-123-def layout_type: ordered modified_at: "2024-01-01T00:00:00+00:00" title: Example Dashboard url: /dashboard/abc-123-def/example-dashboard schema: $ref: "#/components/schemas/DashboardSummary" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_read summary: Get all dashboards tags: - Dashboards x-pagination: limitParam: count pageOffsetParam: start resultsPath: dashboards "x-permission": operator: OR permissions: - dashboards_read patch: description: Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed). operationId: RestoreDashboards requestBody: content: application/json: examples: default: value: data: - id: 123-abc-456 type: dashboard - id: 789-def-101 type: dashboard json-request-body: value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]} schema: $ref: "#/components/schemas/DashboardRestoreRequest" description: Restore dashboards request body. required: true responses: "204": description: No Content "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Dashboards Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Restore deleted dashboards tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_write post: description: |- Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers. operationId: CreateDashboard requestBody: content: application/json: examples: default: value: description: An example dashboard for monitoring infrastructure. layout_type: ordered title: Example Dashboard widgets: - definition: requests: - q: avg:system.cpu.user{*} title: CPU Usage type: timeseries schema: $ref: "#/components/schemas/Dashboard" description: Create a dashboard request body. required: true responses: "200": content: application/json: examples: default: value: author_handle: test@example.com author_name: Example Name created_at: "2024-01-01T00:00:00+00:00" id: abc-123-def layout_type: ordered modified_at: "2024-01-01T00:00:00+00:00" notify_list: restricted_roles: [] template_variables: title: Example Dashboard url: /dashboard/abc-123-def/example-dashboard widgets: - definition: requests: - q: avg:system.cpu.user{*} title: CPU Usage type: timeseries id: 123 schema: $ref: "#/components/schemas/Dashboard" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Create a new dashboard tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_write /api/v1/dashboard/lists/manual: get: description: >- Fetch all of your existing dashboard list definitions. operationId: ListDashboardLists responses: "200": content: application/json: examples: default: value: dashboard_lists: - author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_count: 0 id: 123 is_favorite: false modified: "2024-01-01T00:00:00+00:00" name: My Dashboard List type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardListListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_read summary: Get all dashboard lists tags: - Dashboard Lists "x-permission": operator: OR permissions: - dashboards_read post: description: >- Create an empty dashboard list. operationId: CreateDashboardList requestBody: content: application/json: examples: default: value: name: My Dashboard List schema: $ref: "#/components/schemas/DashboardList" description: Create a dashboard list request body. required: true responses: "200": content: application/json: examples: default: value: author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_count: 0 id: 123 is_favorite: false modified: "2024-01-01T00:00:00+00:00" name: My Dashboard List type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardList" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Create a dashboard list tags: - Dashboard Lists x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_write /api/v1/dashboard/lists/manual/{list_id}: delete: description: >- Delete a dashboard list. operationId: DeleteDashboardList parameters: - description: ID of the dashboard list to delete. in: path name: list_id required: true schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: deleted_dashboard_list_id: 123 schema: $ref: "#/components/schemas/DashboardListDeleteResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Delete a dashboard list tags: - Dashboard Lists "x-permission": operator: OR permissions: - dashboards_write get: description: >- Fetch an existing dashboard list's definition. operationId: GetDashboardList parameters: - description: ID of the dashboard list to fetch. in: path name: list_id required: true schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_count: 0 id: 123 is_favorite: false modified: "2024-01-01T00:00:00+00:00" name: My Dashboard List type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardList" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_read summary: Get a dashboard list tags: - Dashboard Lists "x-permission": operator: OR permissions: - dashboards_read put: description: >- Update the name of a dashboard list. operationId: UpdateDashboardList parameters: - description: ID of the dashboard list to update. in: path name: list_id required: true schema: format: int64 type: integer requestBody: content: application/json: examples: default: value: name: My Dashboard List schema: $ref: "#/components/schemas/DashboardList" description: Update a dashboard list request body. required: true responses: "200": content: application/json: examples: default: value: author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_count: 0 id: 123 is_favorite: false modified: "2024-01-01T00:00:00+00:00" name: My Dashboard List type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardList" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Update a dashboard list tags: - Dashboard Lists x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_write /api/v1/dashboard/public: post: description: >- Share a specified private dashboard, generating a URL at which it can be publicly viewed. operationId: CreatePublicDashboard requestBody: content: application/json: examples: default: value: dashboard_id: 123-abc-456 dashboard_type: custom_timeboard global_time: live_span: 1h share_type: open json-request-body: value: {"dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open"} schema: $ref: "#/components/schemas/SharedDashboard" description: Create a shared dashboard request body. required: true responses: "200": content: application/json: examples: default: value: author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_id: abc-123-def dashboard_type: custom_timeboard global_time: live_span: 1h public_url: https://p.datadoghq.com/sb/abc-123 share_type: open status: active token: abc-123 schema: $ref: "#/components/schemas/SharedDashboard" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Dashboard Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_public_share - AuthZ: - dashboards_embed_share - AuthZ: - dashboards_invite_share summary: Create a shared dashboard tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_public_share - dashboards_embed_share - dashboards_invite_share /api/v1/dashboard/public/{token}: delete: description: >- Revoke the public URL for a dashboard (rendering it private) associated with the specified token. operationId: DeletePublicDashboard parameters: - description: The token of the shared dashboard. in: path name: token required: true schema: type: string responses: "200": content: application/json: examples: default: value: deleted_public_dashboard_token: abc-123 schema: $ref: "#/components/schemas/DeleteSharedDashboardResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Shared Dashboard Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_public_share - AuthZ: - dashboards_embed_share - AuthZ: - dashboards_invite_share summary: Revoke a shared dashboard URL tags: - Dashboards "x-permission": operator: OR permissions: - dashboards_public_share - dashboards_embed_share - dashboards_invite_share get: description: >- Fetch an existing shared dashboard's sharing metadata associated with the specified token. operationId: GetPublicDashboard parameters: - description: The token of the shared dashboard. Generated when a dashboard is shared. in: path name: token required: true schema: type: string responses: "200": content: application/json: examples: default: value: author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_id: abc-123-def dashboard_type: custom_timeboard global_time: live_span: 1h public_url: https://p.datadoghq.com/sb/abc-123 share_type: open status: active token: abc-123 schema: $ref: "#/components/schemas/SharedDashboard" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Shared Dashboard Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_read summary: Get a shared dashboard tags: - Dashboards "x-permission": operator: OR permissions: - dashboards_read put: description: Update a shared dashboard associated with the specified token. operationId: UpdatePublicDashboard parameters: - description: The token of the shared dashboard. in: path name: token required: true schema: type: string requestBody: content: application/json: examples: default: value: global_time: live_span: 1h selectable_template_vars: - default_value: "*" name: exampleVar prefix: test visible_tags: - selectableValue1 - selectableValue2 share_list: - test@datadoghq.com - test2@datadoghq.com share_type: invite json-request-body: value: {"global_time": {"live_span": "1h"}, "selectable_template_vars": [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}], "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"} schema: $ref: "#/components/schemas/SharedDashboardUpdateRequest" description: Update Dashboard request body. required: true responses: "200": content: application/json: examples: default: value: author: handle: test@example.com name: Example Name created: "2024-01-01T00:00:00+00:00" dashboard_id: abc-123-def dashboard_type: custom_timeboard global_time: live_span: 1h public_url: https://p.datadoghq.com/sb/abc-123 share_type: open status: active token: abc-123 schema: $ref: "#/components/schemas/SharedDashboard" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_public_share - AuthZ: - dashboards_embed_share - AuthZ: - dashboards_invite_share summary: Update a shared dashboard tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_public_share - dashboards_embed_share - dashboards_invite_share /api/v1/dashboard/public/{token}/invitation: delete: description: >- Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses. operationId: DeletePublicDashboardInvitation parameters: - description: The token of the shared dashboard. in: path name: token required: true schema: type: string requestBody: content: application/json: examples: default: value: data: attributes: email: test@datadoghq.com type: public_dashboard_invitation json-request-body: value: {"data": {"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}} schema: $ref: "#/components/schemas/SharedDashboardInvites" description: Shared Dashboard Invitation deletion request body. required: true responses: "204": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_invite_share summary: Revoke shared dashboard invitations tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_invite_share get: description: >- Describe the invitations that exist for the given shared dashboard (paginated). operationId: GetPublicDashboardInvitations parameters: - description: Token of the shared dashboard for which to fetch invitations. in: path name: token required: true schema: type: string - description: The number of records to return in a single request. in: query name: page_size required: false schema: format: int64 type: integer - description: The page to access (base 0). in: query name: page_number required: false schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: data: - attributes: created_at: "2024-01-01T00:00:00+00:00" email: test@example.com has_session: false session_expiry: share_token: abc-123 type: public_dashboard_invitation meta: page: total_count: 1 schema: $ref: "#/components/schemas/SharedDashboardInvites" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_invite_share summary: Get all invitations for a shared dashboard tags: - Dashboards "x-permission": operator: OR permissions: - dashboards_invite_share post: description: >- Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list. operationId: SendPublicDashboardInvitation parameters: - description: The token of the shared dashboard. in: path name: token required: true schema: type: string requestBody: content: application/json: examples: default: value: data: - attributes: email: test@datadoghq.com type: public_dashboard_invitation json-request-body: value: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]} schema: $ref: "#/components/schemas/SharedDashboardInvites" description: Shared Dashboard Invitation request body. required: true responses: "201": content: application/json: examples: default: value: data: - attributes: created_at: "2024-01-01T00:00:00+00:00" email: test@example.com has_session: false session_expiry: share_token: abc-123 type: public_dashboard_invitation meta: page: total_count: 1 schema: $ref: "#/components/schemas/SharedDashboardInvites" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_invite_share summary: Send shared dashboard invitation email tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_invite_share /api/v1/dashboard/{dashboard_id}: delete: description: Delete a dashboard using the specified ID. operationId: DeleteDashboard parameters: - description: The ID of the dashboard. in: path name: dashboard_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: deleted_dashboard_id: abc-123 schema: $ref: "#/components/schemas/DashboardDeleteResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Dashboards Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Delete a dashboard tags: - Dashboards "x-permission": operator: OR permissions: - dashboards_write get: description: Get a dashboard using the specified ID. operationId: GetDashboard parameters: - description: The ID of the dashboard. in: path name: dashboard_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: author_handle: test@example.com author_name: Example Name created_at: "2024-01-01T00:00:00+00:00" id: abc-123-def layout_type: ordered modified_at: "2024-01-01T00:00:00+00:00" notify_list: restricted_roles: [] template_variables: title: Example Dashboard url: /dashboard/abc-123-def/example-dashboard widgets: - definition: requests: - q: avg:system.cpu.user{*} title: CPU Usage type: timeseries id: 123 schema: $ref: "#/components/schemas/Dashboard" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_read summary: Get a dashboard tags: - Dashboards "x-permission": operator: OR permissions: - dashboards_read put: description: Update a dashboard using the specified ID. operationId: UpdateDashboard parameters: - description: The ID of the dashboard. in: path name: dashboard_id required: true schema: type: string requestBody: content: application/json: examples: default: value: description: An example dashboard for monitoring infrastructure. layout_type: ordered title: Example Dashboard widgets: - definition: requests: - q: avg:system.cpu.user{*} title: CPU Usage type: timeseries schema: $ref: "#/components/schemas/Dashboard" description: Update Dashboard request body. required: true responses: "200": content: application/json: examples: default: value: author_handle: test@example.com author_name: Example Name created_at: "2024-01-01T00:00:00+00:00" id: abc-123-def layout_type: ordered modified_at: "2024-01-01T00:00:00+00:00" notify_list: restricted_roles: [] template_variables: title: Example Dashboard url: /dashboard/abc-123-def/example-dashboard widgets: - definition: requests: - q: avg:system.cpu.user{*} title: CPU Usage type: timeseries id: 123 schema: $ref: "#/components/schemas/Dashboard" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - dashboards_write summary: Update a dashboard tags: - Dashboards x-codegen-request-body-name: body "x-permission": operator: OR permissions: - dashboards_write /api/v1/distribution_points: post: description: The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards. operationId: SubmitDistributionPoints parameters: - description: HTTP header used to compress the media-type. in: header name: Content-Encoding required: false schema: $ref: "#/components/schemas/DistributionPointsContentEncoding" requestBody: content: text/json: examples: default: value: series: - host: test.example.com metric: system.load.1 points: - [1636629071, [1.0, 2.0]] tags: - "environment:test" type: distribution dynamic-points: description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/distribution-points.json.sh summary: Dynamic Points x-variables: NOW: "$(date +%s)" schema: $ref: "#/components/schemas/DistributionPointsPayload" required: true responses: "202": content: text/json: examples: default: value: status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted "400": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "408": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Request timeout "413": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Payload too large "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] summary: Submit distribution points tags: - Metrics x-codegen-request-body-name: body /api/v1/downtime: get: deprecated: true description: |- Get all scheduled downtimes. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: ListDowntimes parameters: - description: Only return downtimes that are active when the request is made. in: query name: current_only required: false schema: type: boolean - description: Return creator information. in: query name: with_creator required: false schema: type: boolean responses: "200": content: application/json: examples: default: value: - active: true disabled: false end: 1412793983 id: 1625 message: Scheduled maintenance scope: - env:staging start: 1412792983 schema: items: $ref: "#/components/schemas/Downtime" type: array description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Get all downtimes tags: - Downtimes "x-permission": operator: OR permissions: - monitors_read post: deprecated: true description: |- Schedule a downtime. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: CreateDowntime requestBody: content: application/json: examples: default: value: end: 1412793983 message: Scheduling downtime for a database maintenance window. monitor_tags: - "*" scope: - env:staging start: 1412792983 timezone: America/New_York schema: $ref: "#/components/schemas/Downtime" description: Schedule a downtime request body. required: true responses: "200": content: application/json: examples: default: value: active: true disabled: false end: 1412793983 id: 1625 message: Scheduling downtime for a database maintenance window. scope: - env:staging start: 1412792983 schema: $ref: "#/components/schemas/Downtime" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_downtime summary: Schedule a downtime tags: - Downtimes x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_downtime /api/v1/downtime/cancel/by_scope: post: deprecated: true description: |- Delete all downtimes that match the scope of `X`. **Note:** This only interacts with Downtimes created using v1 endpoints. This endpoint has been deprecated and will not be replaced. Please use v2 endpoints to find and cancel downtimes. operationId: CancelDowntimesByScope requestBody: content: application/json: examples: default: value: scope: host:myserver schema: $ref: "#/components/schemas/CancelDowntimesByScopeRequest" description: Scope to cancel downtimes for. required: true responses: "200": content: application/json: examples: default: value: cancelled_ids: - 123 schema: $ref: "#/components/schemas/CanceledDowntimesIds" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Downtimes not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_downtime summary: Cancel downtimes by scope tags: - Downtimes x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_downtime /api/v1/downtime/{downtime_id}: delete: deprecated: true description: |- Cancel a downtime. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: CancelDowntime parameters: - description: ID of the downtime to cancel. in: path name: downtime_id required: true schema: example: 123456 format: int64 type: integer responses: "204": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_downtime summary: Cancel a downtime tags: - Downtimes "x-permission": operator: OR permissions: - monitors_downtime get: deprecated: true description: |- Get downtime detail by `downtime_id`. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: GetDowntime parameters: - description: ID of the downtime to fetch. in: path name: downtime_id required: true schema: example: 123456 format: int64 type: integer responses: "200": content: application/json: examples: default: value: active: true disabled: false end: 1412793983 id: 1625 message: Scheduled maintenance scope: - env:staging start: 1412792983 schema: $ref: "#/components/schemas/Downtime" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Get a downtime tags: - Downtimes "x-permission": operator: OR permissions: - monitors_read put: deprecated: true description: |- Update a single downtime by `downtime_id`. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: UpdateDowntime parameters: - description: ID of the downtime to update. in: path name: downtime_id required: true schema: example: 123456 format: int64 type: integer style: simple requestBody: content: application/json: examples: default: value: end: 1412793983 message: Updating downtime end time. monitor_tags: - "*" scope: - env:staging start: 1412792983 timezone: America/New_York schema: $ref: "#/components/schemas/Downtime" description: Update a downtime request body. required: true responses: "200": content: application/json: examples: default: value: active: true disabled: false end: 1412793983 id: 1625 message: Updating downtime end time. scope: - env:staging start: 1412792983 schema: $ref: "#/components/schemas/Downtime" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_downtime summary: Update a downtime tags: - Downtimes x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_downtime /api/v1/events: get: description: |- The event stream can be queried and filtered by time, priority, sources and tags. **Notes**: - If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\`,`n` in your output. - This endpoint returns a maximum of `1000` most recent results. To return additional results, identify the last timestamp of the last result and set that as the `end` query time to paginate the results. You can also use the page parameter to specify which set of `1000` results to return. operationId: ListEvents parameters: - description: POSIX timestamp. in: query name: start required: true schema: format: int64 type: integer - description: POSIX timestamp. in: query name: end required: true schema: format: int64 type: integer - description: Priority of your events, either `low` or `normal`. in: query name: priority required: false schema: $ref: "#/components/schemas/EventPriority" - description: A comma separated string of sources. in: query name: sources schema: type: string - description: |- A comma separated list indicating what tags, if any, should be used to filter the list of events. example: "host:host0" in: query name: tags required: false schema: type: string - description: |- Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.` in: query name: unaggregated required: false schema: type: boolean - description: |- Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default. in: query name: exclude_aggregate required: false schema: type: boolean - description: |- By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.` in: query name: page required: false schema: format: int32 maximum: 2147483647 type: integer responses: "200": content: application/json: examples: default: value: events: - alert_type: info date_happened: 1674842440 host: "test.host" id: 123 id_str: "123" priority: normal source_type_name: my_apps tags: - "environment:test" text: "Oh boy!" title: "Did you hear the news today?" url: "/event/event?id=123" status: ok schema: $ref: "#/components/schemas/EventListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - events_read summary: Get a list of events tags: - Events "x-permission": operator: OR permissions: - events_read post: description: |- This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events. operationId: CreateEvent requestBody: content: application/json: examples: default: value: priority: normal tags: - environment:test text: Oh boy! title: Did you hear the news today? schema: $ref: "#/components/schemas/EventCreateRequest" description: Event request object required: true responses: "202": content: application/json: examples: default: value: event: alert_type: info date_happened: 1674842440 id: 123 id_str: "123" priority: normal tags: - environment:test text: Oh boy! title: Did you hear the news today? url: "/event/event?id=123" status: ok schema: $ref: "#/components/schemas/EventCreateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] summary: Post an event tags: - Events x-codegen-request-body-name: body /api/v1/events/{event_id}: get: description: |- This endpoint allows you to query for event details. **Note**: If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\`,`n` in your output. operationId: GetEvent parameters: - description: The ID of the event. in: path name: event_id required: true schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: event: alert_type: info date_happened: 1674842440 host: "test.host" id: 123 id_str: "123" priority: normal tags: - environment:test text: Oh boy! title: Did you hear the news today? url: "/event/event?id=123" status: ok schema: $ref: "#/components/schemas/EventResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - events_read summary: Get an event tags: - Events "x-permission": operator: OR permissions: - events_read /api/v1/graph/snapshot: get: description: |- Take graph snapshots. Snapshots are PNG images generated by rendering a specified widget in a web page and capturing it once the data is available. The image is then uploaded to cloud storage. **Note**: When a snapshot is created, there is some delay before it is available. operationId: GetGraphSnapshot parameters: - description: The metric query. in: query name: metric_query schema: type: string x-docs-curl-required: true - description: The POSIX timestamp of the start of the query in seconds. in: query name: start required: true schema: format: int64 type: integer - description: The POSIX timestamp of the end of the query in seconds. in: query name: end required: true schema: format: int64 type: integer - description: A query that adds event bands to the graph. in: query name: event_query required: false schema: type: string - description: |- A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. in: query name: graph_def required: false schema: type: string - description: A title for the graph. If no title is specified, the graph does not have a title. in: query name: title required: false schema: type: string - description: The height of the graph. If no height is specified, the graph's original height is used. in: query name: height required: false schema: format: int64 type: integer - description: The width of the graph. If no width is specified, the graph's original width is used. in: query name: width required: false schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: metric_query: "avg:system.load.1{*}" snapshot_url: https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc schema: $ref: "#/components/schemas/GraphSnapshot" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Take graph snapshots tags: - Snapshots "x-permission": operator: OPEN permissions: [] /api/v1/host/{host_name}/mute: post: description: Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) for the host. operationId: MuteHost parameters: - description: Name of the host to mute. in: path name: host_name required: true schema: type: string requestBody: content: application/json: examples: default: value: end: 1579098130 message: Muting this host for a test! override: false schema: $ref: "#/components/schemas/HostMuteSettings" description: Mute a host request body. required: true responses: "200": content: application/json: examples: default: value: action: Muted end: 1579098130 hostname: test.host message: Muting this host for a test! schema: $ref: "#/components/schemas/HostMuteResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Mute a host tags: - Hosts x-codegen-request-body-name: body /api/v1/host/{host_name}/unmute: post: description: Unmutes a host. This endpoint takes no JSON arguments. operationId: UnmuteHost parameters: - description: Name of the host to unmute. in: path name: host_name required: true schema: type: string responses: "200": content: application/json: examples: default: value: action: Unmuted hostname: test.host schema: $ref: "#/components/schemas/HostMuteResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Unmute a host tags: - Hosts x-codegen-request-body-name: body /api/v1/hosts: get: description: |- This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time. **Note:** If the host is an Amazon EC2 instance, `id` is replaced with `aws_id` in the response. **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint. operationId: ListHosts parameters: - description: String to filter search results. in: query name: filter required: false schema: type: string - description: Sort hosts by this field. in: query name: sort_field required: false schema: type: string - description: Direction of sort. Options include `asc` and `desc`. in: query name: sort_dir required: false schema: type: string - description: Specify the starting point for the host search results. For example, if you set `count` to 100 and the first 100 results have already been returned, you can set `start` to `101` to get the next 100 results. in: query name: start required: false schema: format: int64 type: integer - description: Number of hosts to return. Max 1000. in: query name: count required: false schema: format: int64 type: integer - description: Number of seconds since UNIX epoch from which you want to search your hosts. in: query name: from required: false schema: format: int64 type: integer - description: Include information on the muted status of hosts and when the mute expires. in: query name: include_muted_hosts_data required: false schema: type: boolean - description: Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). in: query name: include_hosts_metadata required: false schema: type: boolean responses: "200": content: application/json: examples: default: value: host_list: - apps: - agent host_name: "i-deadbeef" is_muted: false last_reported_time: 1565000000 name: "i-hostname" sources: - aws up: true total_matching: 1 total_returned: 1 schema: $ref: "#/components/schemas/HostListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - hosts_read summary: Get all hosts for your organization tags: - Hosts "x-permission": operator: OR permissions: - hosts_read /api/v1/hosts/totals: get: description: |- This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours. operationId: GetHostTotals parameters: - description: Number of seconds from which you want to get total number of active hosts. in: query name: from required: false schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: total_active: 65 total_up: 42 schema: $ref: "#/components/schemas/HostTotals" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - hosts_read summary: Get the total number of active hosts tags: - Hosts "x-permission": operator: OR permissions: - hosts_read /api/v1/integration/aws: delete: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`." operationId: DeleteAWSAccount requestBody: content: application/json: examples: default: value: account_id: "123456789012" role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccountDeleteRequest" description: AWS request object required: true responses: "200": content: application/json: examples: default: value: {} schema: type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AWS integration tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configurations_manage get: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization." operationId: ListAWSAccounts parameters: - description: Only return AWS accounts that matches this `account_id`. in: query name: account_id required: false schema: type: string - description: Only return AWS accounts that matches this role_name. in: query name: role_name required: false schema: type: string - description: Only return AWS accounts that matches this `access_key_id`. in: query name: access_key_id required: false schema: type: string responses: "200": content: application/json: examples: default: value: accounts: - account_id: "123456789012" account_specific_namespace_rules: auto_scaling: false cspm_resource_collection_enabled: true excluded_regions: - us-east-1 extended_resource_collection_enabled: true filter_tags: - "$KEY:$VALUE" host_tags: - "$KEY:$VALUE" metrics_collection_enabled: false role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccountListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: List all AWS integrations tags: - AWS Integration "x-permission": operator: OR permissions: - aws_configuration_read post: deprecated: true description: |- **This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration. Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication. operationId: CreateAWSAccount requestBody: content: application/json: examples: default: value: account_id: "123456789012" account_specific_namespace_rules: auto_scaling: false opswork: false cspm_resource_collection_enabled: true excluded_regions: - us-east-1 - us-west-2 extended_resource_collection_enabled: true filter_tags: - "$KEY:$VALUE" host_tags: - "$KEY:$VALUE" metrics_collection_enabled: false role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccount" description: AWS Request Object required: true responses: "200": content: application/json: examples: default: value: external_id: abc-123 schema: $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an AWS integration tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configurations_manage put: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration." operationId: UpdateAWSAccount parameters: - description: Only return AWS accounts that matches this `account_id`. in: query name: account_id required: false schema: type: string - description: |- Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. in: query name: role_name required: false schema: type: string - description: |- Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. in: query name: access_key_id required: false schema: type: string requestBody: content: application/json: examples: default: value: account_id: "123456789012" account_specific_namespace_rules: auto_scaling: false opswork: false cspm_resource_collection_enabled: true excluded_regions: - us-east-1 - us-west-2 extended_resource_collection_enabled: true filter_tags: - "$KEY:$VALUE" host_tags: - "$KEY:$VALUE" metrics_collection_enabled: false role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccount" description: AWS request object required: true responses: "200": content: application/json: examples: default: value: {} schema: type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an AWS integration tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit /api/v1/integration/aws/available_namespace_rules: get: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments." operationId: ListAvailableAWSNamespaces responses: "200": content: application/json: examples: default: value: - namespace1 - namespace2 - namespace3 schema: example: ["namespace1", "namespace2", "namespace3"] items: type: string type: array description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: List namespace rules tags: - AWS Integration "x-permission": operator: OR permissions: - aws_configuration_read /api/v1/integration/aws/event_bridge: delete: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** Delete an Amazon EventBridge source." operationId: DeleteAWSEventBridgeSource requestBody: content: application/json: examples: default: value: account_id: "123456789012" event_generator_name: app-alerts-zyxw3210 region: us-east-1 schema: $ref: "#/components/schemas/AWSEventBridgeDeleteRequest" description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account. required: true responses: "200": content: application/json: examples: default: value: status: empty schema: $ref: "#/components/schemas/AWSEventBridgeDeleteResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an Amazon EventBridge source tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations get: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** Get all Amazon EventBridge sources." operationId: ListAWSEventBridgeSources parameters: [] responses: "200": content: application/json: examples: default: value: accounts: - accountId: "123456789012" eventHubs: - name: app-alerts-zyxw3210 region: us-east-1 tags: - "$KEY:$VALUE" isInstalled: true schema: $ref: "#/components/schemas/AWSEventBridgeListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Amazon EventBridge sources tags: - AWS Integration "x-permission": operator: OPEN permissions: [] post: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** Create an Amazon EventBridge source." operationId: CreateAWSEventBridgeSource requestBody: content: application/json: examples: default: value: account_id: "123456789012" create_event_bus: true event_generator_name: app-alerts region: us-east-1 schema: $ref: "#/components/schemas/AWSEventBridgeCreateRequest" description: Create an Amazon EventBridge source for an AWS account with a given name and region. required: true responses: "200": content: application/json: examples: default: value: event_source_name: app-alerts-zyxw3210 has_bus: true region: us-east-1 status: created schema: $ref: "#/components/schemas/AWSEventBridgeCreateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an Amazon EventBridge source tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/aws/filtering: delete: deprecated: true description: Delete a tag filtering entry. operationId: DeleteAWSTagFilter requestBody: content: application/json: examples: default: value: account_id: "FAKEAC0FAKEAC2FAKEAC" namespace: elb schema: $ref: "#/components/schemas/AWSTagFilterDeleteRequest" description: Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a tag filtering entry tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit get: deprecated: true description: Get all AWS tag filters. operationId: ListAWSTagFilters parameters: - description: Only return AWS filters that matches this `account_id`. in: query name: account_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: filters: - namespace: elb tag_filter_str: "prod*" schema: $ref: "#/components/schemas/AWSTagFilterListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all AWS tag filters tags: - AWS Integration "x-permission": operator: OR permissions: - aws_configuration_read post: deprecated: true description: Set an AWS tag filter. operationId: CreateAWSTagFilter requestBody: content: application/json: examples: default: value: account_id: "123456789012" namespace: elb tag_filter_str: "prod*" schema: $ref: "#/components/schemas/AWSTagFilterCreateRequest" description: |- Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Set an AWS tag filter tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit /api/v1/integration/aws/generate_new_external_id: put: deprecated: true description: "**This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair." operationId: CreateNewAWSExternalID requestBody: content: application/json: examples: default: value: account_id: "123456789012" role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccount" description: |- Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup). required: true responses: "200": content: application/json: examples: default: value: external_id: abc-123 schema: $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Generate a new external ID tags: - AWS Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit /api/v1/integration/aws/logs: delete: description: >- Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account. operationId: DeleteAWSLambdaARN requestBody: content: application/json: examples: default: value: account_id: "1234567" lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" schema: $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: Delete AWS Lambda ARN request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AWS Logs integration tags: - AWS Logs Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit get: deprecated: true description: >- List all Datadog-AWS Logs integrations configured in your Datadog account. operationId: ListAWSLogsIntegrations responses: "200": content: application/json: examples: default: value: - account_id: "123456789101" lambdas: [] services: - s3 - elb - elbv2 - cloudfront - redshift - lambda schema: example: [{"account_id": "123456789101", "lambdas": [], "services": ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"]}] items: $ref: "#/components/schemas/AWSLogsListResponse" type: array description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: List all AWS Logs integrations tags: - AWS Logs Integration "x-permission": operator: OR permissions: - aws_configuration_read post: description: >- Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection. operationId: CreateAWSLambdaARN requestBody: content: application/json: examples: default: value: account_id: "1234567" lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" schema: $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: AWS Log Lambda Async request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Add AWS Log Lambda ARN tags: - AWS Logs Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit /api/v1/integration/aws/logs/check_async: post: description: |- Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist. operationId: CheckAWSLogsLambdaAsync requestBody: content: application/json: examples: default: value: account_id: "1234567" lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" schema: $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: Check AWS Log Lambda Async request body. required: true responses: "200": content: application/json: examples: default: value: errors: [] status: created schema: $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Check that an AWS Lambda Function exists tags: - AWS Logs Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_read /api/v1/integration/aws/logs/services: get: deprecated: true description: >- **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint. operationId: ListAWSLogsServices responses: "200": content: application/json: examples: default: value: - id: s3 label: S3 Access Logs - id: elb label: Classic ELB Access Logs schema: example: [{"id": "s3", "label": "S3 Access Logs"}, {"id": "elb", "label": "Classic ELB Access Logs"}, {"id": "elbv2", "label": "Application ELB Access Logs"}, {"id": "cloudfront", "label": "CloudFront Access Logs"}, {"id": "redshift", "label": "Redshift Logs"}, {"id": "lambda", "label": "Lambda Cloudwatch Logs"}] items: $ref: "#/components/schemas/AWSLogsListServicesResponse" type: array description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get list of AWS log ready services tags: - AWS Logs Integration "x-permission": operator: OR permissions: - aws_configuration_read post: deprecated: true description: >- Enable automatic log collection for a list of services. This should be run after running `CreateAWSLambdaARN` to save the configuration. operationId: EnableAWSLogServices requestBody: content: application/json: examples: default: value: account_id: "1234567" services: - s3 - elb - elbv2 - cloudfront - redshift - lambda schema: $ref: "#/components/schemas/AWSLogsServicesRequest" description: Enable AWS Log Services request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Enable an AWS Logs integration tags: - AWS Logs Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_edit /api/v1/integration/aws/logs/services_async: post: description: |- Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for `EnableAWSLogServices`. Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes. - Returns a status of `created` when it's checking if the permissions exists in the AWS account. - Returns a status of `waiting` while checking. - Returns a status of `checked and ok` if the Lambda exists. - Returns a status of `error` if the Lambda does not exist. operationId: CheckAWSLogsServicesAsync requestBody: content: application/json: examples: default: value: account_id: "1234567" services: - s3 - elb - elbv2 - cloudfront - redshift - lambda schema: $ref: "#/components/schemas/AWSLogsServicesRequest" description: Check AWS Logs Async Services request body. required: true responses: "200": content: application/json: examples: default: value: errors: [] status: created schema: $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Check permissions for log services tags: - AWS Logs Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - aws_configuration_read /api/v1/integration/azure: delete: description: |- Delete a given Datadog-Azure integration from your Datadog account. operationId: DeleteAzureIntegration requestBody: content: application/json: examples: default: value: client_id: "testc7f6-1234-5678-9101-3fcbf464test" tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Delete a given Datadog-Azure integration request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an Azure integration tags: - Azure Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - azure_configurations_manage get: description: |- List all Datadog-Azure integrations configured in your Datadog account. operationId: ListAzureIntegration responses: "200": content: application/json: examples: default: value: - client_id: testc7f6-1234-5678-9101-3fcbf464test errors: [] host_filters: "key:value,filter:example" tenant_name: testc44-1234-5678-9101-cc00736ftest schema: $ref: "#/components/schemas/AzureAccountListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: List all Azure integrations tags: - Azure Integration "x-permission": operator: OR permissions: - azure_configuration_read post: description: |- Create a Datadog-Azure integration. Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. Using the `PUT` method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization. operationId: CreateAzureIntegration requestBody: content: application/json: examples: default: value: app_service_plan_filters: "key:value,filter:example" automute: true client_id: "testc7f6-1234-5678-9101-3fcbf464test" client_secret: "TestingRh2nx664kUy5dIApvM54T4AtO" container_app_filters: "key:value,filter:example" cspm_enabled: true custom_metrics_enabled: true host_filters: "key:value,filter:example" metrics_enabled: true resource_collection_enabled: true tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Create a Datadog-Azure integration for your Datadog account request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an Azure integration tags: - Azure Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - azure_configurations_manage put: description: |- Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`. Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`, use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload. operationId: UpdateAzureIntegration requestBody: content: application/json: examples: default: value: automute: true client_id: "testc7f6-1234-5678-9101-3fcbf464test" client_secret: "TestingRh2nx664kUy5dIApvM54T4AtO" cspm_enabled: true host_filters: "key:value,filter:example" metrics_enabled: true new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test" new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest" resource_collection_enabled: true tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Update a Datadog-Azure integration request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an Azure integration tags: - Azure Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - azure_configuration_edit /api/v1/integration/azure/host_filters: post: description: |- Update the defined list of host filters for a given Datadog-Azure integration. operationId: UpdateAzureHostFilters requestBody: content: application/json: examples: default: value: client_id: "testc7f6-1234-5678-9101-3fcbf464test" host_filters: "key:value,filter:example" tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Update a Datadog-Azure integration's host filters request body. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Azure integration host filters tags: - Azure Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - azure_configuration_edit /api/v1/integration/gcp: delete: deprecated: true description: |- This endpoint is deprecated – use the V2 endpoints instead. Delete a given Datadog-GCP integration. operationId: DeleteGCPIntegration requestBody: content: application/json: examples: default: value: client_email: "test@sandbox.iam.gserviceaccount.com" client_id: "123456712345671234567" project_id: "datadog-apitest" schema: $ref: "#/components/schemas/GCPAccount" description: Delete a given Datadog-GCP integration. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a GCP integration tags: - GCP Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - gcp_configurations_manage get: deprecated: true description: |- This endpoint is deprecated – use the V2 endpoints instead. List all Datadog-GCP integrations configured in your Datadog account. operationId: ListGCPIntegration responses: "200": content: application/json: examples: default: value: - client_email: test@example.com client_id: "123456712345671234567" errors: [] project_id: datadog-apitest type: service_account schema: $ref: "#/components/schemas/GCPAccountListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: List all GCP integrations tags: - GCP Integration "x-permission": operator: OR permissions: - gcp_configuration_read post: deprecated: true description: |- This endpoint is deprecated – use the V2 endpoints instead. Create a Datadog-GCP integration. operationId: CreateGCPIntegration requestBody: content: application/json: examples: default: value: auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs" auth_uri: "https://accounts.google.com/o/oauth2/auth" client_email: "test@sandbox.iam.gserviceaccount.com" client_id: "123456712345671234567" client_x509_cert_url: "https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL" host_filters: "$KEY1:$VALUE1,$KEY2:$VALUE2" is_cspm_enabled: true private_key: "private_key" private_key_id: "123456789abcdefghi123456789abcdefghijklm" project_id: "datadog-apitest" resource_collection_enabled: true token_uri: "https://accounts.google.com/o/oauth2/token" type: "service_account" schema: $ref: "#/components/schemas/GCPAccount" description: Create a Datadog-GCP integration. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a GCP integration tags: - GCP Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - gcp_configurations_manage put: deprecated: true description: |- This endpoint is deprecated – use the V2 endpoints instead. Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a `project_id` and `client_email`, however these fields cannot be updated. If you need to update these fields, delete and use the create (`POST`) endpoint. The unspecified fields will keep their original values. operationId: UpdateGCPIntegration requestBody: content: application/json: examples: default: value: client_email: "test@sandbox.iam.gserviceaccount.com" client_id: "123456712345671234567" host_filters: "$KEY1:$VALUE1,$KEY2:$VALUE2" is_cspm_enabled: true project_id: "datadog-apitest" resource_collection_enabled: true schema: $ref: "#/components/schemas/GCPAccount" description: Update a Datadog-GCP integration. required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a GCP integration tags: - GCP Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - gcp_configuration_edit /api/v1/integration/pagerduty/configuration/services: post: description: Create a new service object in the PagerDuty integration. operationId: CreatePagerDutyIntegrationService requestBody: content: application/json: examples: default: value: service_key: "your-pagerduty-service-key" service_name: "my-pagerduty-service" schema: $ref: "#/components/schemas/PagerDutyService" description: Create a new service object request body. required: true responses: "201": content: application/json: examples: default: value: service_name: test-service schema: $ref: "#/components/schemas/PagerDutyServiceName" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a new service object tags: - PagerDuty Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/pagerduty/configuration/services/{service_name}: delete: description: Delete a single service object in the Datadog-PagerDuty integration. operationId: DeletePagerDutyIntegrationService parameters: - description: The service name in: path name: service_name required: true schema: type: string responses: "204": description: No Content "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a single service object tags: - PagerDuty Integration "x-permission": operator: OR permissions: - manage_integrations get: description: |- Get service name in the Datadog-PagerDuty integration. operationId: GetPagerDutyIntegrationService parameters: - description: The service name. in: path name: service_name required: true schema: type: string responses: "200": content: application/json: examples: default: value: service_name: test-service schema: $ref: "#/components/schemas/PagerDutyServiceName" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a single service object tags: - PagerDuty Integration "x-permission": operator: OR permissions: - integrations_read put: description: Update a single service object in the Datadog-PagerDuty integration. operationId: UpdatePagerDutyIntegrationService parameters: - description: The service name in: path name: service_name required: true schema: type: string requestBody: content: application/json: examples: default: value: service_key: "updated-pagerduty-service-key" schema: $ref: "#/components/schemas/PagerDutyServiceKey" description: Update an existing service object request body. required: true responses: "200": description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a single service object tags: - PagerDuty Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/slack/configuration/accounts/{account_name}/channels: get: description: Get a list of all channels configured for your Datadog-Slack integration. operationId: GetSlackIntegrationChannels parameters: - $ref: "#/components/parameters/SlackAccountNamePathParameter" responses: "200": content: application/json: examples: default: value: - display: message: true mute_buttons: false notified: true snapshot: true tags: true name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannels" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all channels in a Slack integration tags: - Slack Integration "x-permission": operator: OR permissions: - integrations_read post: description: Add a channel to your Datadog-Slack integration. operationId: CreateSlackIntegrationChannel parameters: - $ref: "#/components/parameters/SlackAccountNamePathParameter" requestBody: content: application/json: examples: default: value: display: message: true mute_buttons: false notified: true snapshot: true tags: true name: "#general" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: Payload describing Slack channel to be created required: true responses: "200": content: application/json: examples: default: value: display: message: true mute_buttons: false notified: true snapshot: true tags: true name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a Slack integration channel tags: - Slack Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}: delete: description: Remove a channel from your Datadog-Slack integration. operationId: RemoveSlackIntegrationChannel parameters: - $ref: "#/components/parameters/SlackAccountNamePathParameter" - $ref: "#/components/parameters/SlackChannelNamePathParameter" responses: "204": description: The channel was removed successfully. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Remove a Slack integration channel tags: - Slack Integration "x-permission": operator: OR permissions: - manage_integrations get: description: Get a channel configured for your Datadog-Slack integration. operationId: GetSlackIntegrationChannel parameters: - $ref: "#/components/parameters/SlackAccountNamePathParameter" - $ref: "#/components/parameters/SlackChannelNamePathParameter" responses: "200": content: application/json: examples: default: value: display: message: true mute_buttons: false notified: true snapshot: true tags: true name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a Slack integration channel tags: - Slack Integration "x-permission": operator: OR permissions: - integrations_read patch: description: Update a channel used in your Datadog-Slack integration. operationId: UpdateSlackIntegrationChannel parameters: - $ref: "#/components/parameters/SlackAccountNamePathParameter" - $ref: "#/components/parameters/SlackChannelNamePathParameter" requestBody: content: application/json: examples: default: value: display: message: true mute_buttons: false notified: true snapshot: true tags: true name: "#general" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: Payload describing fields and values to be updated. required: true responses: "200": content: application/json: examples: default: value: display: message: true mute_buttons: false notified: true snapshot: true tags: true name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a Slack integration channel tags: - Slack Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/webhooks/configuration/custom-variables: post: description: Creates an endpoint with the name ``. operationId: CreateWebhooksIntegrationCustomVariable requestBody: content: application/json: examples: default: value: is_secret: true name: CUSTOM_VARIABLE_NAME value: CUSTOM_VARIABLE_VALUE schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariable" description: Define a custom variable request body. required: true responses: "201": content: application/json: examples: default: value: is_secret: true name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a custom variable tags: - Webhooks Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}: delete: description: Deletes the endpoint with the name ``. operationId: DeleteWebhooksIntegrationCustomVariable parameters: - description: The name of the custom variable. in: path name: custom_variable_name required: true schema: type: string responses: "200": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a custom variable tags: - Webhooks Integration "x-permission": operator: OR permissions: - manage_integrations get: description: |- Shows the content of the custom variable with the name ``. If the custom variable is secret, the value does not return in the response payload. operationId: GetWebhooksIntegrationCustomVariable parameters: - description: The name of the custom variable. in: path name: custom_variable_name required: true schema: type: string responses: "200": content: application/json: examples: default: value: is_secret: true name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a custom variable tags: - Webhooks Integration "x-permission": operator: OR permissions: - integrations_read put: description: Updates the endpoint with the name ``. operationId: UpdateWebhooksIntegrationCustomVariable parameters: - description: The name of the custom variable. in: path name: custom_variable_name required: true schema: type: string requestBody: content: application/json: examples: default: value: is_secret: true name: CUSTOM_VARIABLE_NAME value: CUSTOM_VARIABLE_VALUE schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableUpdateRequest" description: Update an existing custom variable request body. required: true responses: "200": content: application/json: examples: default: value: is_secret: true name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a custom variable tags: - Webhooks Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/integration/webhooks/configuration/webhooks: post: description: Creates an endpoint with the name ``. operationId: CreateWebhooksIntegration requestBody: content: application/json: examples: default: value: encode_as: json name: WEBHOOK_NAME url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: Create a webhooks integration request body. required: true responses: "201": content: application/json: examples: default: value: encode_as: json name: WEBHOOK_NAME url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - create_webhooks summary: Create a webhooks integration tags: - Webhooks Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - create_webhooks /api/v1/integration/webhooks/configuration/webhooks/{webhook_name}: delete: description: Deletes the endpoint with the name ``. This action cannot be undone. operationId: DeleteWebhooksIntegration parameters: - description: The name of the webhook. in: path name: webhook_name required: true schema: type: string responses: "200": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a webhook tags: - Webhooks Integration "x-permission": operator: OR permissions: - manage_integrations get: description: Gets the content of the webhook with the name ``. operationId: GetWebhooksIntegration parameters: - description: The name of the webhook. in: path name: webhook_name required: true schema: type: string responses: "200": content: application/json: examples: default: value: encode_as: json name: WEBHOOK_NAME url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a webhook integration tags: - Webhooks Integration "x-permission": operator: OR permissions: - integrations_read put: description: Updates the endpoint with the name ``. operationId: UpdateWebhooksIntegration parameters: - description: The name of the webhook. in: path name: webhook_name required: true schema: type: string requestBody: content: application/json: examples: default: value: encode_as: json name: WEBHOOK_NAME url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegrationUpdateRequest" description: Update an existing Datadog-Webhooks integration. required: true responses: "200": content: application/json: examples: default: value: encode_as: json name: WEBHOOK_NAME url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a webhook tags: - Webhooks Integration x-codegen-request-body-name: body "x-permission": operator: OR permissions: - manage_integrations /api/v1/logs-queries/list: post: description: |- List endpoint returns logs that match a log search query. [Results are paginated][1]. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** **Note**: This endpoint is enabled by default for logs customers. To disable it, contact [Datadog support](https://docs.datadoghq.com/help/). [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives operationId: ListLogs requestBody: content: application/json: examples: default: value: index: "retention-3,retention-15" limit: 25 query: "service:web* AND @http.status_code:[200 TO 299]" sort: desc time: from: "2020-02-02T02:02:02.202Z" to: "2020-02-20T02:02:02.202Z" schema: $ref: "#/components/schemas/LogsListRequest" description: Logs filter required: true responses: "200": content: application/json: examples: default: value: logs: - content: attributes: customAttribute: 123 host: i-0123 service: test-service tags: - team:A timestamp: "2020-05-26T13:36:14Z" id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA status: done schema: $ref: "#/components/schemas/LogsListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Search logs tags: - Logs x-codegen-request-body-name: body "x-permission": operator: OR permissions: - logs_read_data /api/v1/logs/config/index-order: get: description: |- Get the current order of your log indexes. This endpoint takes no JSON arguments. operationId: GetLogsIndexOrder responses: "200": content: application/json: examples: default: value: index_names: - main - payments - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get indexes order tags: - Logs Indexes "x-permission": operator: OR permissions: - logs_read_config put: description: |- This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful. operationId: UpdateLogsIndexOrder requestBody: content: application/json: examples: default: value: index_names: - main - payments - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: Object containing the new ordered list of index names required: true responses: "200": content: application/json: examples: default: value: index_names: - main - payments - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update indexes order tags: - Logs Indexes x-codegen-request-body-name: body "x-permission": operator: OR permissions: - logs_modify_indexes /api/v1/logs/config/indexes: get: description: |- The Index object describes the configuration of a log index. This endpoint returns an array of the `LogIndex` objects of your organization. operationId: ListLogIndexes responses: "200": content: application/json: examples: default: value: indexes: - daily_limit: 300000000 filter: query: source:python is_rate_limited: false name: main num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndexListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all indexes tags: - Logs Indexes "x-permission": operator: OR permissions: - logs_read_config post: description: |- Creates a new index. Returns the Index object passed in the request body when the request is successful. operationId: CreateLogsIndex requestBody: content: application/json: examples: default: value: daily_limit: 300000000 daily_limit_warning_threshold_percentage: 70 exclusion_filters: - filter: query: "*" sample_rate: 1.0 is_enabled: true name: payment filter: query: source:python name: main num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: Object containing the new index. required: true responses: "200": content: application/json: examples: default: value: daily_limit: 300000000 filter: query: source:python is_rate_limited: false name: main num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Invalid Parameter Error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "422": content: application/json: schema: $ref: "#/components/schemas/LogsAPILimitReachedResponse" description: Unprocessable Entity "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an index tags: - Logs Indexes x-codegen-request-body-name: body "x-permission": operator: OR permissions: - logs_modify_indexes /api/v1/logs/config/indexes/{name}: delete: description: |- Delete an existing index from your organization. Index deletions are permanent and cannot be reverted. You cannot recreate an index with the same name as deleted ones. operationId: DeleteLogsIndex parameters: - description: Name of the log index. in: path name: name required: true schema: type: string responses: "200": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an index tags: - Logs Indexes "x-permission": operator: OR permissions: - logs_modify_indexes get: description: |- Get one log index from your organization. This endpoint takes no JSON arguments. operationId: GetLogsIndex parameters: - description: Name of the log index. in: path name: name required: true schema: type: string responses: "200": content: application/json: examples: default: value: daily_limit: 300000000 filter: query: source:python is_rate_limited: false name: main num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an index tags: - Logs Indexes "x-permission": operator: OR permissions: - logs_read_config put: description: |- Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. Using the `PUT` method updates your index's configuration by **replacing** your current configuration with the new one sent to your Datadog organization. operationId: UpdateLogsIndex parameters: - description: Name of the log index. in: path name: name required: true schema: type: string requestBody: content: application/json: examples: default: value: daily_limit: 300000000 daily_limit_warning_threshold_percentage: 70 disable_daily_limit: false exclusion_filters: - filter: query: "*" sample_rate: 1.0 is_enabled: true name: payment filter: query: source:python num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndexUpdateRequest" description: Object containing the new `LogsIndexUpdateRequest`. required: true responses: "200": content: application/json: examples: default: value: daily_limit: 300000000 filter: query: source:python is_rate_limited: false name: main num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Invalid Parameter Error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Too Many Requests summary: Update an index tags: - Logs Indexes x-codegen-request-body-name: body /api/v1/logs/config/pipeline-order: get: description: |- Get the current order of your pipelines. This endpoint takes no JSON arguments. operationId: GetLogsPipelineOrder responses: "200": content: application/json: examples: default: value: pipeline_ids: - tags - org_ids - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get pipeline order tags: - Logs Pipelines "x-permission": operator: OR permissions: - logs_read_config put: description: |- Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors. **Note**: Using the `PUT` method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization. operationId: UpdateLogsPipelineOrder requestBody: content: application/json: examples: default: value: pipeline_ids: - tags - org_ids - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: Object containing the new ordered list of pipeline IDs. required: true responses: "200": content: application/json: examples: default: value: pipeline_ids: - tags - org_ids - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "422": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Unprocessable Entity "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update pipeline order tags: - Logs Pipelines x-codegen-request-body-name: body "x-permission": operator: OR permissions: - logs_write_pipelines /api/v1/logs/config/pipelines: get: description: |- Get all pipelines from your organization. This endpoint takes no JSON arguments. operationId: ListLogsPipelines responses: "200": content: application/json: examples: default: value: - filter: query: source:python id: abc-123 is_enabled: true is_read_only: false name: My Pipeline processors: [] schema: $ref: "#/components/schemas/LogsPipelineList" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all pipelines tags: - Logs Pipelines "x-permission": operator: OR permissions: - logs_read_config post: description: Create a pipeline in your organization. operationId: CreateLogsPipeline requestBody: content: application/json: examples: default: value: filter: query: source:python is_enabled: true name: My Pipeline processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: Definition of the new pipeline. required: true responses: "200": content: application/json: examples: default: value: filter: query: source:python id: abc-123 is_enabled: true is_read_only: false name: My Pipeline processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a pipeline tags: - Logs Pipelines x-codegen-request-body-name: body "x-permission": operator: OR permissions: - logs_write_pipelines /api/v1/logs/config/pipelines/{pipeline_id}: delete: description: |- Delete a given pipeline from your organization. This endpoint takes no JSON arguments. operationId: DeleteLogsPipeline parameters: - description: ID of the pipeline to delete. in: path name: pipeline_id required: true schema: type: string responses: "200": description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a pipeline tags: - Logs Pipelines "x-permission": operator: OR permissions: - logs_write_pipelines get: description: |- Get a specific pipeline from your organization. This endpoint takes no JSON arguments. operationId: GetLogsPipeline parameters: - description: ID of the pipeline to get. in: path name: pipeline_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: filter: query: source:python id: abc-123 is_enabled: true is_read_only: false name: My Pipeline processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a pipeline tags: - Logs Pipelines "x-permission": operator: OR permissions: - logs_read_config put: description: |- Update a given pipeline configuration to change it’s processors or their order. **Note**: Using this method updates your pipeline configuration by **replacing** your current configuration with the new one sent to your Datadog organization. operationId: UpdateLogsPipeline parameters: - description: ID of the pipeline to delete. in: path name: pipeline_id required: true schema: type: string requestBody: content: application/json: examples: default: value: filter: query: source:python is_enabled: true name: My Pipeline processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: New definition of the pipeline. required: true responses: "200": content: application/json: examples: default: value: filter: query: source:python id: abc-123 is_enabled: true is_read_only: false name: My Pipeline processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a pipeline tags: - Logs Pipelines x-codegen-request-body-name: body "x-permission": operator: OR permissions: - logs_write_pipelines /api/v1/metrics: get: description: Get the list of actively reporting metrics from a given time until now. operationId: ListActiveMetrics parameters: - description: Seconds since the Unix epoch. in: query name: from required: true schema: format: int64 type: integer - description: |- Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. in: query name: host required: false schema: type: string - description: |- Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. example: "env IN (staging,test) AND service:web" in: query name: tag_filter required: false schema: type: string responses: "200": content: application/json: examples: default: value: from: "1567816237" metrics: - system.cpu.idle - system.load.1 schema: $ref: "#/components/schemas/MetricsListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - metrics_read summary: Get active metrics list tags: - Metrics "x-permission": operator: OR permissions: - metrics_read /api/v1/metrics/{metric_name}: get: description: Get metadata about a specific metric. operationId: GetMetricMetadata parameters: - description: Name of the metric for which to get metadata. in: path name: metric_name required: true schema: type: string responses: "200": content: application/json: examples: default: value: description: Number of requests received. per_unit: second type: count unit: byte schema: $ref: "#/components/schemas/MetricMetadata" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - metrics_read summary: Get metric metadata tags: - Metrics "x-permission": operator: OR permissions: - metrics_read put: description: |- Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics). operationId: UpdateMetricMetadata parameters: - description: Name of the metric for which to edit metadata. in: path name: metric_name required: true schema: type: string requestBody: content: application/json: examples: default: value: description: Number of requests received. per_unit: second type: count unit: byte schema: $ref: "#/components/schemas/MetricMetadata" description: New metadata. required: true responses: "200": content: application/json: examples: default: value: description: Number of requests received. per_unit: second type: count unit: byte schema: $ref: "#/components/schemas/MetricMetadata" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit metric metadata tags: - Metrics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - metrics_metadata_write /api/v1/monitor: get: description: |- Get all monitors from your organization. operationId: ListMonitors parameters: - description: |- When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. in: query name: group_states required: false schema: example: alert type: string - description: A string to filter monitors by name. in: query name: name required: false schema: type: string - description: |- A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, `host:host0`. in: query name: tags required: false schema: example: "host:host0" type: string - description: |- A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`. in: query name: monitor_tags required: false schema: example: "service:my-app" type: string - description: If this argument is set to true, then the returned data includes all current active downtimes for each monitor. in: query name: with_downtimes required: false schema: type: boolean - description: Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty. in: query name: id_offset required: false schema: format: int64 type: integer - description: The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. in: query name: page required: false schema: example: 0 format: int64 type: integer - description: The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100. in: query name: page_size required: false schema: default: 100 example: 20 format: int32 maximum: 1000 type: integer responses: "200": content: application/json: examples: default: value: - id: 123 message: "You may need to add web hosts if this is consistently high." name: "My monitor" options: no_data_timeframe: 20 notify_no_data: true query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" - "frontend" type: "query alert" schema: description: An array of monitor objects. items: $ref: "#/components/schemas/Monitor" type: array description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Get all monitors tags: - Monitors x-pagination: limitParam: page_size pageParam: page "x-permission": operator: OR permissions: - monitors_read post: description: |- Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: `query alert` - APM: `query alert` or `trace-analytics alert` - composite: `composite` - custom: `service check` - forecast: `query alert` - host: `service check` - integration: `query alert` or `service check` - live process: `process alert` - logs: `log alert` - metric: `query alert` - network: `service check` - outlier: `query alert` - process: `service check` - rum: `rum alert` - SLO: `slo alert` - watchdog: `event-v2 alert` - event-v2: `event-v2 alert` - audit: `audit alert` - error-tracking: `error-tracking alert` - database-monitoring: `database-monitoring alert` - network-performance: `network-performance alert` - cloud cost: `cost alert` - network-path: `network-path alert` **Notes**: - Synthetic monitors are created through the Synthetics API. See the [Synthetics API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for more information. - Log monitors require an unscoped App Key. #### Query Types ##### Metric Alert Query Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) or `last_1d`, or `last_1w` - `space_aggr`: avg, sum, min, or max - `tags`: one or more tags (comma-separated), or * - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold To use a dynamic threshold on a metric monitor with a formula query, replace `#` with the `threshold` keyword (for example, `... > threshold`) and provide the threshold as a query via `critical_query` on `options.thresholds`. This feature is in preview. If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions) - `time_window` last\_#m (between 1 and 2880 depending on the monitor type), last\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` ##### Service Check Query Example: `"check".over(tags).last(count).by(group).count_by_status()` - `check` name of the check, for example `datadog.agent.up` - `tags` one or more quoted tags (comma-separated), or "*". for example: `.over("env:prod", "role:db")`; `over` cannot be blank. - `count` must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3. - `group` must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. For example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information. ##### Event Alert Query **Note:** The Event Alert Query has been replaced by the Event V2 Alert Query. For more information, see the [Event Migration guide](https://docs.datadoghq.com/service_management/events/guides/migrating_to_new_events_features/). ##### Event V2 Alert Query Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### Process Alert Query Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - `search` free text search string for querying processes. Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - `tags` one or more tags (comma-separated) - `timeframe` the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - `operator` <, <=, >, >=, ==, or != - `#` an integer or decimal number used to set the threshold ##### Logs Alert Query Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `index_name` For multi-index organizations, the log index in which the request is performed. - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### Composite Query Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors * `name` [*required*, *default* = **dynamic, based on query**]: The name of the alert. * `message` [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * `tags` [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI. ##### SLO Alert Query Example: `error_budget("slo_id").over("time_window") operator #` - `slo_id`: The alphanumeric SLO ID of the SLO you are configuring the alert for. - `time_window`: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`. - `operator`: `>=` or `>` ##### Audit Alert Query Example: `audits(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### CI Pipelines Alert Query Example: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### CI Tests Alert Query Example: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### Error Tracking Alert Query "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #` "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted. - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. **Database Monitoring Alert Query** Example: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. **Network Performance Alert Query** Example: `network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. **Cost Alert Query** Example: `formula(query).timeframe_type(time_window).function(parameter) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `timeframe_type` The timeframe type to evaluate the cost - for `forecast` supports `current` - for `change`, `anomaly`, `threshold` supports `last` - `time_window` - supports daily roll-up e.g. `7d` - `function` - [optional, defaults to `threshold` monitor if omitted] supports `change`, `anomaly`, `forecast` - `parameter` Specify the parameter of the type - for `change`: - supports `relative`, `absolute` - [optional] supports `#`, where `#` is an integer or decimal number used to set the threshold - for `anomaly`: - supports `direction=both`, `direction=above`, `direction=below` - [optional] supports `threshold=#`, where `#` is an integer or decimal number used to set the threshold - `operator` - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=` - for `change` supports `>`, `<` - for `anomaly` supports `>=` - for `forecast` supports `>` - `#` an integer or decimal number used to set the threshold. **Network Path Alert Query** Example: `network-path(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `index_name` The data type to monitor on - supports `netpath-path` and `netpath-hop`. - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. operationId: CreateMonitor requestBody: content: application/json: examples: default: value: message: "You may need to add web hosts if this is consistently high." name: "Bytes received on host0" options: no_data_timeframe: 20 notify_no_data: true priority: 3 query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" - "frontend" type: "query alert" schema: $ref: "#/components/schemas/Monitor" description: Create a monitor request body. required: true responses: "200": content: application/json: examples: default: value: id: 123 message: You may need to add web hosts if this is consistently high. name: Bytes received on host0 options: no_data_timeframe: 20 notify_no_data: true query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" - frontend type: query alert schema: $ref: "#/components/schemas/Monitor" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_write summary: Create a monitor tags: - Monitors x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_write /api/v1/monitor/can_delete: get: description: Check if the given monitors can be deleted. operationId: CheckCanDeleteMonitor parameters: - description: The IDs of the monitor to check. explode: false in: query name: monitor_ids required: true schema: items: example: 666486743 format: int64 type: integer type: array style: form responses: "200": content: application/json: examples: default: value: data: ok: - 123 errors: schema: $ref: "#/components/schemas/CheckCanDeleteMonitorResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "409": content: application/json: schema: $ref: "#/components/schemas/CheckCanDeleteMonitorResponse" description: Deletion conflict error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Check if a monitor can be deleted tags: - Monitors "x-permission": operator: OR permissions: - monitors_read /api/v1/monitor/groups/search: get: description: |- Search and filter your monitor groups details. operationId: SearchMonitorGroups parameters: - description: |- After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the URL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2]. The query can contain any number of space-separated monitor attributes, for instance: `query="type:metric group_status:alert"`. [1]: https://app.datadoghq.com/monitors/triggered [2]: /monitors/manage/#triggered-monitors in: query name: query required: false schema: type: string - description: Page to start paginating from. in: query name: page required: false schema: default: 0 format: int64 type: integer - description: Number of monitors to return per page. in: query name: per_page required: false schema: default: 30 format: int64 type: integer - description: |- String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags` in: query name: sort required: false schema: type: string responses: "200": content: application/json: examples: default: value: counts: status: - count: 1 name: OK type: - count: 1 name: metric groups: - group: "*" group_tags: - "*" monitor_id: 123 monitor_name: Example Monitor status: OK metadata: page: 0 page_count: 1 per_page: 30 total_count: 1 schema: $ref: "#/components/schemas/MonitorGroupSearchResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Monitors group search tags: - Monitors "x-permission": operator: OR permissions: - monitors_read /api/v1/monitor/search: get: description: |- Search and filter your monitors details. operationId: SearchMonitors parameters: - description: |- After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query="type:metric status:alert"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors in: query name: query required: false schema: type: string - description: Page to start paginating from. in: query name: page required: false schema: default: 0 format: int64 type: integer - description: Number of monitors to return per page. in: query name: per_page required: false schema: default: 30 format: int64 type: integer - description: |- String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags` in: query name: sort required: false schema: type: string responses: "200": content: application/json: examples: default: value: counts: status: - count: 1 name: No Data type: - count: 1 name: metric metadata: page: 0 page_count: 1 per_page: 30 total_count: 1 monitors: - id: 123 name: Example Monitor org_id: 123 status: No Data type: query alert schema: $ref: "#/components/schemas/MonitorSearchResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Monitors search tags: - Monitors "x-permission": operator: OR permissions: - monitors_read /api/v1/monitor/validate: post: description: |- Validate the monitor provided in the request. **Note**: Log monitors require an unscoped App Key and `logs_read_data` permission. operationId: ValidateMonitor requestBody: content: application/json: examples: default: value: message: "You may need to add web hosts if this is consistently high." name: "My monitor" options: no_data_timeframe: 20 notify_no_data: true query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" - "frontend" type: "query alert" schema: $ref: "#/components/schemas/Monitor" description: Monitor request object required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid JSON "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Validate a monitor tags: - Monitors x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_read /api/v1/monitor/{monitor_id}: delete: description: Delete the specified monitor operationId: DeleteMonitor parameters: - description: The ID of the monitor. in: path name: monitor_id required: true schema: example: 666486743 format: int64 type: integer - description: Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor). in: query name: force required: false schema: example: "false" type: string responses: "200": content: application/json: examples: default: value: deleted_monitor_id: 123 schema: $ref: "#/components/schemas/DeletedMonitor" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Item not found error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_write summary: Delete a monitor tags: - Monitors "x-permission": operator: OR permissions: - monitors_write get: description: Get details about the specified monitor from your organization. operationId: GetMonitor parameters: - description: The ID of the monitor in: path name: monitor_id required: true schema: example: 666486743 format: int64 type: integer - description: When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. in: query name: group_states required: false schema: type: string - description: If this argument is set to true, then the returned data includes all current active downtimes for the monitor. in: query name: with_downtimes required: false schema: type: boolean - description: If this argument is set to `true`, the returned data includes all assets tied to this monitor. in: query name: with_assets required: false schema: type: boolean responses: "200": content: application/json: examples: default: value: id: 123 message: You may need to add web hosts if this is consistently high. name: Bytes received on host0 query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" type: query alert schema: $ref: "#/components/schemas/Monitor" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Get a monitor's details tags: - Monitors "x-permission": operator: OR permissions: - monitors_read put: description: Edit the specified monitor. operationId: UpdateMonitor parameters: - description: The ID of the monitor. in: path name: monitor_id required: true schema: example: 666486743 format: int64 type: integer requestBody: content: application/json: examples: default: value: message: "Updated notification message for this monitor." name: "Updated monitor name" options: no_data_timeframe: 20 notify_no_data: true priority: 3 query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" - "frontend" type: "query alert" schema: $ref: "#/components/schemas/MonitorUpdateRequest" description: Edit a monitor request body. required: true responses: "200": content: application/json: examples: default: value: id: 123 message: Updated notification message for this monitor. name: Updated monitor name query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" type: query alert schema: $ref: "#/components/schemas/Monitor" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_write summary: Edit a monitor tags: - Monitors x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_write /api/v1/monitor/{monitor_id}/downtimes: get: deprecated: true description: |- Get all active v1 downtimes for the specified monitor. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: ListMonitorDowntimes parameters: - description: The id of the monitor in: path name: monitor_id required: true schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: - active: true disabled: false end: 1412793983 id: 1625 message: Scheduled maintenance scope: - env:staging start: 1412792983 schema: items: $ref: "#/components/schemas/Downtime" type: array description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Get active downtimes for a monitor tags: - Downtimes x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_read /api/v1/monitor/{monitor_id}/validate: post: description: |- Validate the monitor provided in the request. **Note**: Log monitors require an unscoped App Key and `logs_read_data` permission. operationId: ValidateExistingMonitor parameters: - description: The ID of the monitor in: path name: monitor_id required: true schema: example: 666486743 format: int64 type: integer requestBody: content: application/json: examples: default: value: message: "You may need to add web hosts if this is consistently high." name: "My monitor" options: no_data_timeframe: 20 notify_no_data: true query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" tags: - "app:webserver" - "frontend" type: "query alert" schema: $ref: "#/components/schemas/Monitor" description: Monitor request object required: true responses: "200": content: application/json: examples: default: value: {} schema: example: {} type: object description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid JSON "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Validate an existing monitor tags: - Monitors x-codegen-request-body-name: body "x-permission": operator: OR permissions: - monitors_read /api/v1/monthly_custom_reports: get: deprecated: true description: |- Get monthly custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetMonthlyCustomReports parameters: - description: The number of files to return in the response `[default=60].` in: query name: page[size] required: false schema: format: int64 type: integer - description: The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. in: query name: page[number] required: false schema: format: int64 type: integer - description: "The direction to sort by: `[desc, asc]`." in: query name: sort_dir required: false schema: $ref: "#/components/schemas/UsageSortDirection" - description: "The field to sort by: `[computed_on, size, start_date, end_date]`." in: query name: sort required: false schema: $ref: "#/components/schemas/UsageSort" responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: data: - attributes: computed_on: "2024-02-01" end_date: "2024-01-31" size: 2048 start_date: "2024-01-01" tags: - env id: "2024-01" type: reports meta: page: total_count: 1 schema: $ref: "#/components/schemas/UsageCustomReportsResponse" description: OK "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 summary: Get the list of available monthly custom reports tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/monthly_custom_reports/{report_id}: get: deprecated: true description: |- Get specified monthly custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetSpecifiedMonthlyCustomReports parameters: - description: Date of the report in the format `YYYY-MM-DD`. in: path name: report_id required: true schema: type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: data: attributes: computed_on: "2024-02-01" end_date: "2024-01-31" location: "https://example.s3.amazonaws.com/report.csv" size: 2048 start_date: "2024-01-01" tags: - env id: "2024-01" type: reports meta: page: total_count: 1 schema: $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse" 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 "404": content: application/json;datetime-format=rfc3339: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": content: application/json;datetime-format=rfc3339: schema: $ref: "#/components/schemas/APIErrorResponse" description: Too many requests summary: Get specified monthly custom reports tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/notebooks: get: description: |- Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook `name` or author `handle`. operationId: ListNotebooks parameters: - description: Return notebooks created by the given `author_handle`. in: query name: author_handle required: false schema: example: test@datadoghq.com type: string style: form - description: Return notebooks not created by the given `author_handle`. in: query name: exclude_author_handle required: false schema: example: test@datadoghq.com type: string style: form - description: The index of the first notebook you want returned. in: query name: start required: false schema: example: 0 format: int64 type: integer style: form - description: The number of notebooks to be returned. in: query name: count required: false schema: default: 100 example: 5 format: int64 type: integer style: form - description: Sort by field `modified`, `name`, or `created`. in: query name: sort_field required: false schema: default: modified example: modified type: string style: form - description: Sort by direction `asc` or `desc`. in: query name: sort_dir required: false schema: default: desc example: desc type: string style: form - description: Return only notebooks with `query` string in notebook name or author handle. in: query name: query required: false schema: example: postmortem type: string style: form - description: Value of `false` excludes the `cells` and global `time` for each notebook. in: query name: include_cells required: false schema: default: true example: false type: boolean style: form - description: True value returns only template notebooks. Default is false (returns only non-template notebooks). in: query name: is_template required: false schema: default: false example: false type: boolean style: form - description: If type is provided, returns only notebooks with that metadata type. Default does not have type filtering. in: query name: type required: false schema: example: investigation type: string style: form responses: "200": content: application/json: examples: default: value: data: - attributes: created: "2021-02-24T23:14:15.173964+00:00" modified: "2021-02-24T23:15:23.274966+00:00" name: "Example Notebook" status: published id: 123456 type: notebooks meta: page: total_count: 1 total_filtered_count: 1 schema: $ref: "#/components/schemas/NotebooksResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all notebooks tags: - Notebooks x-pagination: limitParam: count pageOffsetParam: start resultsPath: data "x-permission": operator: OR permissions: - notebooks_read post: description: Create a notebook using the specified options. operationId: CreateNotebook requestBody: content: application/json: examples: default: value: data: attributes: cells: - attributes: definition: text: "## Some test markdown\n\nWith some example content." type: markdown type: notebook_cells - attributes: definition: requests: - display_type: line q: "avg:system.load.1{*}" style: line_type: solid line_width: normal palette: dog_classic show_legend: true type: timeseries yaxis: scale: linear graph_size: m split_by: keys: [] tags: [] time: type: notebook_cells name: "Example Notebook" time: live_span: 1h type: notebooks json-request-body: value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}} schema: $ref: "#/components/schemas/NotebookCreateRequest" description: The JSON description of the notebook you want to create. required: true responses: "200": content: application/json: examples: default: value: data: attributes: cells: - attributes: definition: text: "## Some test markdown\n\nWith some example content." type: markdown id: "bzbycoya" type: notebook_cells created: "2021-02-24T23:14:15.173964+00:00" modified: "2021-02-24T23:15:23.274966+00:00" name: "Example Notebook" time: live_span: 1h id: 123456 type: notebooks schema: $ref: "#/components/schemas/NotebookResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a notebook tags: - Notebooks x-codegen-request-body-name: body "x-permission": operator: OR permissions: - notebooks_write /api/v1/notebooks/{notebook_id}: delete: description: Delete a notebook using the specified ID. operationId: DeleteNotebook parameters: - description: Unique ID, assigned when you create the notebook. in: path name: notebook_id required: true schema: format: int64 type: integer responses: "204": description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a notebook tags: - Notebooks "x-permission": operator: OR permissions: - notebooks_write get: description: Get a notebook using the specified notebook ID. operationId: GetNotebook parameters: - description: Unique ID, assigned when you create the notebook. in: path name: notebook_id required: true schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: data: attributes: cells: - attributes: definition: text: "## Example markdown" type: markdown id: abc-123 type: notebook_cells created: "2024-01-01T00:00:00+00:00" modified: "2024-01-01T00:00:00+00:00" name: Example Notebook status: published time: live_span: 1h id: 123 type: notebooks schema: $ref: "#/components/schemas/NotebookResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a notebook tags: - Notebooks "x-permission": operator: OR permissions: - notebooks_read put: description: Update a notebook using the specified ID. operationId: UpdateNotebook parameters: - description: Unique ID, assigned when you create the notebook. in: path name: notebook_id required: true schema: format: int64 type: integer requestBody: content: application/json: examples: default: value: data: attributes: cells: - attributes: definition: text: "## Some updated test markdown\n\nWith some example content." type: markdown type: notebook_cells - attributes: definition: requests: - display_type: bars q: "avg:system.load.1{*}" style: line_type: solid line_width: normal palette: warm show_legend: true type: timeseries yaxis: scale: linear graph_size: m split_by: keys: [] tags: [] time: id: "abcd1234" type: notebook_cells name: "Example Notebook" time: live_span: 1h type: notebooks json-request-body: value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some updated test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "bars", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "warm"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "abcd1234", "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}} schema: $ref: "#/components/schemas/NotebookUpdateRequest" description: Update notebook request body. required: true responses: "200": content: application/json: examples: default: value: data: attributes: cells: - attributes: definition: text: "## Some updated test markdown\n\nWith some example content." type: markdown id: "abcd1234" type: notebook_cells created: "2021-02-24T23:14:15.173964+00:00" modified: "2021-02-24T23:15:23.274966+00:00" name: "Example Notebook" time: live_span: 1h id: 123456 type: notebooks schema: $ref: "#/components/schemas/NotebookResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a notebook tags: - Notebooks x-codegen-request-body-name: body "x-permission": operator: OR permissions: - notebooks_write /api/v1/org: get: description: This endpoint returns data on your top-level organization. operationId: ListOrgs responses: "200": content: application/json: examples: default: value: orgs: - created: "2019-09-26T17:28:28Z" name: Example Org public_id: abc-123 schema: $ref: "#/components/schemas/OrganizationListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: List your managed organizations tags: - Organizations "x-permission": operator: OR permissions: - org_management post: description: |- Create a child organization. This endpoint requires the [multi-organization account](https://docs.datadoghq.com/account_management/multi_organization/) feature and must be enabled by [contacting support](https://docs.datadoghq.com/help/). Once a new child organization is created, you can interact with it by using the `org.public_id`, `api_key.key`, and `application_key.hash` provided in the response. operationId: CreateChildOrg requestBody: content: application/json: examples: default: value: billing: type: parent_billing name: "New child org" subscription: type: pro schema: $ref: "#/components/schemas/OrganizationCreateBody" description: Organization object that needs to be created required: true responses: "200": content: application/json: examples: default: value: org: created: "2019-09-26T17:28:28Z" name: New child org public_id: abc-123 user: email: test@example.com handle: test@example.com name: Example Name schema: $ref: "#/components/schemas/OrganizationCreateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a child organization tags: - Organizations x-codegen-request-body-name: body "x-permission": operator: OR permissions: - org_management /api/v1/org/{public_id}: get: description: Get organization information. operationId: GetOrg parameters: - description: The `public_id` of the organization you are operating within. in: path name: public_id required: true schema: example: "abc123" type: string responses: "200": content: application/json: examples: default: value: org: created: "2019-09-26T17:28:28Z" name: Example Org public_id: abc-123 schema: $ref: "#/components/schemas/OrganizationResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get organization information tags: - Organizations put: description: Update your organization. operationId: UpdateOrg parameters: - description: The `public_id` of the organization you are operating within. in: path name: public_id required: true schema: example: "abc123" type: string requestBody: content: application/json: examples: default: value: billing: type: parent_billing name: "New child org" settings: saml: enabled: false saml_idp_initiated_login: enabled: false saml_strict_mode: enabled: false schema: $ref: "#/components/schemas/Organization" required: true responses: "200": content: application/json: examples: default: value: org: created: "2019-09-26T17:28:28Z" name: Example Org public_id: abc-123 schema: $ref: "#/components/schemas/OrganizationResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update your organization tags: - Organizations x-codegen-request-body-name: body /api/v1/org/{public_id}/downgrade: post: description: Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial. operationId: DowngradeOrg parameters: - description: The `public_id` of the organization you are operating within. in: path name: public_id required: true schema: example: "abc123" type: string responses: "200": content: application/json: examples: default: value: message: "Child organization abc-123 downgraded successfully" schema: $ref: "#/components/schemas/OrgDowngradedResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Spin-off Child Organization tags: - Organizations /api/v1/org/{public_id}/idp_metadata: post: description: |- There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP. * **Multipart Form-Data**: Post the IdP metadata file using a form post. * **XML Body:** Post the IdP metadata file as the body of the request. operationId: UploadIdPForOrg parameters: - description: The `public_id` of the organization you are operating with in: path name: public_id required: true schema: example: "abc123" type: string requestBody: content: multipart/form-data: examples: default: value: idp_file: "@/path/to/idp_metadata.xml" schema: $ref: "#/components/schemas/IdpFormData" required: true responses: "200": content: application/json: examples: default: value: message: IdP metadata successfully uploaded for example org schema: $ref: "#/components/schemas/IdpResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "415": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Unsupported Media Type "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Upload IdP metadata tags: - Organizations x-codegen-request-body-name: body /api/v1/query: get: description: Query timeseries points. operationId: QueryMetrics parameters: - description: Start of the queried time period, seconds since the Unix epoch. in: query name: from required: true schema: format: int64 type: integer - description: End of the queried time period, seconds since the Unix epoch. in: query name: to required: true schema: format: int64 type: integer - description: Query string. in: query name: query required: true schema: type: string responses: "200": content: application/json: examples: default: value: query: "avg:system.cpu.idle{*}" res_type: time_series series: - aggr: avg display_name: system.cpu.idle expression: "avg:system.cpu.idle{*}" metric: system.cpu.idle pointlist: - [1681683300000.0, 77.62145685254418] scope: "*" status: ok schema: $ref: "#/components/schemas/MetricsQueryResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - timeseries_query summary: Query timeseries points tags: - Metrics "x-permission": operator: OR permissions: - timeseries_query /api/v1/search: get: deprecated: true description: |- **Note**: This endpoint is deprecated. Use `/api/v2/metrics` instead. Search for metrics from the last 24 hours in Datadog. operationId: ListMetrics parameters: - description: Query string to search metrics upon. Can optionally be prefixed with `metrics:`. in: query name: q required: true schema: type: string responses: "200": content: application/json: examples: default: value: results: metrics: - system.cpu.idle - system.load.1 schema: $ref: "#/components/schemas/MetricSearchResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - metrics_read summary: Search metrics tags: - Metrics "x-permission": operator: OR permissions: - metrics_read /api/v1/security_analytics/signals/{signal_id}/add_to_incident: patch: description: >- Add a security signal to an incident. This makes it possible to search for signals by incident within the signal explorer and to view the signals on the incident timeline. operationId: AddSecurityMonitoringSignalToIncident parameters: - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: examples: default: value: incident_id: 2066 version: 0 schema: $ref: "#/components/schemas/AddSignalToIncidentRequest" description: Attributes describing the signal update. required: true responses: "200": content: application/json: examples: default: value: status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Add a security signal to an incident tags: ["Security Monitoring"] x-codegen-request-body-name: body "x-permission": operator: OR permissions: - security_monitoring_signals_write /api/v1/security_analytics/signals/{signal_id}/assignee: patch: deprecated: true description: |- This endpoint is deprecated - Modify the triage assignee of a security signal. operationId: EditSecurityMonitoringSignalAssignee parameters: - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: examples: default: value: assignee: "773b045d-ccf8-4808-bd3b-955ef6a8c940" version: 0 schema: $ref: "#/components/schemas/SignalAssigneeUpdateRequest" description: Attributes describing the signal update. required: true responses: "200": content: application/json: examples: default: value: status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Modify the triage assignee of a security signal tags: ["Security Monitoring"] x-codegen-request-body-name: body "x-permission": operator: OR permissions: - security_monitoring_signals_write /api/v1/security_analytics/signals/{signal_id}/state: patch: deprecated: true description: |- This endpoint is deprecated - Change the triage state of a security signal. operationId: EditSecurityMonitoringSignalState parameters: - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: examples: default: value: archiveReason: none state: open version: 0 schema: $ref: "#/components/schemas/SignalStateUpdateRequest" description: Attributes describing the signal update. required: true responses: "200": content: application/json: examples: default: value: status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Change the triage state of a security signal tags: ["Security Monitoring"] x-codegen-request-body-name: body "x-permission": operator: OR permissions: - security_monitoring_signals_write /api/v1/series: post: description: |- The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes). If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 64 bits for the value - 40 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size. operationId: SubmitMetrics parameters: - description: HTTP header used to compress the media-type. in: header name: Content-Encoding required: false schema: $ref: "#/components/schemas/MetricContentEncoding" requestBody: content: text/json: examples: default: value: series: - host: test.example.com metric: system.load.1 points: - [1636629071, 0.7] tags: - "environment:test" type: gauge dynamic-points: description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/dynamic-points.json.sh summary: Dynamic Points x-variables: NOW: $(date +%s) schema: $ref: "#/components/schemas/MetricsPayload" required: true responses: "202": content: text/json: examples: default: value: status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted "400": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "408": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Request timeout "413": content: text/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Payload too large "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] summary: Submit metrics tags: - Metrics x-codegen-request-body-name: body /api/v1/slo: get: description: Get a list of service level objective objects for your organization. operationId: ListSLOs parameters: - description: |- A comma separated list of the IDs of the service level objectives objects. example: "id1, id2, id3" in: query name: ids required: false schema: type: string - description: The query string to filter results based on SLO names. example: "monitor" in: query name: query required: false schema: type: string - description: The query string to filter results based on a single SLO tag. example: "env:prod" in: query name: tags_query required: false schema: type: string - description: |- The query string to filter results based on SLO numerator and denominator. example: "aws.elb.request_count" in: query name: metrics_query required: false schema: type: string - description: |- The number of SLOs to return in the response. in: query name: limit required: false schema: default: 1000 format: int64 type: integer - description: |- The specific offset to use as the beginning of the returned response. in: query name: offset required: false schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: data: - id: abc-123 name: "Custom Metric SLO" tags: - "env:prod" - "app:core" thresholds: - target: 95 timeframe: "7d" - target: 95 timeframe: "30d" warning: 97 type: metric errors: [] schema: $ref: "#/components/schemas/SLOListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Get all SLOs tags: - Service Level Objectives x-pagination: limitParam: limit pageOffsetParam: offset resultsPath: data "x-permission": operator: OR permissions: - slos_read post: description: Create a service level objective object. operationId: CreateSLO requestBody: content: application/json: examples: default: value: description: "Track the availability of our custom metric." name: "Custom Metric SLO" query: denominator: "sum:my.custom.metric{*}.as_count()" numerator: "sum:my.custom.metric{type:good}.as_count()" tags: - "env:prod" - "app:core" thresholds: - target: 95 timeframe: 7d - target: 95 timeframe: 30d warning: 97 type: metric schema: $ref: "#/components/schemas/ServiceLevelObjectiveRequest" description: Service level objective request object. required: true responses: "200": content: application/json: examples: default: value: data: - description: "Track the availability of our custom metric." id: abc-123 name: "Custom Metric SLO" tags: - "env:prod" - "app:core" thresholds: - target: 95 target_display: "95.0" timeframe: 7d type: metric errors: [] schema: $ref: "#/components/schemas/SLOListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_write summary: Create an SLO object tags: - Service Level Objectives x-codegen-request-body-name: body "x-permission": operator: OR permissions: - slos_write /api/v1/slo/bulk_delete: post: description: |- Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well. operationId: DeleteSLOTimeframeInBulk requestBody: content: application/json: examples: default: value: id1: - "7d" - "30d" id2: - "7d" - "30d" schema: $ref: "#/components/schemas/SLOBulkDelete" description: Delete multiple service level objective objects request body. required: true responses: "200": content: application/json: examples: default: value: data: deleted: [] updated: - abc-123 errors: [] schema: $ref: "#/components/schemas/SLOBulkDeleteResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_write summary: Bulk Delete SLO Timeframes tags: - Service Level Objectives x-codegen-request-body-name: body "x-permission": operator: OR permissions: - slos_write /api/v1/slo/can_delete: get: description: |- Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard. operationId: CheckCanDeleteSLO parameters: - description: |- A comma separated list of the IDs of the service level objectives objects. example: "id1, id2, id3" in: query name: ids required: true schema: type: string responses: "200": content: application/json: examples: default: value: data: ok: - abc-123 errors: {} schema: $ref: "#/components/schemas/CheckCanDeleteSLOResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "409": content: application/json: schema: $ref: "#/components/schemas/CheckCanDeleteSLOResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Check if SLOs can be safely deleted tags: - Service Level Objectives "x-permission": operator: OR permissions: - slos_read /api/v1/slo/correction: get: description: |- Get all Service Level Objective corrections. operationId: ListSLOCorrection parameters: - description: |- The specific offset to use as the beginning of the returned response. in: query name: offset required: false schema: format: int64 type: integer - description: |- The number of SLO corrections to return in the response. Default is 25. in: query name: limit required: false schema: default: 25 format: int64 type: integer responses: "200": content: application/json: examples: default: value: data: - attributes: category: Scheduled Maintenance end: 1600003600 slo_id: abc-123 start: 1600000000 timezone: UTC id: abc-123 type: correction schema: $ref: "#/components/schemas/SLOCorrectionListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Get all SLO corrections tags: - Service Level Objective Corrections x-pagination: limitParam: limit pageOffsetParam: offset resultsPath: data "x-permission": operator: OR permissions: - slos_read post: description: |- Create an SLO correction. Use `slo_id` to apply the correction to a single SLO, or `slo_query` to apply the correction to SLOs that match a query. Exactly one of `slo_id` or `slo_query` is required. operationId: CreateSLOCorrection requestBody: content: application/json: examples: default: value: data: attributes: category: "Scheduled Maintenance" description: "Planned maintenance window for database upgrade." end: 1600003600 slo_id: sloId start: 1600000000 timezone: UTC type: correction slo_query: value: data: attributes: category: "Scheduled Maintenance" description: "Planned maintenance window for checkout services." end: 1600003600 slo_query: "env:prod service:checkout" start: 1600000000 timezone: UTC type: correction schema: $ref: "#/components/schemas/SLOCorrectionCreateRequest" description: Create an SLO Correction required: true responses: "200": content: application/json: examples: default: value: data: attributes: category: Scheduled Maintenance end: 1600003600 slo_id: abc-123 start: 1600000000 timezone: UTC id: abc-123 type: correction schema: $ref: "#/components/schemas/SLOCorrectionResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: SLO Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_corrections summary: Create an SLO correction tags: - Service Level Objective Corrections x-codegen-request-body-name: body "x-permission": operator: OR permissions: - slos_corrections /api/v1/slo/correction/{slo_correction_id}: delete: description: |- Permanently delete the specified SLO correction object. operationId: DeleteSLOCorrection parameters: - description: The ID of the SLO correction object. in: path name: slo_correction_id required: true schema: type: string responses: "204": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an SLO correction tags: - Service Level Objective Corrections get: description: |- Get an SLO correction. operationId: GetSLOCorrection parameters: - description: The ID of the SLO correction object. in: path name: slo_correction_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: data: attributes: category: Scheduled Maintenance end: 1600003600 slo_id: abc-123 start: 1600000000 timezone: UTC id: abc-123 type: correction schema: $ref: "#/components/schemas/SLOCorrectionResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an SLO correction for an SLO tags: - Service Level Objective Corrections patch: description: Update the specified SLO correction object. operationId: UpdateSLOCorrection parameters: - description: The ID of the SLO correction object. in: path name: slo_correction_id required: true schema: type: string requestBody: content: application/json: examples: default: value: data: attributes: category: "Scheduled Maintenance" description: "Updated correction for maintenance window." end: 1600003600 start: 1600000000 timezone: UTC type: correction slo_query: value: data: attributes: category: "Scheduled Maintenance" description: "Updated correction for checkout services." end: 1600003600 slo_query: "env:prod service:checkout" start: 1600000000 timezone: UTC type: correction schema: $ref: "#/components/schemas/SLOCorrectionUpdateRequest" description: The edited SLO correction object. required: true responses: "200": content: application/json: examples: default: value: data: attributes: category: Scheduled Maintenance end: 1600003600 slo_id: abc-123 start: 1600000000 timezone: UTC id: abc-123 type: correction schema: $ref: "#/components/schemas/SLOCorrectionResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an SLO correction tags: - Service Level Objective Corrections x-codegen-request-body-name: body /api/v1/slo/search: get: description: Get a list of service level objective objects for your organization. operationId: SearchSLO parameters: - description: |- The query string to filter results based on SLO names. Some examples of queries include `service:` and ``. in: query name: query required: false schema: type: string - description: The number of files to return in the response `[default=10]`. in: query name: page[size] required: false schema: format: int64 type: integer - description: The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. in: query name: page[number] required: false schema: format: int64 type: integer - description: Whether or not to return facet information in the response `[default=false]`. in: query name: include_facets required: false schema: type: boolean responses: "200": content: application/json: examples: default: value: data: attributes: slos: - data: attributes: name: Example SLO thresholds: - target: 95 target_display: "95" timeframe: 7d id: abc-123 type: slo type: service_level_objective_search_results schema: $ref: "#/components/schemas/SearchSLOResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Search for SLOs tags: - Service Level Objectives "x-permission": operator: OR permissions: - slos_read /api/v1/slo/{slo_id}: delete: description: |- Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the `DELETE /v1/slo/` endpoint returns a 409 conflict error because the SLO is referenced in a dashboard. operationId: DeleteSLO parameters: - description: The ID of the service level objective. in: path name: slo_id required: true schema: type: string - description: Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor). in: query name: force required: false schema: type: string responses: "200": content: application/json: examples: default: value: data: - abc-123 errors: {} schema: $ref: "#/components/schemas/SLODeleteResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not found "409": content: application/json: schema: $ref: "#/components/schemas/SLODeleteResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_write summary: Delete an SLO tags: - Service Level Objectives "x-permission": operator: OR permissions: - slos_write get: description: Get a service level objective object. operationId: GetSLO parameters: - description: The ID of the service level objective object. in: path name: slo_id required: true schema: type: string - description: Get the IDs of SLO monitors that reference this SLO. example: true in: query name: with_configured_alert_ids required: false schema: type: boolean responses: "200": content: application/json: examples: default: value: data: description: "Track the availability of our custom metric." id: abc-123 name: "Custom Metric SLO" tags: - "env:prod" thresholds: - target: 95 target_display: "95.0" timeframe: 7d type: metric errors: [] schema: $ref: "#/components/schemas/SLOResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Get an SLO's details tags: - Service Level Objectives "x-permission": operator: OR permissions: - slos_read put: description: Update the specified service level objective object. operationId: UpdateSLO parameters: - description: The ID of the service level objective object. in: path name: slo_id required: true schema: type: string requestBody: content: application/json: examples: default: value: description: "Updated description for the SLO." name: "Custom Metric SLO" query: denominator: "sum:my.custom.metric{*}.as_count()" numerator: "sum:my.custom.metric{type:good}.as_count()" tags: - "env:prod" - "app:core" thresholds: - target: 95 timeframe: 7d - target: 95 timeframe: 30d warning: 97 type: metric schema: $ref: "#/components/schemas/ServiceLevelObjective" description: The edited service level objective request object. required: true responses: "200": content: application/json: examples: default: value: data: - description: "Updated description for the SLO." id: abc-123 name: "Custom Metric SLO" tags: - "env:prod" thresholds: - target: 95 target_display: "95.0" timeframe: 7d type: metric errors: [] schema: $ref: "#/components/schemas/SLOListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_write summary: Update an SLO tags: - Service Level Objectives x-codegen-request-body-name: body "x-permission": operator: OR permissions: - slos_write /api/v1/slo/{slo_id}/corrections: get: description: |- Get corrections applied to an SLO operationId: GetSLOCorrections parameters: - description: The ID of the service level objective object. in: path name: slo_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: data: - attributes: category: Scheduled Maintenance end: 1600003600 slo_id: abc-123 start: 1600000000 timezone: UTC id: abc-123 type: correction schema: $ref: "#/components/schemas/SLOCorrectionListResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Get Corrections For an SLO tags: - Service Level Objectives "x-permission": operator: OR permissions: - slos_read /api/v1/slo/{slo_id}/history: get: description: |- Get a specific SLO’s history, regardless of its SLO type. The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history. **Note:** There are different response formats for event based and time based SLOs. Examples of both are shown. operationId: GetSLOHistory parameters: - description: The ID of the service level objective object. in: path name: slo_id required: true schema: type: string - description: The `from` timestamp for the query window in epoch seconds. in: query name: from_ts required: true schema: format: int64 type: integer - description: The `to` timestamp for the query window in epoch seconds. in: query name: to_ts required: true schema: format: int64 type: integer - description: The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`. in: query name: target schema: exclusiveMaximum: true exclusiveMinimum: true format: double maximum: 100 minimum: 0 type: number - description: |- Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`, then the corrections will not be applied and the SLI values will not be affected. in: query name: apply_correction required: false schema: type: boolean responses: "200": content: application/json: examples: default: value: data: from_ts: 1615323990 overall: sli_value: 99.99 span_precision: 2.0 thresholds: "7d": target: 95 timeframe: 7d to_ts: 1615928790 type: metric type_id: 1 errors: schema: $ref: "#/components/schemas/SLOHistoryResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - slos_read summary: Get an SLO's history tags: - Service Level Objectives "x-permission": operator: OR permissions: - slos_read /api/v1/synthetics/ci/batch/{batch_id}: get: description: Get a batch's updated details. operationId: GetSyntheticsCIBatch parameters: - description: The ID of the batch. in: path name: batch_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: data: results: - location: "aws:eu-west-3" result_id: "abc-123" status: passed test_name: "Example API test" test_public_id: "abc-def-123" test_type: api status: passed schema: $ref: "#/components/schemas/SyntheticsBatchDetails" description: OK "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Batch does not exist. "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get details of batch tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/locations: get: description: |- Get the list of public and private locations available for Synthetic tests. No arguments required. operationId: ListLocations responses: "200": content: application/json: examples: default: value: locations: - id: "aws:eu-west-3" name: "Paris (AWS)" schema: $ref: "#/components/schemas/SyntheticsLocations" description: OK "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_private_location_read summary: Get all locations (public and private) tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_private_location_read /api/v1/synthetics/private-locations: post: description: Create a new Synthetic private location. operationId: CreatePrivateLocation requestBody: content: application/json: examples: default: value: description: Description of private location name: New private location tags: - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: Details of the private location to create. required: true responses: "200": content: application/json: examples: default: value: private_location: description: "Description of private location" id: "pl:new-private-location-abc-123" name: "New private location" tags: - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponse" description: OK "402": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Quota reached for private locations "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Private locations are not activated for the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_private_location_write summary: Create a private location tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_private_location_write /api/v1/synthetics/private-locations/{location_id}: delete: description: Delete a Synthetic private location. operationId: DeletePrivateLocation parameters: - description: The ID of the private location. in: path name: location_id required: true schema: type: string responses: "204": description: OK "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Private locations are not activated for the user - Private location does not exist "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_private_location_write summary: Delete a private location tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_private_location_write get: description: Get a Synthetic private location. operationId: GetPrivateLocation parameters: - description: The ID of the private location. in: path name: location_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: description: "Description of private location" id: "pl:new-private-location-abc-123" name: "New private location" tags: - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: OK "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic private locations are not activated for the user - Private location does not exist "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_private_location_read summary: Get a private location tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_private_location_read put: description: Edit a Synthetic private location. operationId: UpdatePrivateLocation parameters: - description: The ID of the private location. in: path name: location_id required: true schema: type: string requestBody: content: application/json: examples: default: value: description: Description of private location name: New private location tags: - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: Details of the private location to be updated. required: true responses: "200": content: application/json: examples: default: value: description: "Description of private location" id: "pl:new-private-location-abc-123" name: "New private location" tags: - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: OK "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Private locations are not activated for the user - Private location does not exist "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_private_location_write summary: Edit a private location tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_private_location_write /api/v1/synthetics/settings/default_locations: get: description: Get the default locations settings. operationId: GetSyntheticsDefaultLocations responses: "200": content: application/json: examples: default: value: - "aws:eu-west-3" - "aws:us-east-1" schema: $ref: "#/components/schemas/SyntheticsDefaultLocations" description: OK "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the default locations tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_default_settings_read /api/v1/synthetics/tests: get: description: Get the list of all Synthetic tests. operationId: ListTests parameters: - description: Used for pagination. The number of tests returned in the page. in: query name: page_size required: false schema: default: 100 format: int64 type: integer - description: Used for pagination. Which page you want to retrieve. Starts at zero. in: query name: page_number required: false schema: format: int64 type: integer responses: "200": content: application/json: examples: default: value: tests: - locations: - "aws:eu-west-3" name: "Example API test" public_id: "abc-def-123" status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsListTestsResponse" description: OK - Returns the list of all Synthetic tests. "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Synthetic Monitoring is not activated for the user. "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get the list of all Synthetic tests tags: - Synthetics x-pagination: limitParam: page_size pageParam: page_number resultsPath: tests "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/api: post: description: Create a Synthetic API test. operationId: CreateSyntheticsAPITest requestBody: content: application/json: examples: 1-simple-api-test: description: Example of an API test. summary: Create an API test. value: config: assertions: - operator: lessThan target: 1000 type: responseTime - operator: is target: 200 type: statusCode - operator: is property: content-type target: text/html; charset=UTF-8 type: header request: method: GET url: "https://example.com" locations: - "azure:eastus" - "aws:eu-west-3" message: MY_NOTIFICATION_MESSAGE name: MY_TEST_NAME options: min_failure_duration: 0 min_location_failed: 1 monitor_options: renotify_interval: 0 tick_every: 60 status: live subtype: http tags: - "env:production" type: api 2-multistep-api-test: description: |- Example of a multistep API test running on a fake furniture store. It creates a card, select a product and then add the product to the card. summary: Create a Multistep API test value: config: steps: - assertions: - operator: lessThan target: 30000 type: responseTime extractedValues: - field: location name: CART_ID parser: type: regex value: '(?:[^\\/](?!(\\|/)))+$' type: http_header name: Get a cart request: method: POST timeout: 30 url: "https://api.shopist.io/carts" subtype: http - assertions: - operator: is target: 200 type: statusCode extractedValues: - name: PRODUCT_ID parser: type: json_path value: "$[0].id['$oid']" type: http_body name: Get a product request: method: GET timeout: 30 url: "https://api.shopist.io/products.json" subtype: http - assertions: - operator: is target: 201 type: statusCode name: Add product to cart request: body: |- { "cart_item": { "product_id": "{{ PRODUCT_ID }}", "amount_paid": 500, "quantity": 1 }, "cart_id": "{{ CART_ID }}" } headers: content-type: application/json method: POST timeout: 30 url: "https://api.shopist.io/add_item.json" subtype: http locations: - "aws:us-west-2" message: MY_NOTIFICATION_MESSAGE name: MY_TEST_NAME options: ci: executionRule: blocking min_failure_duration: 5400 min_location_failed: 1 monitor_options: renotify_interval: 0 retry: count: 3 interval: 300 tick_every: 900 status: live subtype: multi tags: - "env:prod" type: api default: value: config: assertions: - operator: is target: 200 type: statusCode request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: Notification message name: Example API test options: min_failure_duration: 0 min_location_failed: 1 tick_every: 60 status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: Details of the test to create. required: true responses: "200": content: application/json: examples: default: value: config: assertions: - operator: is target: 200 type: statusCode request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "Notification message" monitor_id: 12345678 name: "Example API test" options: min_failure_duration: 0 min_location_failed: 1 tick_every: 60 public_id: "abc-123-def" status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: OK - Returns the created test details. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Creation failed "402": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Test quota is reached "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Create an API test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/api/{public_id}: get: description: |- Get the detailed configuration associated with a Synthetic API test. operationId: GetAPITest parameters: - description: The public ID of the test to get details from. in: path name: public_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: config: request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "Notification message" name: "Example API test" options: tick_every: 60 public_id: "abc-def-123" status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get an API test tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read put: description: Edit the configuration of a Synthetic API test. operationId: UpdateAPITest parameters: - description: The public ID of the test to get details from. in: path name: public_id required: true schema: type: string requestBody: content: application/json: examples: default: value: config: assertions: - operator: is target: 200 type: statusCode request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: Notification message name: Example API test options: min_failure_duration: 0 min_location_failed: 1 tick_every: 60 status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: New test details to be saved. required: true responses: "200": content: application/json: examples: default: value: config: request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "Notification message" name: "Example API test" options: tick_every: 60 public_id: "abc-def-123" status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Updating sub-type is forbidden "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Edit an API test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/browser: post: description: Create a Synthetic browser test. operationId: CreateSyntheticsBrowserTest requestBody: content: application/json: examples: default: value: config: assertions: [] request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "" name: Example browser test options: device_ids: - chrome.laptop_large tick_every: 3600 status: live steps: - name: Check current URL params: check: contains value: example type: assertCurrentUrl tags: - "env:production" type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: Details of the test to create. required: true responses: "200": content: application/json: examples: default: value: config: assertions: [] request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "" name: "Example browser test" options: device_ids: - chrome.laptop_large tick_every: 3600 public_id: "abc-def-123" status: live tags: - "env:production" type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK - Returns the created test details. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Creation failed "402": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Test quota is reached "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Create a browser test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/browser/{public_id}: get: description: |- Get the detailed configuration (including steps) associated with a Synthetic browser test. operationId: GetBrowserTest parameters: - description: The public ID of the test to get details from. in: path name: public_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: config: assertions: [] request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "" name: "Example browser test" options: device_ids: - chrome.laptop_large tick_every: 3600 public_id: "abc-def-123" status: live tags: - "env:production" type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get a browser test tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read put: description: Edit the configuration of a Synthetic browser test. operationId: UpdateBrowserTest parameters: - description: The public ID of the test to edit. in: path name: public_id required: true schema: type: string requestBody: content: application/json: examples: default: value: config: assertions: [] request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "" name: Example browser test options: device_ids: - chrome.laptop_large tick_every: 3600 status: live steps: - name: Check current URL params: check: contains value: example type: assertCurrentUrl tags: - "env:production" type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: New test details to be saved. required: true responses: "200": content: application/json: examples: default: value: config: assertions: [] request: method: GET url: "https://example.com" locations: - "aws:eu-west-3" message: "" name: "Example browser test" options: device_ids: - chrome.laptop_large tick_every: 3600 public_id: "abc-def-123" status: live tags: - "env:production" type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Updating sub-type is forbidden "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Edit a browser test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/browser/{public_id}/results: get: description: |- Get the last 150 test results summaries for a given Synthetic browser test. operationId: GetBrowserTestLatestResults parameters: - description: |- The public ID of the browser test for which to search results for. in: path name: public_id required: true schema: type: string - description: Timestamp in milliseconds from which to start querying results. in: query name: from_ts required: false schema: format: int64 type: integer - description: Timestamp in milliseconds up to which to query results. in: query name: to_ts required: false schema: format: int64 type: integer - description: Locations for which to query results. in: query name: probe_dc required: false schema: items: type: string type: array responses: "200": content: application/json: examples: default: value: last_timestamp_fetched: 1706745600000 results: - check_time: 1706745600000 probe_dc: "aws:eu-west-3" result_id: "abc-123" status: 0 schema: $ref: "#/components/schemas/SyntheticsGetBrowserTestLatestResultsResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get a browser test's latest results summaries tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/browser/{public_id}/results/{result_id}: get: description: Get a specific full result from a given Synthetic browser test. operationId: GetBrowserTestResult parameters: - description: |- The public ID of the browser test to which the target result belongs. in: path name: public_id required: true schema: type: string - description: The ID of the result to get. in: path name: result_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: check_time: 1706745600000 probe_dc: "aws:eu-west-3" result_id: "abc-123" status: 0 schema: $ref: "#/components/schemas/SyntheticsBrowserTestResultFull" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test or result is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get a browser test result tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/delete: post: description: Delete multiple Synthetic tests by ID. operationId: DeleteTests requestBody: content: application/json: examples: default: value: public_ids: - "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsDeleteTestsPayload" description: Public ID list of the Synthetic tests to be deleted. required: true responses: "200": content: application/json: examples: default: value: deleted_tests: - deleted_at: "2024-01-01T00:00:00+00:00" public_id: "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsDeleteTestsResponse" description: OK. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Tests to be deleted can't be found - Synthetic is not activated for the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Delete tests tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/mobile: post: description: Create a Synthetic mobile test. operationId: CreateSyntheticsMobileTest requestBody: content: application/json: examples: default: value: config: variables: [] message: Notification message name: Example mobile test options: device_ids: - "synthetics:mobile:device:apple_iphone_14_ios_16" min_failure_duration: 0 mobileApplication: applicationId: "abc-123" referenceId: "abc-456" referenceType: latest tick_every: 3600 tags: - "env:production" type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: Details of the test to create. required: true responses: "200": content: application/json: examples: default: value: config: variables: [] message: "Notification message" name: "Example mobile test" options: device_ids: - "synthetics:mobile:device:apple_iphone_14_ios_16" mobileApplication: applicationId: "abc-123" referenceId: "abc-456" referenceType: latest tick_every: 3600 public_id: "abc-def-123" status: live tags: - "env:production" type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK - Returns the created test details. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Creation failed "402": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Test quota is reached "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Create a mobile test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/mobile/{public_id}: get: description: |- Get the detailed configuration associated with a Synthetic mobile test. operationId: GetMobileTest parameters: - description: The public ID of the test to get details from. in: path name: public_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: config: variables: [] message: "Notification message" name: "Example mobile test" options: device_ids: - "synthetics:mobile:device:apple_iphone_14_ios_16" mobileApplication: applicationId: "abc-123" referenceId: "abc-456" referenceType: latest tick_every: 3600 public_id: "abc-def-123" status: live tags: - "env:production" type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get a mobile test tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read put: description: Edit the configuration of a Synthetic mobile test. operationId: UpdateMobileTest parameters: - description: The public ID of the test to get details from. in: path name: public_id required: true schema: type: string requestBody: content: application/json: examples: default: value: config: variables: [] message: Notification message name: Example mobile test options: device_ids: - "synthetics:mobile:device:apple_iphone_14_ios_16" min_failure_duration: 0 mobileApplication: applicationId: "abc-123" referenceId: "abc-456" referenceType: latest tick_every: 3600 tags: - "env:production" type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: New test details to be saved. required: true responses: "200": content: application/json: examples: default: value: config: variables: [] message: "Notification message" name: "Example mobile test" options: device_ids: - "synthetics:mobile:device:apple_iphone_14_ios_16" mobileApplication: applicationId: "abc-123" referenceId: "abc-456" referenceType: latest tick_every: 3600 public_id: "abc-def-123" status: live tags: - "env:production" type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Updating sub-type is forbidden "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Edit a mobile test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/search: get: description: |- Search for Synthetic tests. operationId: SearchTests parameters: - description: The search query. in: query name: text required: false schema: type: string - description: If true, include the full configuration for each test in the response. in: query name: include_full_config required: false schema: type: boolean - description: If true, return only facets instead of full test details. in: query name: facets_only required: false schema: type: boolean - description: The offset from which to start returning results. in: query name: start required: false schema: default: 0 format: int64 type: integer - description: The maximum number of results to return. in: query name: count required: false schema: default: 50 format: int64 type: integer - description: The sort order for the results (e.g., `name,asc` or `name,desc`). in: query name: sort required: false schema: default: name,asc type: string responses: "200": content: application/json: examples: default: value: tests: - locations: - aws:eu-west-3 message: Test notification name: Example Test public_id: abc-def-123 status: live tags: - env:prod type: api schema: $ref: "#/components/schemas/SyntheticsListTestsResponse" description: OK - Returns the list of Synthetic tests matching the search. "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Search Synthetic tests tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/trigger: post: description: Trigger a set of Synthetic tests. operationId: TriggerTests requestBody: content: application/json: examples: default: value: tests: - public_id: aaa-aaa-aaa schema: $ref: "#/components/schemas/SyntheticsTriggerBody" description: The identifiers of the tests to trigger. required: true responses: "200": content: application/json: examples: default: value: batch_id: abc-123 results: - location: 1 public_id: "abc-def-123" result_id: "abc-123" triggered_check_ids: - "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Trigger Synthetic tests tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/trigger/ci: post: description: Trigger a set of Synthetic tests for continuous integration. operationId: TriggerCITests requestBody: content: application/json: examples: default: value: tests: - public_id: aaa-aaa-aaa schema: $ref: "#/components/schemas/SyntheticsCITestBody" description: Details of the test to trigger. required: true responses: "200": content: application/json: examples: default: value: batch_id: abc-123 results: - location: 1 public_id: "abc-def-123" result_id: "abc-123" triggered_check_ids: - "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: JSON format is wrong "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Trigger tests from CI/CD pipelines tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/uptimes: post: description: Fetch uptime for multiple Synthetic tests by ID. operationId: FetchUptimes requestBody: content: application/json: examples: default: value: from_ts: 1726041488 public_ids: - "abc-def-123" to_ts: 1726127888 schema: $ref: "#/components/schemas/SyntheticsFetchUptimesPayload" description: Public ID list of the Synthetic tests and timeframe. required: true responses: "200": content: application/json: examples: default: value: - from_ts: 1726041488 overall: group: "name" history: - [1726041488, 0] span_precision: 2.0 uptime: 99.99 public_id: abc-def-123 to_ts: 1726127888 schema: items: $ref: "#/components/schemas/SyntheticsTestUptime" type: array description: OK. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Fetch uptime for multiple tests tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/{public_id}: get: description: Get the detailed configuration associated with a Synthetic test. operationId: GetTest parameters: - description: The public ID of the test to get details from. in: path name: public_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: locations: - "aws:eu-west-3" message: "Notification message" name: "Example test" public_id: "abc-def-123" status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get a test configuration tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read patch: description: Patch the configuration of a Synthetic test with partial data. operationId: PatchTest parameters: - description: The public ID of the test to patch. in: path name: public_id required: true schema: type: string requestBody: content: application/json: examples: default: value: data: - op: replace path: /name value: New test name - op: remove path: /config/assertions/0 schema: $ref: "#/components/schemas/SyntheticsPatchTestBody" description: "[JSON Patch](https://jsonpatch.com/) compliant list of operations" required: true responses: "200": content: application/json: examples: default: value: locations: - "aws:eu-west-3" message: "Notification message" name: "New test name" public_id: "abc-def-123" status: live subtype: http tags: - "env:production" type: api schema: $ref: "#/components/schemas/SyntheticsTestDetails" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - JSON format is wrong - Updating sub-type is forbidden "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Patch a Synthetic test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/tests/{public_id}/results: get: description: |- Get the last 150 test results summaries for a given Synthetic API test. operationId: GetAPITestLatestResults parameters: - description: The public ID of the test for which to search results for. in: path name: public_id required: true schema: type: string - description: Timestamp in milliseconds from which to start querying results. in: query name: from_ts required: false schema: format: int64 type: integer - description: Timestamp in milliseconds up to which to query results. in: query name: to_ts required: false schema: format: int64 type: integer - description: Locations for which to query results. in: query name: probe_dc required: false schema: items: type: string type: array responses: "200": content: application/json: examples: default: value: last_timestamp_fetched: 1706745600000 results: - check_time: 1706745600000 probe_dc: "aws:eu-west-3" result: passed: true result_id: "abc-123" status: 0 schema: $ref: "#/components/schemas/SyntheticsGetAPITestLatestResultsResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get an API test's latest results summaries tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/{public_id}/results/{result_id}: get: description: Get a specific full result from a given Synthetic API test. operationId: GetAPITestResult parameters: - description: The public ID of the API test to which the target result belongs. in: path name: public_id required: true schema: type: string - description: The ID of the result to get. in: path name: result_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: check_time: 1706745600000 probe_dc: "aws:eu-west-3" result_id: "abc-123" status: 0 schema: $ref: "#/components/schemas/SyntheticsAPITestResultFull" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test or result is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_read summary: Get an API test result tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_read /api/v1/synthetics/tests/{public_id}/status: put: description: Pause or start a Synthetic test by changing the status. operationId: UpdateTestPauseStatus parameters: - description: The public ID of the Synthetic test to update. in: path name: public_id required: true schema: type: string requestBody: content: application/json: examples: default: value: new_status: live schema: $ref: "#/components/schemas/SyntheticsUpdateTestPauseStatusPayload" description: Status to set the given Synthetic test to. required: true responses: "200": content: application/json: examples: default: value: true schema: type: boolean description: OK - Returns a boolean indicating if the update was successful. "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: JSON format is wrong. "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: |- - Synthetic Monitoring is not activated for the user - Test is not owned by the user "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_write summary: Pause or start a test tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_write /api/v1/synthetics/variables: get: description: Get the list of all Synthetic global variables. operationId: ListGlobalVariables responses: "200": content: application/json: examples: default: value: variables: - description: "Example description" id: abc-123 name: "MY_VARIABLE" tags: - "team:front" value: secure: false value: "example-value" schema: $ref: "#/components/schemas/SyntheticsListGlobalVariablesResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_global_variable_read - AuthZ: - apm_api_catalog_read summary: Get all global variables tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_global_variable_read - apm_api_catalog_read post: description: Create a Synthetic global variable. operationId: CreateGlobalVariable requestBody: content: application/json: examples: default: value: description: Example description name: MY_VARIABLE tags: - "team:front" - "test:workflow-1" value: secure: false value: variable-value schema: $ref: "#/components/schemas/SyntheticsGlobalVariableRequest" description: Details of the global variable to create. required: true responses: "200": content: application/json: examples: default: value: description: "Example description" id: abc-123 name: "MY_VARIABLE" tags: - "team:front" - "test:workflow-1" value: secure: false value: "variable-value" schema: $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_global_variable_write summary: Create a global variable tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_global_variable_write /api/v1/synthetics/variables/{variable_id}: delete: description: Delete a Synthetic global variable. operationId: DeleteGlobalVariable parameters: - description: The ID of the global variable. in: path name: variable_id required: true schema: type: string responses: "200": description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: JSON format is wrong "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_global_variable_write summary: Delete a global variable tags: - Synthetics "x-permission": operator: OR permissions: - synthetics_global_variable_write get: description: Get the detailed configuration of a global variable. operationId: GetGlobalVariable parameters: - description: The ID of the global variable. in: path name: variable_id required: true schema: type: string responses: "200": content: application/json: examples: default: value: description: "Example description" id: abc-123 name: "MY_VARIABLE" tags: - "team:front" value: secure: false value: "variable-value" schema: $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_global_variable_read summary: Get a global variable tags: - Synthetics put: description: Edit a Synthetic global variable. operationId: EditGlobalVariable parameters: - description: The ID of the global variable. in: path name: variable_id required: true schema: type: string requestBody: content: application/json: examples: default: value: description: Example description name: MY_VARIABLE tags: - "team:front" - "test:workflow-1" value: secure: false value: variable-value schema: $ref: "#/components/schemas/SyntheticsGlobalVariableRequest" description: Details of the global variable to update. required: true responses: "200": content: application/json: examples: default: value: description: "Example description" id: abc-123 name: "MY_VARIABLE" tags: - "team:front" - "test:workflow-1" value: secure: false value: "variable-value" schema: $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Invalid request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - synthetics_global_variable_write summary: Edit a global variable tags: - Synthetics x-codegen-request-body-name: body "x-permission": operator: OR permissions: - synthetics_global_variable_write /api/v1/tags/hosts: get: description: Returns a mapping of tags to hosts. For each tag, the response returns a list of host names that contain this tag. There is a restriction of 10k total host names from the org that can be attached to tags and returned. operationId: ListHostTags parameters: - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. in: query name: source required: false schema: type: string responses: "200": content: application/json: examples: default: value: tags: environment:production: - test.metric.host schema: $ref: "#/components/schemas/TagToHosts" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Get All Host Tags tags: - Tags "x-permission": operator: OPEN permissions: [] /api/v1/tags/hosts/{host_name}: delete: description: |- This endpoint allows you to remove all tags for a single host. If no source is specified, only deletes from the source "User". operationId: DeleteHostTags parameters: - description: Specified host name to delete tags in: path name: host_name required: true schema: type: string - description: |- Source of the tags to be deleted. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. in: query name: source required: false schema: type: string responses: "204": description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Remove host tags tags: - Tags get: description: Return the list of tags that apply to a given host. operationId: GetHostTags parameters: - description: Name of the host to retrieve tags for in: path name: host_name required: true schema: type: string - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. in: query name: source required: false schema: type: string responses: "200": content: application/json: examples: default: value: host: test.host tags: - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Host Tags tags: - Tags post: description: |- This endpoint allows you to add new tags to a host, optionally specifying what source these tags come from. If tags already exist, appends new tags to the tag list. If no source is specified, defaults to "user". operationId: CreateHostTags parameters: - description: Specified host name to add new tags in: path name: host_name required: true schema: type: string - description: |- Source to add tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. If no source is specified, defaults to "user". example: "chef" in: query name: source required: false schema: type: string requestBody: content: application/json: examples: default: value: host: test.host tags: - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Update host tags request body. required: true responses: "201": content: application/json: examples: default: value: host: test.host tags: - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Created "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Add tags to a host tags: - Tags x-codegen-request-body-name: body put: description: |- This endpoint allows you to update/replace all tags in an integration source with those supplied in the request. operationId: UpdateHostTags parameters: - description: Specified host name to change tags in: path name: host_name required: true schema: type: string - description: |- Source to update tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. If no source specified, defaults to "user". in: query name: source required: false schema: type: string requestBody: content: application/json: examples: default: value: host: test.host tags: - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Add tags to host required: true responses: "201": content: application/json: examples: default: value: host: test.host tags: - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update host tags tags: - Tags x-codegen-request-body-name: body /api/v1/usage/analyzed_logs: get: deprecated: true description: |- Get hourly usage for analyzed logs (Security Monitoring). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageAnalyzedLogs parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - analyzed_logs: 50 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageAnalyzedLogsResponse" 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: Get hourly usage for analyzed logs tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/audit_logs: get: deprecated: true description: |- Get hourly usage for audit logs. **Note:** This endpoint has been deprecated. operationId: GetUsageAuditLogs parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" lines_indexed: 1000 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageAuditLogsResponse" 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: Get hourly usage for audit logs tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/aws_lambda: get: deprecated: true description: |- Get hourly usage for Lambda. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageLambda parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - func_count: 10 hour: "2024-01-01T00:00:00+00:00" invocations_sum: 100 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageLambdaResponse" 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: Get hourly usage for Lambda tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/billable-summary: get: description: |- Get billable usage across your account. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetUsageBillableSummary parameters: - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month." in: query name: month required: false schema: format: date-time type: string - 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: include_connected_accounts required: false schema: default: false type: boolean responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - account_name: Example Name account_public_id: abc-123 end_date: "2024-01-31T00:00:00+00:00" num_orgs: 1 org_name: example-handle public_id: abc-123 start_date: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/UsageBillableSummaryResponse" 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: Get billable usage across your account tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/ci-app: get: deprecated: true description: |- Get hourly usage for CI visibility (tests, pipeline, and spans). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageCIApp parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - ci_pipeline_indexed_spans: 1000 ci_test_indexed_spans: 2000 ci_visibility_itr_committers: 5 ci_visibility_pipeline_committers: 3 ci_visibility_test_committers: 10 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageCIVisibilityResponse" 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: Get hourly usage for CI visibility tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/cspm: get: deprecated: true description: |- Get hourly usage for cloud security management (CSM) pro. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageCloudSecurityPostureManagement parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - aws_host_count: 2.0 azure_host_count: 1.0 container_count: 10.0 gcp_host_count: 1.0 host_count: 5.0 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageCloudSecurityPostureManagementResponse" 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: Get hourly usage for CSM Pro tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/cws: get: deprecated: true description: |- Get hourly usage for cloud workload security. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageCWS parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - cws_container_count: 10 cws_host_count: 5 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageCWSResponse" 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: Get hourly usage for cloud workload security tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/dbm: get: deprecated: true description: |- Get hourly usage for database monitoring **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageDBM parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - dbm_host_count: 5 dbm_queries_count: 100 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageDBMResponse" 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: Get hourly usage for database monitoring tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/fargate: get: deprecated: true description: |- Get hourly usage for [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageFargate parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - apm_fargate_count: 2 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 tasks_count: 5 schema: $ref: "#/components/schemas/UsageFargateResponse" 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: Get hourly usage for Fargate tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/hosts: get: deprecated: true description: |- Get hourly usage for hosts and containers. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageHosts parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - agent_host_count: 1 apm_host_count: 1 aws_host_count: 0 container_count: 2 gcp_host_count: 0 host_count: 1 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageHostsResponse" 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: Get hourly usage for hosts and containers tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/hourly-attribution: get: description: |- Get hourly usage attribution. Multi-region data is available starting March 1, 2023. This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is set in the response. If it is, make another request and pass `next_record_id` as a parameter. Pseudo code example: ``` response := GetHourlyUsageAttribution(start_month) cursor := response.metadata.pagination.next_record_id WHILE cursor != null BEGIN sleep(5 seconds) # Avoid running into rate limit response := GetHourlyUsageAttribution(start_month, next_record_id=cursor) cursor := response.metadata.pagination.next_record_id END ``` operationId: GetHourlyUsageAttribution parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string - description: |- Usage type to retrieve. Usage types are in the format `_usage`. Example: `infra_host_usage` To obtain the complete list of active usage types that can be used to replace `` in the field names, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). in: query name: usage_type required: true schema: $ref: "#/components/schemas/HourlyUsageAttributionUsageType" - description: List following results with a next_record_id provided in the previous query. in: query name: next_record_id required: false schema: type: string - description: |- Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags. To see which tags are available, look for the value of `tag_config_source` in the API response. in: query name: tag_breakdown_keys required: false schema: type: string - description: "Include child org usage in the response. Defaults to `true`." in: query name: include_descendants required: false schema: default: true type: boolean responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: metadata: pagination: next_record_id: usage: - hour: "2024-01-01T00:00:00+00:00" org_name: "Test Org" public_id: "abc-123" region: "us" total_usage_sum: 1.0 updated_at: "2024-01-01T00:00:00+00:00" usage_type: infra_host_usage schema: $ref: "#/components/schemas/HourlyUsageAttributionResponse" description: OK "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: Get hourly usage attribution tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/incident-management: get: deprecated: true description: |- Get hourly usage for incident management. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetIncidentManagement parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" monthly_active_users: 5 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageIncidentManagementResponse" 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: Get hourly usage for incident management tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/indexed-spans: get: deprecated: true description: |- Get hourly usage for indexed spans. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageIndexedSpans parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" indexed_events_count: 500 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageIndexedSpansResponse" 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: Get hourly usage for indexed spans tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/ingested-spans: get: deprecated: true description: |- Get hourly usage for ingested spans. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetIngestedSpans parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" ingested_events_bytes: 1000000 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageIngestedSpansResponse" 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: Get hourly usage for ingested spans tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/iot: get: deprecated: true description: |- Get hourly usage for IoT. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageInternetOfThings parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" iot_device_count: 100 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageIoTResponse" 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: Get hourly usage for IoT tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/logs: get: deprecated: true description: |- Get hourly usage for logs. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageLogs parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - billable_ingested_bytes: 100 hour: "2024-01-01T00:00:00+00:00" indexed_events_count: 10 ingested_events_bytes: 200 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageLogsResponse" 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: Get hourly usage for logs tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/logs-by-retention: get: deprecated: true description: |- Get hourly usage for indexed logs by retention period. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageLogsByRetention parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - indexed_events_count: 100 live_indexed_events_count: 80 org_name: example-handle public_id: abc-123 rehydrated_indexed_events_count: 20 retention: "15" schema: $ref: "#/components/schemas/UsageLogsByRetentionResponse" 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: Get hourly logs usage by retention tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/logs_by_index: get: description: |- Get hourly usage for logs by index. operationId: GetUsageLogsByIndex parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string - description: Comma-separated list of log index names. in: query name: index_name required: false schema: items: type: string type: array responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - event_count: 1000 hour: "2024-01-01T00:00:00+00:00" index_id: abc-123 index_name: main org_name: example-handle public_id: abc-123 retention: 15 schema: $ref: "#/components/schemas/UsageLogsByIndexResponse" 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: Get hourly usage for logs by index tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/monthly-attribution: get: description: |- Get monthly usage attribution. Multi-region data is available starting March 1, 2023. This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is set in the response. If it is, make another request and pass `next_record_id` as a parameter. Pseudo code example: ``` response := GetMonthlyUsageAttribution(start_month) cursor := response.metadata.pagination.next_record_id WHILE cursor != null BEGIN sleep(5 seconds) # Avoid running into rate limit response := GetMonthlyUsageAttribution(start_month, next_record_id=cursor) cursor := response.metadata.pagination.next_record_id END ``` operationId: GetMonthlyUsageAttribution parameters: - description: |- Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. in: query name: start_month required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month." in: query name: end_month required: false schema: format: date-time type: string - description: |- Comma-separated list of usage types to return, or `*` for all usage types. Usage types are in the format `_usage` and `_percentage`. Example: `infra_host_usage,infra_host_percentage` To obtain the complete list of usage attribution types that can be used to replace `` in the field names, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). in: query name: fields required: true schema: $ref: "#/components/schemas/MonthlyUsageAttributionSupportedMetrics" - description: "The direction to sort by: `[desc, asc]`." in: query name: sort_direction required: false schema: $ref: "#/components/schemas/UsageSortDirection" - description: |- The field to sort by. Sort fields are in the format `_usage`. Example: `infra_host_usage` To obtain the complete list of usage attribution types that can be used to replace `` in the field names, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). in: query name: sort_name required: false schema: $ref: "#/components/schemas/MonthlyUsageAttributionSupportedMetrics" - description: |- Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags. To see which tags are available, look for the value of `tag_config_source` in the API response. in: query name: tag_breakdown_keys required: false schema: type: string - description: List following results with a next_record_id provided in the previous query. in: query name: next_record_id required: false schema: type: string - description: "Include child org usage in the response. Defaults to `true`." in: query name: include_descendants required: false schema: default: true type: boolean responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: metadata: pagination: next_record_id: usage: - month: "2024-01-01T00:00:00+00:00" org_name: "Test Org" public_id: "abc-123" region: "us" updated_at: "2024-01-01T00:00:00+00:00" values: infra_host_percentage: 100.0 infra_host_usage: 1.0 schema: $ref: "#/components/schemas/MonthlyUsageAttributionResponse" description: OK "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: Get monthly usage attribution tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/network_flows: get: deprecated: true description: |- Get hourly usage for network flows. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageNetworkFlows parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" indexed_events_count: 200 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageNetworkFlowsResponse" 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: get hourly usage for network flows tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/network_hosts: get: deprecated: true description: |- Get hourly usage for network hosts. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageNetworkHosts parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - host_count: 5 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageNetworkHostsResponse" 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: Get hourly usage for network hosts tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/online-archive: get: deprecated: true description: |- Get hourly usage for online archive. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageOnlineArchive parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" online_archive_events_count: 5000 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageOnlineArchiveResponse" 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: Get hourly usage for online archive tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/profiling: get: deprecated: true description: |- Get hourly usage for profiled hosts. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageProfiling parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - avg_container_agent_count: 2 host_count: 5 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageProfilingResponse" 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: Get hourly usage for profiled hosts tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/rum: get: deprecated: true description: |- Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Units. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageRumUnits parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - browser_rum_units: 50 mobile_rum_units: 50 org_name: example-handle public_id: abc-123 rum_units: 100 schema: $ref: "#/components/schemas/UsageRumUnitsResponse" 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: Get hourly usage for RUM units tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/rum_sessions: get: deprecated: true description: |- Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Sessions. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageRumSessions parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string - description: "RUM type: `[browser, mobile]`. Defaults to `browser`." in: query name: type required: false schema: type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 replay_session_count: 10 session_count: 100 schema: $ref: "#/components/schemas/UsageRumSessionsResponse" 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: Get hourly usage for RUM sessions tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/sds: get: deprecated: true description: |- Get hourly usage for sensitive data scanner. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSDS parameters: - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" logs_scanned_bytes: 1000000 org_name: example-handle public_id: abc-123 total_scanned_bytes: 2000000 schema: $ref: "#/components/schemas/UsageSDSResponse" 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: Get hourly usage for sensitive data scanner tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/snmp: get: deprecated: true description: |- Get hourly usage for SNMP devices. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSNMP parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: |- Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 snmp_devices: 10 schema: $ref: "#/components/schemas/UsageSNMPResponse" 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: Get hourly usage for SNMP devices tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/summary: get: description: |- Get all usage across your account. Newly added billing dimensions and usage types appear as untyped keys on the `additionalProperties` map of `UsageSummaryResponse`, `UsageSummaryDate`, and `UsageSummaryDateOrg` instead of as typed fields. Call `GET /api/v2/usage/summary/available_fields` to enumerate every key returned at each response level—both typed fields and `additionalProperties` keys. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetUsageSummary parameters: - description: |- Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. in: query name: start_month required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month." in: query name: end_month required: false schema: format: date-time type: string - description: Include usage summaries for each sub-org. in: query name: include_org_details required: false schema: type: boolean - 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: include_connected_accounts required: false schema: default: false type: boolean responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: apm_host_top99p_sum: 2 container_avg_sum: 5 end_date: "2024-01-31T00:00:00+00:00" last_updated: "2024-01-01T00:00:00+00:00" start_date: "2024-01-01T00:00:00+00:00" usage: - apm_host_top99p: 2 container_avg: 5 date: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/UsageSummaryResponse" 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: Get usage across your account tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/synthetics: get: deprecated: true description: |- Get hourly usage for [synthetics checks](https://docs.datadoghq.com/synthetics/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSynthetics parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - check_calls_count: 50 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageSyntheticsResponse" 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: Get hourly usage for synthetics checks tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/synthetics_api: get: deprecated: true description: |- Get hourly usage for [synthetics API checks](https://docs.datadoghq.com/synthetics/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSyntheticsAPI parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - check_calls_count: 50 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageSyntheticsAPIResponse" 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: Get hourly usage for synthetics API checks tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/synthetics_browser: get: deprecated: true description: |- Get hourly usage for synthetics browser checks. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSyntheticsBrowser parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - browser_check_calls_count: 20 hour: "2024-01-01T00:00:00+00:00" org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageSyntheticsBrowserResponse" 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: Get hourly usage for synthetics browser checks tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/timeseries: get: deprecated: true description: |- Get hourly usage for [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageTimeseries parameters: - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." in: query name: start_hr required: true schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." in: query name: end_hr required: false schema: format: date-time type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: usage: - hour: "2024-01-01T00:00:00+00:00" num_custom_input_timeseries: 10 num_custom_output_timeseries: 5 num_custom_timeseries: 100 org_name: example-handle public_id: abc-123 schema: $ref: "#/components/schemas/UsageTimeseriesResponse" 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: Get hourly usage for custom metrics tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/usage/top_avg_metrics: get: description: Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed. operationId: GetUsageTopAvgMetrics parameters: - description: "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)" in: query name: month schema: format: date-time type: string - description: "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)" in: query name: day schema: format: date-time type: string - description: Comma-separated list of metric names. in: query name: names required: false schema: items: type: string type: array - description: Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. in: query name: limit required: false schema: default: 500 format: int32 maximum: 5000 minimum: 1 type: integer - description: List following results with a next_record_id provided in the previous query. in: query name: next_record_id required: false schema: type: string responses: "200": content: application/json;datetime-format=rfc3339: examples: default: value: metadata: month: "2024-01-01T00:00:00+00:00" pagination: next_record_id: usage: - avg_metric_hour: 5 max_metric_hour: 10 metric_category: custom metric_name: test-metric schema: $ref: "#/components/schemas/UsageTopAvgMetricsResponse" 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: Get all custom metrics by hourly average tags: - Usage Metering "x-permission": operator: OR permissions: - usage_read /api/v1/user: get: description: List all users for your organization. operationId: ListUsers responses: "200": content: application/json: examples: default: value: users: - disabled: false email: test@example.com handle: test@example.com name: Example Name schema: $ref: "#/components/schemas/UserListResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - user_access_read summary: List all users tags: - Users "x-permission": operator: OR permissions: - user_access_read post: description: |- Create a user for your organization. **Note**: Users can only be created with the admin access role if application keys belong to administrators. operationId: CreateUser requestBody: content: application/json: examples: default: value: email: test@datadoghq.com handle: test@datadoghq.com name: test user schema: $ref: "#/components/schemas/User" description: User object that needs to be created. required: true responses: "200": content: application/json: examples: default: value: user: disabled: false email: test@example.com handle: test@example.com name: Example Name schema: $ref: "#/components/schemas/UserResponse" description: User created "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "409": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Conflict "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a user tags: - Users x-codegen-request-body-name: body "x-permission": operator: OR permissions: - user_access_invite /api/v1/user/{user_handle}: delete: description: |- Delete a user from an organization. **Note**: This endpoint can only be used with application keys belonging to administrators. operationId: DisableUser parameters: - description: The handle of the user. in: path name: user_handle required: true schema: example: test@datadoghq.com type: string responses: "200": content: application/json: examples: default: value: message: "User user@example.com disabled" schema: $ref: "#/components/schemas/UserDisableResponse" description: User disabled "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Disable a user tags: - Users get: description: Get a user's details. operationId: GetUser parameters: - description: The ID of the user. in: path name: user_handle required: true schema: example: test@datadoghq.com type: string responses: "200": content: application/json: examples: default: value: user: disabled: false email: test@example.com handle: test@example.com name: Example Name schema: $ref: "#/components/schemas/UserResponse" description: OK for get user "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Get user details tags: - Users put: description: |- Update a user information. **Note**: It can only be used with application keys belonging to administrators. operationId: UpdateUser parameters: - description: The ID of the user. in: path name: user_handle required: true schema: example: test@datadoghq.com type: string requestBody: content: application/json: examples: default: value: disabled: false email: test@datadoghq.com name: test user schema: $ref: "#/components/schemas/User" description: Description of the update. required: true responses: "200": content: application/json: examples: default: value: user: disabled: false email: test@example.com handle: test@example.com name: Example Name schema: $ref: "#/components/schemas/UserResponse" description: User updated "400": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Bad Request "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a user tags: - Users x-codegen-request-body-name: body /api/v1/validate: get: description: Check if the API key (not the APP key) is valid. If invalid, a 403 is returned. operationId: Validate responses: "200": content: application/json: examples: default: value: valid: true schema: $ref: "#/components/schemas/AuthenticationValidationResponse" description: OK "403": content: application/json: schema: $ref: "#/components/schemas/APIErrorResponse" description: Authentication error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] summary: Validate API key tags: - Authentication "x-permission": operator: OPEN permissions: [] /v1/input: post: deprecated: true description: |- Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - Maximum array size if sending multiple logs in an array: 1000 entries Any log exceeding 1MB is accepted and truncated by Datadog: - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. Datadog recommends sending your logs compressed. Add the `Content-Encoding: gzip` header to the request when sending compressed logs. The status codes answered by the HTTP API are: - 200: OK - 400: Bad request (likely an issue in the payload formatting) - 403: Permission issue (likely using an invalid API Key) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time operationId: SubmitLog parameters: - description: HTTP header used to compress the media-type. in: header name: Content-Encoding required: false schema: $ref: "#/components/schemas/ContentEncoding" - description: Log tags can be passed as query parameters with `text/plain` content type. example: "env:prod,user:my-user" in: query name: ddtags required: false schema: type: string requestBody: content: application/json: examples: default: value: - ddsource: nginx ddtags: "env:staging,version:5.1" hostname: i-012345678 message: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" service: payment multi-json-messages: description: Pass multiple log objects at once. summary: Multi JSON Messages value: - message: hello - message: world schema: $ref: "#/components/schemas/HTTPLog" application/json;simple: examples: default: value: ddsource: nginx ddtags: "env:staging,version:5.1" hostname: i-012345678 message: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" service: payment simple-json-message: description: Log attributes can be passed as `key:value` pairs in valid JSON messages. summary: Simple JSON Message value: ddsource: "agent" ddtags: "env:prod,user:joe.doe" hostname: "fa1e1e739d95" message: hello world schema: $ref: "#/components/schemas/HTTPLogItem" application/logplex-1: examples: default: value: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" multi-raw-message: description: Submit log messages. summary: Multi Logplex Messages value: |- hello world simple-logplex-message: description: Submit log string. summary: Simple Logplex Message value: hello world schema: type: string text/plain: examples: default: value: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" multi-raw-message: description: Submit log string. summary: Multi Raw Messages value: |- hello world simple-raw-message: description: >- Submit log string. Log attributes can be passed as query parameters in the URL. This enables the addition of tags or the source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`. summary: Simple Raw Message value: hello world schema: type: string description: Log to send (JSON format). required: true responses: "200": content: application/json: examples: default: value: {} schema: type: object description: Response from server (always 200 empty JSON). "400": content: application/json: schema: $ref: "#/components/schemas/HTTPLogError" description: unexpected error "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] 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 - ap2.datadoghq.com - datadoghq.eu - ddog-gov.com - us2.ddog-gov.com x-enum-varnames: - US1 - US3 - US5 - AP1 - AP2 - EU1 - GOV - US2_GOV subdomain: default: http-intake.logs description: The subdomain where the API is deployed. - url: "{protocol}://{name}" variables: name: default: http-intake.logs.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: http-intake.logs description: The subdomain where the API is deployed. summary: Send logs tags: - Logs x-codegen-request-body-name: body security: - apiKeyAuth: [] appKeyAuth: [] 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 - ap2.datadoghq.com - datadoghq.eu - ddog-gov.com - us2.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. tags: - description: |- Configure your Datadog-AWS integration directly through the Datadog API. For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services). name: AWS Integration - description: |- Configure your Datadog-AWS-Logs integration directly through Datadog API. For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection). externalDocs: url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection name: AWS Logs Integration - description: |- All requests to Datadog’s API must be authenticated. Requests that write data require reporting access and require an `API key`. Requests that read data require full access and also require an `application key`. **Note:** All Datadog API clients are configured by default to consume Datadog US site APIs. If you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to `https://api.datadoghq.eu` or override this value directly when creating your client. [Manage your account’s API and application keys](https://app.datadoghq.com/organization-settings/) in Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/) in the documentation. name: Authentication - description: |- Configure your Datadog-Azure integration directly through the Datadog API. For more information, see the [Datadog-Azure integration page](https://docs.datadoghq.com/integrations/azure). externalDocs: url: https://docs.datadoghq.com/integrations/azure name: Azure Integration - description: |- Interact with your dashboard lists through the API to organize, find, and share all of your dashboards with your team and organization. name: Dashboard Lists x-deprecated: true - description: |- Manage all your dashboards, as well as access to your shared dashboards, through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/) for more information. name: Dashboards - description: |- [Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags. **Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html). name: Downtimes - description: |- The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information. **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question. name: Events - description: |- Configure your Datadog-Google Cloud Platform (GCP) integration directly through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform). externalDocs: url: https://docs.datadoghq.com/integrations/google_cloud_platform name: GCP Integration - description: Get information about your infrastructure hosts in Datadog, and mute or unmute any notifications from your hosts. See the [Infrastructure page](https://docs.datadoghq.com/infrastructure/) for more information. name: Hosts - description: Get a list of IP prefixes belonging to Datadog. name: IP Ranges - description: |- Manage your Datadog API and application keys. You need an API key and an application key for a user with the required permissions to interact with these endpoints. Consult the following pages to view and manage your keys: - [API Keys](https://app.datadoghq.com/organization-settings/api-keys) - [Application Keys](https://app.datadoghq.com/personal-settings/application-keys) externalDocs: description: Find out more at url: "https://docs.datadoghq.com/account_management/api-app-keys/" name: Key Management - description: |- Search your logs and send them to your Datadog platform over HTTP. See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. name: Logs - description: |- Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/). externalDocs: description: Find out more at url: https://docs.datadoghq.com/logs/indexes/ name: Logs Indexes - description: |- Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. - See the [pipelines configuration page](https://app.datadoghq.com/logs/pipelines) for a list of the pipelines and processors currently configured in web UI. - Additional API-related information about processors can be found in the [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor). - For more information about Pipelines, see the [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines). **Notes:** **Grok parsing rules may effect JSON output and require returned data to be configured before using in a request.** For example, if you are using the data returned from a request for another request body, and have a parsing rule that uses a regex pattern like `\s` for spaces, you will need to configure all escaped spaces as `%{space}` to use in the body data. externalDocs: description: Find out more at url: https://docs.datadoghq.com/logs/log_configuration name: Logs Pipelines - description: |- The metrics endpoint allows you to: - Post metrics data so it can be graphed on Datadog’s dashboards - Query metrics from any time period - Modify tag configurations for metrics - View tags and volumes for metrics **Note**: A graph can only contain a set number of points and as the timeframe over which a metric is viewed increases, aggregation between points occurs to stay below that set number. The Post, Patch, and Delete `manage_tags` API methods can only be performed by a user who has the `Manage Tags for Metrics` permission. See the [Metrics page](https://docs.datadoghq.com/metrics/) for more information. name: Metrics - description: |- [Monitors](https://docs.datadoghq.com/monitors) allow you to watch a metric or check that you care about and notifies your team when a defined threshold has exceeded. For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/). **Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html). externalDocs: description: Find out more at url: https://docs.datadoghq.com/monitors/create/types/ name: Monitors - description: |- Interact with your notebooks through the API to make it easier to organize, find, and share all of your notebooks with your team and organization. For more information, see the [Notebooks documentation](https://docs.datadoghq.com/notebooks/). externalDocs: description: For more information, see the Notebooks documentation. url: https://docs.datadoghq.com/notebooks/ name: Notebooks - description: Create, edit, and manage your organizations. Read more about [multi-org accounts](https://docs.datadoghq.com/account_management/multi_organization). externalDocs: description: Find out more at url: "https://docs.datadoghq.com/account_management/multi_organization" name: Organizations - description: |- Configure your [Datadog-PagerDuty integration](https://docs.datadoghq.com/integrations/pagerduty/) directly through the Datadog API. externalDocs: url: https://docs.datadoghq.com/integrations/pagerduty/ name: PagerDuty Integration - description: |- Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information. name: "Security Monitoring" - description: |- The service check endpoint allows you to post check statuses for use with monitors. Service check messages are limited to 500 characters. If a check is posted with a message containing more than 500 characters, only the first 500 characters are displayed. Messages are limited for checks with a Critical or Warning status, they are dropped for checks with an OK status. - [Read more about Service Check monitors][1]. - [Read more about Process Check monitors][2]. - [Read more about Network monitors][3]. - [Read more about Custom Check monitors][4]. - [Read more about Service Checks and status codes][5]. [1]: https://docs.datadoghq.com/monitors/types/service_check/ [2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert [3]: https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert [4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=checkalert [5]: https://docs.datadoghq.com/developers/service_checks/ name: Service Checks - description: |- SLO Status Corrections allow you to prevent specific time periods from negatively impacting your SLO’s status and error budget. You can use Status Corrections for various purposes, such as removing planned maintenance windows, non-business hours, or other time periods that do not correspond to genuine issues. See [SLO status corrections](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-status-corrections) for more information. name: Service Level Objective Corrections - description: |- [Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration) (or SLOs) are a key part of the site reliability engineering toolkit. SLOs provide a framework for defining clear targets around application performance, which ultimately help teams provide a consistent customer experience, balance feature development with platform stability, and improve communication with internal and external users. name: Service Level Objectives - description: |- Configure your [Datadog-Slack integration](https://docs.datadoghq.com/integrations/slack) directly through the Datadog API. externalDocs: description: For more information about the Datadog-Slack integration, see the integration page. url: https://docs.datadoghq.com/integrations/slack name: Slack Integration - description: Take graph snapshots using the API. name: Snapshots - description: |- Synthetic tests use simulated requests and actions so you can monitor the availability and performance of systems and applications. Datadog supports the following types of synthetic tests: - [API tests](https://docs.datadoghq.com/synthetics/api_tests/) - [Browser tests](https://docs.datadoghq.com/synthetics/browser_tests) - [Network Path tests](https://docs.datadoghq.com/synthetics/network_path_tests/) - [Mobile Application tests](https://docs.datadoghq.com/synthetics/mobile_app_testing) You can use the Datadog API to create, manage, and organize tests and test suites programmatically. For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/). name: Synthetics - description: |- The tag endpoint allows you to assign tags to hosts, for example: `role:database`. Those tags are applied to all metrics sent by the host. Refer to hosts by name (`yourhost.example.com`) when fetching and applying tags to a particular host. The component of your infrastructure responsible for a tag is identified by a source. For example, some valid sources include nagios, hudson, jenkins, users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/). name: Tags - description: |- The usage metering API allows you to get hourly, daily, and monthly usage across multiple facets of Datadog. This API is available to all Pro and Enterprise customers. **Note**: Usage data is delayed by up to 72 hours from when it was incurred. It is retained for 15 months. You can retrieve up to 24 hours of hourly usage data for multiple organizations, and up to two months of hourly usage data for a single organization in one request. Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/). externalDocs: description: Find out more at url: "https://docs.datadoghq.com/account_management/billing/usage_details/" name: Usage Metering - description: Create, edit, and disable users. externalDocs: url: https://docs.datadoghq.com/account_management/users name: Users - description: |- Configure your Datadog-Webhooks integration directly through the Datadog API. See the [Webhooks integration page](https://docs.datadoghq.com/integrations/webhooks) for more information. externalDocs: url: https://docs.datadoghq.com/integrations/webhooks name: Webhooks Integration x-group-parameters: true