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
# Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters.
672
672
# 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.
673
673
# Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved.
674
+
# Use `include=metric_volumes` to fetch indexed and ingested volume data for each metric, and `sort` to order results by volume.
674
675
#
675
676
# @param opts [Hash] the optional parameters
676
677
# @option opts [Boolean] :filter_configured Filter custom metrics that have configured tags.
# @option opts [Integer] :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]=7776000`.
682
683
# @option opts [String] :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.
683
684
# @option opts [Boolean] :filter_related_assets (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
685
+
# @option opts [MetricVolumesInclude] :include Relationship data to include in the response. Use `metric_volumes` to include indexed and ingested volumes.
686
+
# @option opts [MetricVolumesSort] :sort Sort metrics by ingested or indexed volume. Use `-` for descending order. Supported values: `metric_volumes.indexed_volume`, `-metric_volumes.indexed_volume`, `metric_volumes.ingested_volume`, `-metric_volumes.ingested_volume`. Only supported when `include=metric_volumes` is provided.
684
687
# @option opts [Integer] :window_seconds The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query. Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).
685
688
# @option opts [Integer] :page_size Maximum number of results returned.
686
689
# @option opts [String] :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.
failArgumentError,'invalid value for "opts[:"filter_queried_window_seconds"]" when calling MetricsAPI.list_tag_configurations, must be greater than or equal to 0.'
0 commit comments