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
@@ -107405,6 +107405,8 @@ paths:
107405
107405
get:
107406
107406
description: |-
107407
107407
Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
107408
+
107409
+
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`.
107408
107410
operationId: ListTagConfigurations
107409
107411
parameters:
107410
107412
- description: Only return custom metrics that have been configured with Metrics Without Limits.
@@ -107444,7 +107446,7 @@ paths:
107444
107446
schema:
107445
107447
type: boolean
107446
107448
- description: |-
107447
-
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.
107449
+
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`.
107448
107450
example: 15552000
107449
107451
in: query
107450
107452
name: filter[queried][window][seconds]
@@ -107456,7 +107458,7 @@ paths:
107456
107458
minimum: 1
107457
107459
type: integer
107458
107460
- description: |-
107459
-
Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
107461
+
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*`.
107460
107462
example: "env IN (staging,test) AND service:web*"
107461
107463
in: query
107462
107464
name: filter[tags]
@@ -107483,7 +107485,8 @@ paths:
107483
107485
maximum: 2592000
107484
107486
minimum: 1
107485
107487
type: integer
107486
-
- 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.
107488
+
- description: |-
107489
+
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.
107487
107490
in: query
107488
107491
name: page[size]
107489
107492
required: false
@@ -107887,7 +107890,8 @@ paths:
107887
107890
operationId: EstimateMetricsOutputSeries
107888
107891
parameters:
107889
107892
- $ref: "#/components/parameters/MetricName"
107890
-
- description: Filtered tag keys that the metric is configured to query with.
107893
+
- description: |-
107894
+
Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
* 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.
2127
+
* 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`.
2128
2128
* @type number
2129
2129
*/
2130
2130
filterQueriedWindowSeconds?: number;
2131
2131
/**
2132
-
* Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
2132
+
* 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*`.
* 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.
2147
+
* 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.
2148
2148
* @type number
2149
2149
*/
2150
2150
pageSize?: number;
@@ -2491,6 +2491,8 @@ export class MetricsApi {
2491
2491
2492
2492
/**
2493
2493
* Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
2494
+
*
2495
+
* 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`.
0 commit comments