Skip to content

Commit d682bb1

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update documentation for api/v2/metrics endpoint (#3722)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 85648d8 commit d682bb1

File tree

2 files changed

+44
-79
lines changed

2 files changed

+44
-79
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 32 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -91733,111 +91733,92 @@ paths:
9173391733
- logs_read_data
9173491734
/api/v2/metrics:
9173591735
get:
91736-
description: 'Returns all metrics for your organization that match the given
91737-
filter parameters.
91738-
91739-
Optionally, paginate by using the `page[cursor]` and/or `page[size]` query
91740-
parameters.
91741-
91742-
To fetch the first page, pass in a query parameter with either a valid `page[size]`
91743-
or an empty cursor like `page[cursor]=`. To fetch the next page, pass in the
91744-
`next_cursor` value from the response as the new `page[cursor]` value.
91745-
91746-
Once the `meta.pagination.next_cursor` value is null, all pages have been
91747-
retrieved.'
91736+
description: Get a list of actively reporting metrics for your organization.
91737+
Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
9174891738
operationId: ListTagConfigurations
9174991739
parameters:
91750-
- description: Filter custom metrics that have configured tags.
91740+
- description: Only return custom metrics that have been configured with Metrics
91741+
Without Limits.
9175191742
example: true
9175291743
in: query
9175391744
name: filter[configured]
9175491745
required: false
9175591746
schema:
9175691747
type: boolean
91757-
- description: Filter tag configurations by configured tags.
91758-
example: app
91748+
- description: Only return metrics that have the given tag key(s) in their Metrics
91749+
Without Limits configuration (included or excluded).
91750+
example: app,env
9175991751
in: query
9176091752
name: filter[tags_configured]
9176191753
required: false
9176291754
schema:
9176391755
description: Tag keys to filter by.
9176491756
type: string
91765-
- description: Filter metrics by metric type.
91757+
- description: Only return metrics of the given metric type.
9176691758
in: query
9176791759
name: filter[metric_type]
9176891760
required: false
9176991761
schema:
9177091762
$ref: '#/components/schemas/MetricTagConfigurationMetricTypeCategory'
91771-
- description: 'Filter distributions with additional percentile
91772-
91773-
aggregations enabled or disabled.'
91763+
- description: Only return distribution metrics that have percentile aggregations
91764+
enabled (true) or disabled (false).
9177491765
example: true
9177591766
in: query
9177691767
name: filter[include_percentiles]
9177791768
required: false
9177891769
schema:
9177991770
type: boolean
91780-
- description: '(Preview) Filter custom metrics that have or have not been queried
91781-
in the specified window[seconds].
91782-
91783-
If no window is provided or the window is less than 2 hours, a default of
91784-
2 hours will be applied.'
91771+
- description: Only return metrics that have been queried (true) or not queried
91772+
(false) in the look back window. Set the window with `filter[queried][window][seconds]`;
91773+
if omitted, a default window is used.
9178591774
example: true
9178691775
in: query
9178791776
name: filter[queried]
9178891777
required: false
9178991778
schema:
9179091779
type: boolean
91791-
- description: 'The number of seconds of look back (from now) used by the `filter[queried]`
91792-
filter logic.
91793-
91794-
Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`.
91795-
91796-
If `filter[queried]=false`, this parameter is ignored and default queried-window
91797-
behavior applies.
91798-
91799-
If `filter[queried]` is not provided, sending this parameter returns a 400.
91800-
91801-
For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`.'
91780+
- description: Only return metrics that have been queried or not queried in
91781+
the specified window. Dependent on being sent with `filter[queried]`.
9180291782
example: 15552000
9180391783
in: query
9180491784
name: filter[queried][window][seconds]
9180591785
required: false
9180691786
schema:
91787+
default: 2592000
9180791788
format: int64
9180891789
maximum: 15552000
91809-
minimum: 0
91790+
minimum: 1
9181091791
type: integer
91811-
- description: 'Filter metrics that have been submitted with the given tags.
91812-
Supports boolean and wildcard expressions.
91813-
91814-
Can only be combined with the filter[queried] filter.'
91815-
example: env IN (staging,test) AND service:web
91792+
- description: Only return metrics that were submitted with tags matching this
91793+
expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
91794+
example: env IN (staging,test) AND service:web*
9181691795
in: query
9181791796
name: filter[tags]
9181891797
required: false
9181991798
schema:
9182091799
type: string
91821-
- description: (Preview) Filter metrics that are used in dashboards, monitors,
91822-
notebooks, SLOs.
91800+
- description: Only return metrics that are used in at least one dashboard,
91801+
monitor, notebook, or SLO.
9182391802
example: true
9182491803
in: query
9182591804
name: filter[related_assets]
9182691805
required: false
9182791806
schema:
9182891807
type: boolean
91829-
- description: 'The number of seconds of look back (from now) to apply to a
91830-
filter[tag] query.
91831-
91832-
Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).'
91808+
- description: Only return metrics that have been actively reporting in the
91809+
specified window.
9183391810
example: 3600
9183491811
in: query
9183591812
name: window[seconds]
9183691813
required: false
9183791814
schema:
91815+
default: 3600
9183891816
format: int64
91817+
maximum: 2592000
91818+
minimum: 1
9183991819
type: integer
91840-
- description: Maximum number of results returned.
91820+
- description: Maximum number of results per page. Use with `page[cursor]` for
91821+
pagination.
9184191822
in: query
9184291823
name: page[size]
9184391824
required: false
@@ -91847,12 +91828,9 @@ paths:
9184791828
maximum: 10000
9184891829
minimum: 1
9184991830
type: integer
91850-
- description: 'String to query the next page of results.
91851-
91852-
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.
91853-
91854-
Once the `meta.pagination.next_cursor` key is null, all pages have been
91855-
retrieved.'
91831+
- description: Cursor for pagination. Use `page[size]` to opt-in to pagination
91832+
and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor`
91833+
in the response. Pagination is complete when `next_cursor` is null.
9185691834
in: query
9185791835
name: page[cursor]
9185891836
required: false

services/metrics/src/v2/MetricsApi.ts

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2099,67 +2099,57 @@ export interface MetricsApiListTagConfigurationByNameRequest {
20992099

21002100
export interface MetricsApiListTagConfigurationsRequest {
21012101
/**
2102-
* Filter custom metrics that have configured tags.
2102+
* Only return custom metrics that have been configured with Metrics Without Limits.
21032103
* @type boolean
21042104
*/
21052105
filterConfigured?: boolean;
21062106
/**
2107-
* Filter tag configurations by configured tags.
2107+
* Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
21082108
* @type string
21092109
*/
21102110
filterTagsConfigured?: string;
21112111
/**
2112-
* Filter metrics by metric type.
2112+
* Only return metrics of the given metric type.
21132113
* @type MetricTagConfigurationMetricTypeCategory
21142114
*/
21152115
filterMetricType?: MetricTagConfigurationMetricTypeCategory;
21162116
/**
2117-
* Filter distributions with additional percentile
2118-
* aggregations enabled or disabled.
2117+
* Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
21192118
* @type boolean
21202119
*/
21212120
filterIncludePercentiles?: boolean;
21222121
/**
2123-
* (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].
2124-
* If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
2122+
* Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with `filter[queried][window][seconds]`; if omitted, a default window is used.
21252123
* @type boolean
21262124
*/
21272125
filterQueried?: boolean;
21282126
/**
2129-
* The number of seconds of look back (from now) used by the `filter[queried]` filter logic.
2130-
* Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`.
2131-
* If `filter[queried]=false`, this parameter is ignored and default queried-window behavior applies.
2132-
* If `filter[queried]` is not provided, sending this parameter returns a 400.
2133-
* For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`.
2127+
* Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`.
21342128
* @type number
21352129
*/
21362130
filterQueriedWindowSeconds?: number;
21372131
/**
2138-
* Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
2139-
* Can only be combined with the filter[queried] filter.
2132+
* Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
21402133
* @type string
21412134
*/
21422135
filterTags?: string;
21432136
/**
2144-
* (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
2137+
* Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
21452138
* @type boolean
21462139
*/
21472140
filterRelatedAssets?: boolean;
21482141
/**
2149-
* The number of seconds of look back (from now) to apply to a filter[tag] query.
2150-
* Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).
2142+
* Only return metrics that have been actively reporting in the specified window.
21512143
* @type number
21522144
*/
21532145
windowSeconds?: number;
21542146
/**
2155-
* Maximum number of results returned.
2147+
* Maximum number of results per page. Use with `page[cursor]` for pagination.
21562148
* @type number
21572149
*/
21582150
pageSize?: number;
21592151
/**
2160-
* String to query the next page of results.
2161-
* This key is provided with each valid response from the API in `meta.pagination.next_cursor`.
2162-
* Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved.
2152+
* Cursor for pagination. Use `page[size]` to opt-in to pagination and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor` in the response. Pagination is complete when `next_cursor` is null.
21632153
* @type string
21642154
*/
21652155
pageCursor?: string;
@@ -2499,10 +2489,7 @@ export class MetricsApi {
24992489
}
25002490

25012491
/**
2502-
* Returns all metrics for your organization that match the given filter parameters.
2503-
* Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters.
2504-
* To fetch the first page, pass in a query parameter with either a valid `page[size]` or an empty cursor like `page[cursor]=`. To fetch the next page, pass in the `next_cursor` value from the response as the new `page[cursor]` value.
2505-
* Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved.
2492+
* Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
25062493
* @param param The request object
25072494
*/
25082495
public listTagConfigurations(

0 commit comments

Comments
 (0)