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).
1991
1990
* @type boolean
1992
1991
*/
1993
1992
filterIncludePercentiles?: boolean;
1994
1993
/**
1995
-
* (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].
1996
-
* If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
1994
+
* 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.
1997
1995
* @type boolean
1998
1996
*/
1999
1997
filterQueried?: boolean;
2000
1998
/**
2001
-
* The number of seconds of look back (from now) used by the `filter[queried]` filter logic.
2002
-
* Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`.
2003
-
* If `filter[queried]=false`, this parameter is ignored and default queried-window behavior applies.
2004
-
* If `filter[queried]` is not provided, sending this parameter returns a 400.
2005
-
* For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`.
1999
+
* Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`.
2006
2000
* @type number
2007
2001
*/
2008
2002
filterQueriedWindowSeconds?: number;
2009
2003
/**
2010
-
* Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
2011
-
* Can only be combined with the filter[queried] filter.
2004
+
* Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
2012
2005
* @type string
2013
2006
*/
2014
2007
filterTags?: string;
2015
2008
/**
2016
-
* (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
2009
+
* Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
2017
2010
* @type boolean
2018
2011
*/
2019
2012
filterRelatedAssets?: boolean;
2020
2013
/**
2021
-
* The number of seconds of look back (from now) to apply to a filter[tag] query.
2022
-
* Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).
2014
+
* Only return metrics that have been actively reporting in the specified window.
2023
2015
* @type number
2024
2016
*/
2025
2017
windowSeconds?: number;
2026
2018
/**
2027
-
* Maximum number of results returned.
2019
+
* Maximum number of results per page. Use with `page[cursor]` for pagination.
2028
2020
* @type number
2029
2021
*/
2030
2022
pageSize?: number;
2031
2023
/**
2032
-
* String to query the next page of results.
2033
-
* This key is provided with each valid response from the API in `meta.pagination.next_cursor`.
2034
-
* Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved.
2024
+
* 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.
2035
2025
* @type string
2036
2026
*/
2037
2027
pageCursor?: string;
@@ -2369,10 +2359,7 @@ export class MetricsApi {
2369
2359
}
2370
2360
2371
2361
/**
2372
-
* Returns all metrics for your organization that match the given filter parameters.
2373
-
* Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters.
2374
-
* 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.
2375
-
* Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved.
2362
+
* 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