You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .generator/schemas/v2/openapi.yaml
+8-4Lines changed: 8 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -107944,6 +107944,8 @@ paths:
107944
107944
get:
107945
107945
description: |-
107946
107946
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`.
107947
107949
operationId: ListTagConfigurations
107948
107950
parameters:
107949
107951
- description: Only return custom metrics that have been configured with Metrics Without Limits.
@@ -107983,7 +107985,7 @@ paths:
107983
107985
schema:
107984
107986
type: boolean
107985
107987
- 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`.
107987
107989
example: 15552000
107988
107990
in: query
107989
107991
name: filter[queried][window][seconds]
@@ -107995,7 +107997,7 @@ paths:
107995
107997
minimum: 1
107996
107998
type: integer
107997
107999
- 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*`.
107999
108001
example: "env IN (staging,test) AND service:web*"
108000
108002
in: query
108001
108003
name: filter[tags]
@@ -108022,7 +108024,8 @@ paths:
108022
108024
maximum: 2592000
108023
108025
minimum: 1
108024
108026
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.
108026
108029
in: query
108027
108030
name: page[size]
108028
108031
required: false
@@ -108426,7 +108429,8 @@ paths:
108426
108429
operationId: EstimateMetricsOutputSeries
108427
108430
parameters:
108428
108431
- $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`.
: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``.
672
672
:type filter_groups: str, optional
673
673
:param filter_hours_ago: The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
674
674
:type filter_hours_ago: int, optional
@@ -795,6 +795,8 @@ def list_tag_configurations(
795
795
796
796
Get a list of actively reporting metrics for your organization. Pagination is optional using the ``page[cursor]`` and ``page[size]`` query parameters.
797
797
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
+
798
800
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
799
801
:type filter_configured: bool, optional
800
802
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
: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.
807
809
: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``.
: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*``.
811
813
:type filter_tags: str, optional
812
814
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
813
815
:type filter_related_assets: bool, optional
814
816
: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.
815
817
: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.
817
819
:type page_size: int, optional
818
820
: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.
: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.
886
888
: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``.
: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*``.
890
892
:type filter_tags: str, optional
891
893
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
892
894
:type filter_related_assets: bool, optional
893
895
: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.
894
896
: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.
896
898
:type page_size: int, optional
897
899
: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.
0 commit comments