Skip to content

Update documentation for api/v2/metrics endpoint #3624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
api-clients-generation-pipeline merged 1 commit into from
Mar 18, 2026
Merged

Update documentation for api/v2/metrics endpoint #3624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 32 additions & 54 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91728,111 +91728,92 @@ paths:
- logs_read_data
/api/v2/metrics:
get:
description: 'Returns all metrics for your organization that match the given
filter parameters.

Optionally, paginate by using the `page[cursor]` and/or `page[size]` query
parameters.

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.

Once the `meta.pagination.next_cursor` value is null, all pages have been
retrieved.'
description: Get a list of actively reporting metrics for your organization.
Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
operationId: ListTagConfigurations
parameters:
- description: Filter custom metrics that have configured tags.
- description: Only return custom metrics that have been configured with Metrics
Without Limits.
example: true
in: query
name: filter[configured]
required: false
schema:
type: boolean
- description: Filter tag configurations by configured tags.
example: app
- description: Only return metrics that have the given tag key(s) in their Metrics
Without Limits configuration (included or excluded).
example: app,env
in: query
name: filter[tags_configured]
required: false
schema:
description: Tag keys to filter by.
type: string
- description: Filter metrics by metric type.
- description: Only return metrics of the given metric type.
in: query
name: filter[metric_type]
required: false
schema:
$ref: '#/components/schemas/MetricTagConfigurationMetricTypeCategory'
- description: 'Filter distributions with additional percentile

aggregations enabled or disabled.'
- description: Only return distribution metrics that have percentile aggregations
enabled (true) or disabled (false).
example: true
in: query
name: filter[include_percentiles]
required: false
schema:
type: boolean
- description: '(Preview) Filter custom metrics that have or have not been queried
in the specified window[seconds].

If no window is provided or the window is less than 2 hours, a default of
2 hours will be applied.'
- description: 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.
example: true
in: query
name: filter[queried]
required: false
schema:
type: boolean
- description: 'The number of seconds of look back (from now) used by the `filter[queried]`
filter logic.

Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`.

If `filter[queried]=false`, this parameter is ignored and default queried-window
behavior applies.

If `filter[queried]` is not provided, sending this parameter returns a 400.

For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`.'
- description: Only return metrics that have been queried or not queried in
the specified window. Dependent on being sent with `filter[queried]`.
example: 15552000
in: query
name: filter[queried][window][seconds]
required: false
schema:
default: 2592000
format: int64
maximum: 15552000
minimum: 0
minimum: 1
type: integer
- description: 'Filter metrics that have been submitted with the given tags.
Supports boolean and wildcard expressions.

Can only be combined with the filter[queried] filter.'
example: env IN (staging,test) AND service:web
- description: Only return metrics that were submitted with tags matching this
expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
example: env IN (staging,test) AND service:web*
in: query
name: filter[tags]
required: false
schema:
type: string
- description: (Preview) Filter metrics that are used in dashboards, monitors,
notebooks, SLOs.
- description: Only return metrics that are used in at least one dashboard,
monitor, notebook, or SLO.
example: true
in: query
name: filter[related_assets]
required: false
schema:
type: boolean
- description: 'The number of seconds of look back (from now) to apply to a
filter[tag] query.

Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).'
- description: Only return metrics that have been actively reporting in the
specified window.
example: 3600
in: query
name: window[seconds]
required: false
schema:
default: 3600
format: int64
maximum: 2592000
minimum: 1
type: integer
- description: Maximum number of results returned.
- description: Maximum number of results per page. Use with `page[cursor]` for
pagination.
in: query
name: page[size]
required: false
Expand All @@ -91842,12 +91823,9 @@ paths:
maximum: 10000
minimum: 1
type: integer
- description: 'String to query the next page of results.

This key is provided with each valid response from the API in `meta.pagination.next_cursor`.

Once the `meta.pagination.next_cursor` key is null, all pages have been
retrieved.'
- description: 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.
in: query
name: page[cursor]
required: false
Expand Down
62 changes: 28 additions & 34 deletions src/main/java/com/datadog/api/client/v2/api/MetricsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1606,7 +1606,8 @@ public static class ListTagConfigurationsOptionalParameters {
/**
* Set filterConfigured.
*
* @param filterConfigured Filter custom metrics that have configured tags. (optional)
* @param filterConfigured Only return custom metrics that have been configured with Metrics
* Without Limits. (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterConfigured(Boolean filterConfigured) {
Expand All @@ -1617,7 +1618,8 @@ public ListTagConfigurationsOptionalParameters filterConfigured(Boolean filterCo
/**
* Set filterTagsConfigured.
*
* @param filterTagsConfigured Filter tag configurations by configured tags. (optional)
* @param filterTagsConfigured Only return metrics that have the given tag key(s) in their
* Metrics Without Limits configuration (included or excluded). (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterTagsConfigured(
Expand All @@ -1629,7 +1631,8 @@ public ListTagConfigurationsOptionalParameters filterTagsConfigured(
/**
* Set filterMetricType.
*
* @param filterMetricType Filter metrics by metric type. (optional, default to "distribution")
* @param filterMetricType Only return metrics of the given metric type. (optional, default to
* "distribution")
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterMetricType(
Expand All @@ -1641,8 +1644,8 @@ public ListTagConfigurationsOptionalParameters filterMetricType(
/**
* Set filterIncludePercentiles.
*
* @param filterIncludePercentiles Filter distributions with additional percentile aggregations
* enabled or disabled. (optional)
* @param filterIncludePercentiles Only return distribution metrics that have percentile
* aggregations enabled (true) or disabled (false). (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterIncludePercentiles(
Expand All @@ -1654,9 +1657,9 @@ public ListTagConfigurationsOptionalParameters filterIncludePercentiles(
/**
* Set filterQueried.
*
* @param filterQueried (Preview) Filter custom metrics that have or have not been queried in
* the specified window[seconds]. If no window is provided or the window is less than 2
* hours, a default of 2 hours will be applied. (optional)
* @param filterQueried Only return metrics that have been queried (true) or not queried (false)
* in the look back window. Set the window with <code>filter[queried][window][seconds]
* </code>; if omitted, a default window is used. (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterQueried(Boolean filterQueried) {
Expand All @@ -1667,14 +1670,9 @@ public ListTagConfigurationsOptionalParameters filterQueried(Boolean filterQueri
/**
* Set filterQueriedWindowSeconds.
*
* @param filterQueriedWindowSeconds The number of seconds of look back (from now) used by the
* <code>filter[queried]</code> filter logic. Must be sent with <code>filter[queried]</code>
* and is only applied when <code>filter[queried]=true</code>. If <code>
* filter[queried]=false</code>, this parameter is ignored and default queried-window
* behavior applies. If <code>filter[queried]</code> is not provided, sending this parameter
* returns a 400. For example: <code>
* GET /api/v2/metrics?filter[queried]=true&amp;filter[queried][window][seconds]=15552000
* </code>. (optional)
* @param filterQueriedWindowSeconds Only return metrics that have been queried or not queried
* in the specified window. Dependent on being sent with <code>filter[queried]</code>.
* (optional, default to 2592000)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterQueriedWindowSeconds(
Expand All @@ -1686,9 +1684,8 @@ public ListTagConfigurationsOptionalParameters filterQueriedWindowSeconds(
/**
* Set filterTags.
*
* @param filterTags Filter metrics that have been submitted with the given tags. Supports
* boolean and wildcard expressions. Can only be combined with the filter[queried] filter.
* (optional)
* @param filterTags Only return metrics that were submitted with tags matching this expression.
* You can use AND, OR, IN, and wildcards (for example, service:web*). (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterTags(String filterTags) {
Expand All @@ -1699,8 +1696,8 @@ public ListTagConfigurationsOptionalParameters filterTags(String filterTags) {
/**
* Set filterRelatedAssets.
*
* @param filterRelatedAssets (Preview) Filter metrics that are used in dashboards, monitors,
* notebooks, SLOs. (optional)
* @param filterRelatedAssets Only return metrics that are used in at least one dashboard,
* monitor, notebook, or SLO. (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterRelatedAssets(
Expand All @@ -1712,8 +1709,8 @@ public ListTagConfigurationsOptionalParameters filterRelatedAssets(
/**
* Set windowSeconds.
*
* @param windowSeconds The number of seconds of look back (from now) to apply to a filter[tag]
* query. Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days). (optional)
* @param windowSeconds Only return metrics that have been actively reporting in the specified
* window. (optional, default to 3600)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters windowSeconds(Long windowSeconds) {
Expand All @@ -1724,7 +1721,8 @@ public ListTagConfigurationsOptionalParameters windowSeconds(Long windowSeconds)
/**
* Set pageSize.
*
* @param pageSize Maximum number of results returned. (optional, default to 10000)
* @param pageSize Maximum number of results per page. Use with <code>page[cursor]</code> for
* pagination. (optional, default to 10000)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters pageSize(Integer pageSize) {
Expand All @@ -1735,9 +1733,10 @@ public ListTagConfigurationsOptionalParameters pageSize(Integer pageSize) {
/**
* Set pageCursor.
*
* @param pageCursor String to query the next page of results. This key is provided with each
* valid response from the API in <code>meta.pagination.next_cursor</code>. Once the <code>
* meta.pagination.next_cursor</code> key is null, all pages have been retrieved. (optional)
* @param pageCursor Cursor for pagination. Use <code>page[size]</code> to opt-in to pagination
* and get the first page; for subsequent pages, use the value from <code>
* meta.pagination.next_cursor</code> in the response. Pagination is complete when <code>
* next_cursor</code> is null. (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters pageCursor(String pageCursor) {
Expand Down Expand Up @@ -1860,13 +1859,8 @@ public PaginationIterable<MetricsAndMetricTagConfigurations> listTagConfiguratio
}

/**
* Returns all metrics for your organization that match the given filter parameters. Optionally,
* paginate by using the <code>page[cursor]</code> and/or <code>page[size]</code> query
* parameters. To fetch the first page, pass in a query parameter with either a valid <code>
* page[size]</code> or an empty cursor like <code>page[cursor]=</code>. To fetch the next page,
* pass in the <code>next_cursor</code> value from the response as the new <code>page[cursor]
* </code> value. Once the <code>meta.pagination.next_cursor</code> value is null, all pages have
* been retrieved.
* Get a list of actively reporting metrics for your organization. Pagination is optional using
* the <code>page[cursor]</code> and <code>page[size]</code> query parameters.
*
* @param parameters Optional parameters for the request.
* @return ApiResponse&lt;MetricsAndMetricTagConfigurationsResponse&gt;
Expand Down
Loading