Skip to content

Commit 421fce0

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Clarify metrics API query strings (#4026)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 068483c commit 421fce0

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107944,6 +107944,8 @@ paths:
107944107944
get:
107945107945
description: |-
107946107946
Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
107947+
107948+
Query parameters use bracket notation (for example, `filter[tags]`, `filter[queried][window][seconds]`). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: `GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500`.
107947107949
operationId: ListTagConfigurations
107948107950
parameters:
107949107951
- description: Only return custom metrics that have been configured with Metrics Without Limits.
@@ -107983,7 +107985,7 @@ paths:
107983107985
schema:
107984107986
type: boolean
107985107987
- description: |-
107986-
Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second.
107988+
This parameter has no effect unless `filter[queried]` is also set. Only return metrics that have been queried or not queried in the specified window. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second. For example: `filter[queried]=true&filter[queried][window][seconds]=604800`.
107987107989
example: 15552000
107988107990
in: query
107989107991
name: filter[queried][window][seconds]
@@ -107995,7 +107997,7 @@ paths:
107995107997
minimum: 1
107996107998
type: integer
107997107999
- description: |-
107998-
Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
108000+
Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards. For example: `filter[tags]=env IN (staging,test) AND service:web*`.
107999108001
example: "env IN (staging,test) AND service:web*"
108000108002
in: query
108001108003
name: filter[tags]
@@ -108022,7 +108024,8 @@ paths:
108022108024
maximum: 2592000
108023108025
minimum: 1
108024108026
type: integer
108025-
- description: Maximum number of results per page. Use with `page[cursor]` for pagination. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
108027+
- description: |-
108028+
Maximum number of results per page. Send `page[size]` on the first request to opt in to pagination. On each subsequent request, send `page[cursor]` set to the value of `meta.pagination.next_cursor` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
108026108029
in: query
108027108030
name: page[size]
108028108031
required: false
@@ -108426,7 +108429,8 @@ paths:
108426108429
operationId: EstimateMetricsOutputSeries
108427108430
parameters:
108428108431
- $ref: "#/components/parameters/MetricName"
108429-
- description: Filtered tag keys that the metric is configured to query with.
108432+
- description: |-
108433+
Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
108430108434
example: "app,host"
108431108435
in: query
108432108436
name: filter[groups]

services/metrics/src/v2/MetricsApi.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2033,7 +2033,7 @@ export interface MetricsApiEstimateMetricsOutputSeriesRequest {
20332033
*/
20342034
metricName: string;
20352035
/**
2036-
* Filtered tag keys that the metric is configured to query with.
2036+
* Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
20372037
* @type string
20382038
*/
20392039
filterGroups?: string;
@@ -2124,12 +2124,12 @@ export interface MetricsApiListTagConfigurationsRequest {
21242124
*/
21252125
filterQueried?: boolean;
21262126
/**
2127-
* Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second.
2127+
* This parameter has no effect unless `filter[queried]` is also set. Only return metrics that have been queried or not queried in the specified window. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second. For example: `filter[queried]=true&filter[queried][window][seconds]=604800`.
21282128
* @type number
21292129
*/
21302130
filterQueriedWindowSeconds?: number;
21312131
/**
2132-
* Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
2132+
* Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards. For example: `filter[tags]=env IN (staging,test) AND service:web*`.
21332133
* @type string
21342134
*/
21352135
filterTags?: string;
@@ -2144,7 +2144,7 @@ export interface MetricsApiListTagConfigurationsRequest {
21442144
*/
21452145
windowSeconds?: number;
21462146
/**
2147-
* Maximum number of results per page. Use with `page[cursor]` for pagination. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
2147+
* Maximum number of results per page. Send `page[size]` on the first request to opt in to pagination. On each subsequent request, send `page[cursor]` set to the value of `meta.pagination.next_cursor` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
21482148
* @type number
21492149
*/
21502150
pageSize?: number;
@@ -2491,6 +2491,8 @@ export class MetricsApi {
24912491

24922492
/**
24932493
* Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
2494+
*
2495+
* Query parameters use bracket notation (for example, `filter[tags]`, `filter[queried][window][seconds]`). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: `GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500`.
24942496
* @param param The request object
24952497
*/
24962498
public listTagConfigurations(

0 commit comments

Comments
 (0)