Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 194 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2709,6 +2709,123 @@ components:
- 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:
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:
Expand Down Expand Up @@ -3138,6 +3255,7 @@ components:
- $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDefinition"
- $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition"
- $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition"
- $ref: "#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition"
- $ref: "#/components/schemas/FormulaAndFunctionSLOQueryDefinition"
- $ref: "#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition"
FormulaAndFunctionResponseFormat:
Expand Down Expand Up @@ -24156,6 +24274,7 @@ components:
- $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:
Expand Down Expand Up @@ -24927,6 +25046,81 @@ components:
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.
Expand Down
Loading
Loading