Skip to content

Clarify metrics API query strings #3772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −12
Open

Clarify metrics API query strings #3772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107887,6 +107887,8 @@ paths:
get:
description: |-
Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters.

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`.
operationId: ListTagConfigurations
parameters:
- description: Only return custom metrics that have been configured with Metrics Without Limits.
Expand Down Expand Up @@ -107926,7 +107928,7 @@ paths:
schema:
type: boolean
- description: |-
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.
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`.
example: 15552000
in: query
name: filter[queried][window][seconds]
Expand All @@ -107938,7 +107940,7 @@ paths:
minimum: 1
type: integer
- description: |-
Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
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*`.
example: "env IN (staging,test) AND service:web*"
in: query
name: filter[tags]
Expand All @@ -107965,7 +107967,8 @@ paths:
maximum: 2592000
minimum: 1
type: integer
- 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.
- description: |-
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.
in: query
name: page[size]
required: false
Expand Down Expand Up @@ -108369,7 +108372,8 @@ paths:
operationId: EstimateMetricsOutputSeries
parameters:
- $ref: "#/components/parameters/MetricName"
- description: Filtered tag keys that the metric is configured to query with.
- description: |-
Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
example: "app,host"
in: query
name: filter[groups]
Expand Down
27 changes: 19 additions & 8 deletions src/main/java/com/datadog/api/client/v2/api/MetricsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,8 @@ public static class EstimateMetricsOutputSeriesOptionalParameters {
/**
* Set filterGroups.
*
* @param filterGroups Filtered tag keys that the metric is configured to query with. (optional)
* @param filterGroups Comma-separated list of tag keys that the metric is configured to query
* with. For example: <code>filter[groups]=app,host</code>. (optional)
* @return EstimateMetricsOutputSeriesOptionalParameters
*/
public EstimateMetricsOutputSeriesOptionalParameters filterGroups(String filterGroups) {
Expand Down Expand Up @@ -1670,10 +1671,12 @@ public ListTagConfigurationsOptionalParameters filterQueried(Boolean filterQueri
/**
* Set filterQueriedWindowSeconds.
*
* @param filterQueriedWindowSeconds Only return metrics that have been queried or not queried
* in the specified window. Dependent on being sent with <code>filter[queried]</code>. 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. (optional, default to 2592000)
* @param filterQueriedWindowSeconds This parameter has no effect unless <code>filter[queried]
* </code> 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: <code>
* filter[queried]=true&amp;filter[queried][window][seconds]=604800</code>. (optional,
* default to 2592000)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterQueriedWindowSeconds(
Expand All @@ -1686,7 +1689,8 @@ public ListTagConfigurationsOptionalParameters filterQueriedWindowSeconds(
* Set filterTags.
*
* @param filterTags Only return metrics that were submitted with tags matching this expression.
* You can use AND, OR, IN, and wildcards (for example, service:web*). (optional)
* You can use AND, OR, IN, and wildcards. For example: <code>
* filter[tags]=env IN (staging,test) AND service:web*</code>. (optional)
* @return ListTagConfigurationsOptionalParameters
*/
public ListTagConfigurationsOptionalParameters filterTags(String filterTags) {
Expand Down Expand Up @@ -1723,8 +1727,10 @@ public ListTagConfigurationsOptionalParameters windowSeconds(Long windowSeconds)
/**
* Set pageSize.
*
* @param pageSize Maximum number of results per page. Use with <code>page[cursor]</code> for
* pagination. The default value is 10000, the maximum value is 10000, and the minimum value
* @param pageSize Maximum number of results per page. Send <code>page[size]</code> on the first
* request to opt in to pagination. On each subsequent request, send <code>page[cursor]
* </code> set to the value of <code>meta.pagination.next_cursor</code> from the previous
* response. The default value is 10000, the maximum value is 10000, and the minimum value
* is 1. (optional, default to 10000)
* @return ListTagConfigurationsOptionalParameters
*/
Expand Down Expand Up @@ -1867,6 +1873,11 @@ public PaginationIterable<MetricsAndMetricTagConfigurations> listTagConfiguratio
* Get a list of actively reporting metrics for your organization. Pagination is optional using
* the <code>page[cursor]</code> and <code>page[size]</code> query parameters.
*
* <p>Query parameters use bracket notation (for example, <code>filter[tags]</code>, <code>
* filter[queried][window][seconds]</code>). Pass them as standard URL query strings, URL-encoding
* the brackets if your client does not handle them. For example: <code>
* GET /api/v2/metrics?filter[tags]=env:prod&amp;window[seconds]=86400&amp;page[size]=500</code>.
*
* @param parameters Optional parameters for the request.
* @return ApiResponse&lt;MetricsAndMetricTagConfigurationsResponse&gt;
* @throws ApiException if fails to make API call
Expand Down
Loading