Skip to content

Commit 40077f2

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update estimate docs with realtime changes (#2024)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 7c9f4da commit 40077f2

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-09-25 18:54:10.257631",
8-
"spec_repo_commit": "1fa8186c"
7+
"regenerated": "2024-09-26 19:34:33.342614",
8+
"spec_repo_commit": "83debf9e"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-09-25 18:54:10.272586",
13-
"spec_repo_commit": "1fa8186c"
12+
"regenerated": "2024-09-26 19:34:33.356783",
13+
"spec_repo_commit": "83debf9e"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32775,8 +32775,7 @@ paths:
3277532775
schema:
3277632776
type: string
3277732777
- description: The number of hours of look back (from now) to estimate cardinality
32778-
with. Estimates are based on historical data, and unspecified fields default
32779-
to the minimum 49 hours.
32778+
with. If unspecified, it defaults to 0 hours.
3278032779
example: 49
3278132780
in: query
3278232781
name: filter[hours_ago]
@@ -32805,7 +32804,7 @@ paths:
3280532804
schema:
3280632805
type: boolean
3280732806
- description: A window, in hours, from the look back to estimate cardinality
32808-
with.
32807+
with. The minimum and default is 1 hour.
3280932808
example: 6
3281032809
in: query
3281132810
name: filter[timespan_h]

lib/datadog_api_client/v2/api/metrics_api.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,10 +323,10 @@ def estimate_metrics_output_series(metric_name, opts = {})
323323
# @param metric_name [String] The name of the metric.
324324
# @param opts [Hash] the optional parameters
325325
# @option opts [String] :filter_groups Filtered tag keys that the metric is configured to query with.
326-
# @option opts [Integer] :filter_hours_ago The number of hours of look back (from now) to estimate cardinality with. Estimates are based on historical data, and unspecified fields default to the minimum 49 hours.
326+
# @option opts [Integer] :filter_hours_ago The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
327327
# @option opts [Integer] :filter_num_aggregations The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9.
328328
# @option opts [Boolean] :filter_pct A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
329-
# @option opts [Integer] :filter_timespan_h A window, in hours, from the look back to estimate cardinality with.
329+
# @option opts [Integer] :filter_timespan_h A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.
330330
# @return [Array<(MetricEstimateResponse, Integer, Hash)>] MetricEstimateResponse data, response status code and response headers
331331
def estimate_metrics_output_series_with_http_info(metric_name, opts = {})
332332

0 commit comments

Comments
 (0)