Skip to content

Update documentation for api/v2/metrics endpoint #3310

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+60 −101
Open

Update documentation for api/v2/metrics endpoint #3310

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 @@ -91522,111 +91522,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 @@ -91636,12 +91617,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
75 changes: 28 additions & 47 deletions src/datadog_api_client/v2/api/metrics_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ def __init__(self, api_client=None):
"filter_queried_window_seconds": {
"validation": {
"inclusive_maximum": 15552000,
"inclusive_minimum": 0,
"inclusive_minimum": 1,
},
"openapi_types": (int,),
"attribute": "filter[queried][window][seconds]",
Expand All @@ -367,6 +367,10 @@ def __init__(self, api_client=None):
"location": "query",
},
"window_seconds": {
"validation": {
"inclusive_maximum": 2592000,
"inclusive_minimum": 1,
},
"openapi_types": (int,),
"attribute": "window[seconds]",
"location": "query",
Expand Down Expand Up @@ -788,42 +792,29 @@ def list_tag_configurations(
) -> MetricsAndMetricTagConfigurationsResponse:
"""Get a list of metrics.

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.
Get a list of actively reporting metrics for your organization. Pagination is optional using the ``page[cursor]`` and ``page[size]`` query parameters.

:param filter_configured: Filter custom metrics that have configured tags.
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
:type filter_configured: bool, optional
:param filter_tags_configured: Filter tag configurations by configured tags.
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
:type filter_tags_configured: str, optional
:param filter_metric_type: Filter metrics by metric type.
:param filter_metric_type: Only return metrics of the given metric type.
:type filter_metric_type: MetricTagConfigurationMetricTypeCategory, optional
:param filter_include_percentiles: Filter distributions with additional percentile
aggregations enabled or disabled.
:param filter_include_percentiles: Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
:type filter_include_percentiles: bool, optional
:param filter_queried: (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.
:param filter_queried: 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.
:type filter_queried: bool, optional
:param filter_queried_window_seconds: 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``.
:param filter_queried_window_seconds: Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with ``filter[queried]``.
:type filter_queried_window_seconds: int, optional
:param filter_tags: Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
Can only be combined with the filter[queried] filter.
:param filter_tags: Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
:type filter_tags: str, optional
:param filter_related_assets: (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
:type filter_related_assets: bool, optional
:param window_seconds: 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).
:param window_seconds: Only return metrics that have been actively reporting in the specified window.
:type window_seconds: int, optional
:param page_size: Maximum number of results returned.
:param page_size: Maximum number of results per page. Use with ``page[cursor]`` for pagination.
:type page_size: int, optional
:param page_cursor: 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.
:param page_cursor: 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.
:type page_cursor: str, optional
:rtype: MetricsAndMetricTagConfigurationsResponse
"""
Expand Down Expand Up @@ -882,37 +873,27 @@ def list_tag_configurations_with_pagination(

Provide a paginated version of :meth:`list_tag_configurations`, returning all items.

:param filter_configured: Filter custom metrics that have configured tags.
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
:type filter_configured: bool, optional
:param filter_tags_configured: Filter tag configurations by configured tags.
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
:type filter_tags_configured: str, optional
:param filter_metric_type: Filter metrics by metric type.
:param filter_metric_type: Only return metrics of the given metric type.
:type filter_metric_type: MetricTagConfigurationMetricTypeCategory, optional
:param filter_include_percentiles: Filter distributions with additional percentile
aggregations enabled or disabled.
:param filter_include_percentiles: Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
:type filter_include_percentiles: bool, optional
:param filter_queried: (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.
:param filter_queried: 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.
:type filter_queried: bool, optional
:param filter_queried_window_seconds: 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``.
:param filter_queried_window_seconds: Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with ``filter[queried]``.
:type filter_queried_window_seconds: int, optional
:param filter_tags: Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
Can only be combined with the filter[queried] filter.
:param filter_tags: Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
:type filter_tags: str, optional
:param filter_related_assets: (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
:type filter_related_assets: bool, optional
:param window_seconds: 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).
:param window_seconds: Only return metrics that have been actively reporting in the specified window.
:type window_seconds: int, optional
:param page_size: Maximum number of results returned.
:param page_size: Maximum number of results per page. Use with ``page[cursor]`` for pagination.
:type page_size: int, optional
:param page_cursor: 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.
:param page_cursor: 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.
:type page_cursor: str, optional

:return: A generator of paginated results.
Expand Down
Loading