Skip to content

Commit 9750f8f

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit beacd46 of spec repo
1 parent cad8a33 commit 9750f8f

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107887,6 +107887,8 @@ paths:
107887107887
get:
107888107888
description: |-
107889107889
Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
107890+
107891+
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`.
107890107892
operationId: ListTagConfigurations
107891107893
parameters:
107892107894
- description: Only return custom metrics that have been configured with Metrics Without Limits.
@@ -107926,7 +107928,7 @@ paths:
107926107928
schema:
107927107929
type: boolean
107928107930
- description: |-
107929-
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.
107931+
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`.
107930107932
example: 15552000
107931107933
in: query
107932107934
name: filter[queried][window][seconds]
@@ -107938,7 +107940,7 @@ paths:
107938107940
minimum: 1
107939107941
type: integer
107940107942
- description: |-
107941-
Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
107943+
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*`.
107942107944
example: "env IN (staging,test) AND service:web*"
107943107945
in: query
107944107946
name: filter[tags]
@@ -107965,7 +107967,8 @@ paths:
107965107967
maximum: 2592000
107966107968
minimum: 1
107967107969
type: integer
107968-
- 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.
107970+
- description: |-
107971+
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.
107969107972
in: query
107970107973
name: page[size]
107971107974
required: false
@@ -108369,7 +108372,8 @@ paths:
108369108372
operationId: EstimateMetricsOutputSeries
108370108373
parameters:
108371108374
- $ref: "#/components/parameters/MetricName"
108372-
- description: Filtered tag keys that the metric is configured to query with.
108375+
- description: |-
108376+
Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
108373108377
example: "app,host"
108374108378
in: query
108375108379
name: filter[groups]

src/datadog_api_client/v2/api/metrics_api.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,7 @@ def estimate_metrics_output_series(
668668
669669
:param metric_name: The name of the metric.
670670
:type metric_name: str
671-
:param filter_groups: Filtered tag keys that the metric is configured to query with.
671+
:param filter_groups: Comma-separated list of tag keys that the metric is configured to query with. For example: ``filter[groups]=app,host``.
672672
:type filter_groups: str, optional
673673
:param filter_hours_ago: The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
674674
:type filter_hours_ago: int, optional
@@ -795,6 +795,8 @@ def list_tag_configurations(
795795
796796
Get a list of actively reporting metrics for your organization. Pagination is optional using the ``page[cursor]`` and ``page[size]`` query parameters.
797797
798+
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``.
799+
798800
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
799801
:type filter_configured: bool, optional
800802
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
@@ -805,15 +807,15 @@ def list_tag_configurations(
805807
:type filter_include_percentiles: bool, optional
806808
: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.
807809
:type filter_queried: bool, optional
808-
: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]``. 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.
810+
:param filter_queried_window_seconds: 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``.
809811
:type filter_queried_window_seconds: int, optional
810-
: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*).
812+
:param filter_tags: 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*``.
811813
:type filter_tags: str, optional
812814
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
813815
:type filter_related_assets: bool, optional
814816
:param window_seconds: Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
815817
:type window_seconds: int, optional
816-
:param page_size: 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.
818+
:param page_size: 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.
817819
:type page_size: int, optional
818820
: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.
819821
:type page_cursor: str, optional
@@ -884,15 +886,15 @@ def list_tag_configurations_with_pagination(
884886
:type filter_include_percentiles: bool, optional
885887
: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.
886888
:type filter_queried: bool, optional
887-
: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]``. 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.
889+
:param filter_queried_window_seconds: 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``.
888890
:type filter_queried_window_seconds: int, optional
889-
: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*).
891+
:param filter_tags: 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*``.
890892
:type filter_tags: str, optional
891893
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
892894
:type filter_related_assets: bool, optional
893895
:param window_seconds: Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
894896
:type window_seconds: int, optional
895-
:param page_size: 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.
897+
:param page_size: 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.
896898
:type page_size: int, optional
897899
: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.
898900
:type page_cursor: str, optional

0 commit comments

Comments
 (0)