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
+82-4Lines changed: 82 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -58798,13 +58798,15 @@ components:
58798
58798
- token
58799
58799
type: object
58800
58800
Metric:
58801
-
description: Object for a single metric tag configuration.
58801
+
description: Object for a single metric.
58802
58802
example:
58803
58803
id: metric.foo.bar
58804
58804
type: metrics
58805
58805
properties:
58806
58806
id:
58807
58807
$ref: "#/components/schemas/MetricName"
58808
+
relationships:
58809
+
$ref: "#/components/schemas/MetricRelationships"
58808
58810
type:
58809
58811
$ref: "#/components/schemas/MetricType"
58810
58812
type: object
@@ -59341,12 +59343,12 @@ components:
59341
59343
description: Object containing the definition of a metric's ingested and indexed volume.
59342
59344
properties:
59343
59345
indexed_volume:
59344
-
description: Indexed volume for the given metric.
59346
+
description: Estimated average hourly number of indexed time series for the given metric over the last hour. For organizations on Metric Name Pricing, this represents the estimated sum of indexed data points over the last hour.
59345
59347
example: 10
59346
59348
format: int64
59347
59349
type: integer
59348
59350
ingested_volume:
59349
-
description: Ingested volume for the given metric.
59351
+
description: Estimated average hourly number of ingested time series for the given metric over the last hour. This value is `0` for metrics not configured with Metrics Without Limits. For organizations on Metric Name Pricing, this represents the estimated sum of ingested data points over the last hour.
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`.
152444
152473
operationId: ListTagConfigurations
152445
152474
parameters:
152446
-
- description: Only return custom metrics that have been configured with Metrics Without Limits.
152475
+
- description: Only return custom metrics that have been configured (`true`) or not configured (`false`) with Metrics Without Limits.
152447
152476
example: true
152448
152477
in: query
152449
152478
name: filter[configured]
152450
152479
required: false
152451
152480
schema:
152452
152481
type: boolean
152482
+
- description: Only return metrics that are eligible (`true`) or ineligible (`false`) for configuration with Metrics Without Limits.
152483
+
example: true
152484
+
in: query
152485
+
name: filter[is_configurable]
152486
+
required: false
152487
+
schema:
152488
+
type: boolean
152453
152489
- description: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
152454
152490
example: "app,env"
152455
152491
in: query
@@ -152507,6 +152543,20 @@ paths:
152507
152543
required: false
152508
152544
schema:
152509
152545
type: boolean
152546
+
- description: Include related resources in the response. Set to `metric_volumes` to include indexed and ingested volume counts for each metric.
152547
+
example: metric_volumes
152548
+
in: query
152549
+
name: include
152550
+
required: false
152551
+
schema:
152552
+
type: string
152553
+
- description: "Sort results by metric volume. Prefix a key with `-` for descending order. Supported keys: `metric_volumes.indexed_volume`, `metric_volumes.ingested_volume`, `metric_volumes.indexed_volume_delta`, `metric_volumes.ingested_volume_delta`. Requires a paginated request (`page[size]` or `page[cursor]`)."
152554
+
example: "-metric_volumes.indexed_volume"
152555
+
in: query
152556
+
name: sort
152557
+
required: false
152558
+
schema:
152559
+
type: string
152510
152560
- description: |-
152511
152561
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.
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``.
1172
1190
1173
-
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
1191
+
:param filter_configured: Only return custom metrics that have been configured ( ``true`` ) or not configured ( ``false`` ) with Metrics Without Limits.
1174
1192
:type filter_configured: bool, optional
1193
+
:param filter_is_configurable: Only return metrics that are eligible ( ``true`` ) or ineligible ( ``false`` ) for configuration with Metrics Without Limits.
1194
+
:type filter_is_configurable: bool, optional
1175
1195
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
1176
1196
:type filter_tags_configured: str, optional
1177
1197
:param filter_metric_type: Only return metrics of the given metric type.
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
1188
1208
:type filter_related_assets: bool, optional
1209
+
:param include: Include related resources in the response. Set to ``metric_volumes`` to include indexed and ingested volume counts for each metric.
1210
+
:type include: str, optional
1211
+
:param sort: Sort results by metric volume. Prefix a key with ``-`` for descending order. Supported keys: ``metric_volumes.indexed_volume`` , ``metric_volumes.ingested_volume`` , ``metric_volumes.indexed_volume_delta`` , ``metric_volumes.ingested_volume_delta``. Requires a paginated request ( ``page[size]`` or ``page[cursor]`` ).
1212
+
:type sort: str, optional
1189
1213
: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.
1190
1214
:type window_seconds: int, optional
1191
1215
: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.
Provide a paginated version of :meth:`list_tag_configurations`, returning all items.
1251
1287
1252
-
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
1288
+
:param filter_configured: Only return custom metrics that have been configured ( ``true`` ) or not configured ( ``false`` ) with Metrics Without Limits.
1253
1289
:type filter_configured: bool, optional
1290
+
:param filter_is_configurable: Only return metrics that are eligible ( ``true`` ) or ineligible ( ``false`` ) for configuration with Metrics Without Limits.
1291
+
:type filter_is_configurable: bool, optional
1254
1292
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
1255
1293
:type filter_tags_configured: str, optional
1256
1294
:param filter_metric_type: Only return metrics of the given metric type.
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
1267
1305
:type filter_related_assets: bool, optional
1306
+
:param include: Include related resources in the response. Set to ``metric_volumes`` to include indexed and ingested volume counts for each metric.
1307
+
:type include: str, optional
1308
+
:param sort: Sort results by metric volume. Prefix a key with ``-`` for descending order. Supported keys: ``metric_volumes.indexed_volume`` , ``metric_volumes.ingested_volume`` , ``metric_volumes.indexed_volume_delta`` , ``metric_volumes.ingested_volume_delta``. Requires a paginated request ( ``page[size]`` or ``page[cursor]`` ).
1309
+
:type sort: str, optional
1268
1310
: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.
1269
1311
:type window_seconds: int, optional
1270
1312
: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.
0 commit comments