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
* Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
2119
2118
* @type boolean
2120
2119
*/
2121
2120
filterIncludePercentiles?: boolean;
2122
2121
/**
2123
-
* (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].
2124
-
* If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
2122
+
* 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.
2125
2123
* @type boolean
2126
2124
*/
2127
2125
filterQueried?: boolean;
2128
2126
/**
2129
-
* The number of seconds of look back (from now) used by the `filter[queried]` filter logic.
2130
-
* Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`.
2131
-
* If `filter[queried]=false`, this parameter is ignored and default queried-window behavior applies.
2132
-
* If `filter[queried]` is not provided, sending this parameter returns a 400.
2133
-
* For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`.
2127
+
* Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`.
2134
2128
* @type number
2135
2129
*/
2136
2130
filterQueriedWindowSeconds?: number;
2137
2131
/**
2138
-
* Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
2139
-
* Can only be combined with the filter[queried] filter.
2132
+
* Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
2140
2133
* @type string
2141
2134
*/
2142
2135
filterTags?: string;
2143
2136
/**
2144
-
* (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
2137
+
* Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
2145
2138
* @type boolean
2146
2139
*/
2147
2140
filterRelatedAssets?: boolean;
2148
2141
/**
2149
-
* The number of seconds of look back (from now) to apply to a filter[tag] query.
2150
-
* Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).
2142
+
* Only return metrics that have been actively reporting in the specified window.
2151
2143
* @type number
2152
2144
*/
2153
2145
windowSeconds?: number;
2154
2146
/**
2155
-
* Maximum number of results returned.
2147
+
* Maximum number of results per page. Use with `page[cursor]` for pagination.
2156
2148
* @type number
2157
2149
*/
2158
2150
pageSize?: number;
2159
2151
/**
2160
-
* String to query the next page of results.
2161
-
* This key is provided with each valid response from the API in `meta.pagination.next_cursor`.
2162
-
* Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved.
2152
+
* 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.
2163
2153
* @type string
2164
2154
*/
2165
2155
pageCursor?: string;
@@ -2499,10 +2489,7 @@ export class MetricsApi {
2499
2489
}
2500
2490
2501
2491
/**
2502
-
* Returns all metrics for your organization that match the given filter parameters.
2503
-
* Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters.
2504
-
* 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.
2505
-
* Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved.
2492
+
* Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
0 commit comments