Skip to content

Commit 3e70e89

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update UA API docs to reflect deprecated values for estimated usage types (#2666)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent d40de63 commit 3e70e89

File tree

7 files changed

+37
-10
lines changed

7 files changed

+37
-10
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": "2025-07-08 19:08:06.138597",
8-
"spec_repo_commit": "7b042e12"
7+
"regenerated": "2025-07-09 16:47:20.055079",
8+
"spec_repo_commit": "d0906173"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-07-08 19:08:06.154349",
13-
"spec_repo_commit": "7b042e12"
12+
"regenerated": "2025-07-09 16:47:20.070361",
13+
"spec_repo_commit": "d0906173"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4171,7 +4171,10 @@ components:
41714171
type: array
41724172
type: object
41734173
HourlyUsageAttributionUsageType:
4174-
description: Supported products for hourly usage attribution requests.
4174+
description: 'Supported products for hourly usage attribution requests.
4175+
4176+
The following values have been **deprecated**: `estimated_indexed_spans_usage`,
4177+
`estimated_ingested_spans_usage`.'
41754178
enum:
41764179
- api_usage
41774180
- apm_fargate_usage
@@ -8535,7 +8538,10 @@ components:
85358538
- SCA_FARGATE_PERCENTAGE
85368539
- ALL
85378540
MonthlyUsageAttributionValues:
8538-
description: Fields in Usage Summary by tag(s).
8541+
description: 'Fields in Usage Summary by tag(s).
8542+
8543+
The following values have been **deprecated**: `estimated_indexed_spans_usage`,
8544+
`estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.'
85398545
properties:
85408546
api_percentage:
85418547
description: The percentage of synthetic API test usage by tag(s).
@@ -35406,7 +35412,9 @@ paths:
3540635412
schema:
3540735413
format: date-time
3540835414
type: string
35409-
- description: Usage type to retrieve.
35415+
- description: 'Usage type to retrieve. The following values have been **deprecated**:
35416+
35417+
`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
3541035418
in: query
3541135419
name: usage_type
3541235420
required: true
@@ -35956,8 +35964,13 @@ paths:
3595635964
schema:
3595735965
format: date-time
3595835966
type: string
35959-
- description: Comma-separated list of usage types to return, or `*` for all
35967+
- description: 'Comma-separated list of usage types to return, or `*` for all
3596035968
usage types.
35969+
35970+
The following values have been **deprecated**:
35971+
35972+
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
35973+
`estimated_ingested_spans_percentage`.'
3596135974
in: query
3596235975
name: fields
3596335976
required: true
@@ -35969,7 +35982,12 @@ paths:
3596935982
required: false
3597035983
schema:
3597135984
$ref: '#/components/schemas/UsageSortDirection'
35972-
- description: The field to sort by.
35985+
- description: 'The field to sort by.
35986+
35987+
The following values have been **deprecated**:
35988+
35989+
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
35990+
`estimated_ingested_spans_percentage`.'
3597335991
in: query
3597435992
name: sort_name
3597535993
required: false

src/datadog_api_client/v1/api/usage_metering_api.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1282,7 +1282,8 @@ def get_hourly_usage_attribution(
12821282
12831283
:param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour.
12841284
:type start_hr: datetime
1285-
:param usage_type: Usage type to retrieve.
1285+
:param usage_type: Usage type to retrieve. The following values have been **deprecated** :
1286+
``estimated_indexed_spans_usage`` , ``estimated_ingested_spans_usage``.
12861287
:type usage_type: HourlyUsageAttributionUsageType
12871288
:param end_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage ending
12881289
**before** this hour.
@@ -1444,12 +1445,16 @@ def get_monthly_usage_attribution(
14441445
Maximum of 15 months ago.
14451446
:type start_month: datetime
14461447
:param fields: Comma-separated list of usage types to return, or ``*`` for all usage types.
1448+
The following values have been **deprecated** :
1449+
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
14471450
:type fields: MonthlyUsageAttributionSupportedMetrics
14481451
:param end_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for usage ending this month.
14491452
:type end_month: datetime, optional
14501453
:param sort_direction: The direction to sort by: ``[desc, asc]``.
14511454
:type sort_direction: UsageSortDirection, optional
14521455
:param sort_name: The field to sort by.
1456+
The following values have been **deprecated** :
1457+
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
14531458
:type sort_name: MonthlyUsageAttributionSupportedMetrics, optional
14541459
:param tag_breakdown_keys: Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.
14551460

src/datadog_api_client/v1/model/hourly_usage_attribution_body.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ def __init__(
9595
:type updated_at: str, optional
9696
9797
:param usage_type: Supported products for hourly usage attribution requests.
98+
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_ingested_spans_usage``.
9899
:type usage_type: HourlyUsageAttributionUsageType, optional
99100
"""
100101
if hour is not unset:

src/datadog_api_client/v1/model/hourly_usage_attribution_usage_type.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
class HourlyUsageAttributionUsageType(ModelSimple):
1616
"""
1717
Supported products for hourly usage attribution requests.
18+
The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
1819
1920
:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "ci_pipeline_indexed_spans_usage", "ci_test_indexed_spans_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "code_security_host_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_event_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_fargate_task_usage", "cws_hosts_usage", "data_jobs_monitoring_usage", "data_stream_monitoring_usage", "dbm_hosts_usage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_spans_usage", "estimated_ingested_spans_usage", "fargate_usage", "functions_usage", "incident_management_monthly_active_users_usage", "indexed_spans_usage", "infra_host_usage", "ingested_logs_bytes_usage", "ingested_spans_bytes_usage", "invocations_usage", "lambda_traced_invocations_usage", "llm_observability_usage", "logs_indexed_15day_usage", "logs_indexed_180day_usage", "logs_indexed_1day_usage", "logs_indexed_30day_usage", "logs_indexed_360day_usage", "logs_indexed_3day_usage", "logs_indexed_45day_usage", "logs_indexed_60day_usage", "logs_indexed_7day_usage", "logs_indexed_90day_usage", "logs_indexed_custom_retention_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "network_device_wireless_usage", "obs_pipeline_bytes_usage", "obs_pipelines_vcpu_usage", "online_archive_usage", "product_analytics_session_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "published_app", "rum_browser_mobile_sessions_usage", "rum_ingested_usage", "rum_investigate_usage", "rum_replay_sessions_usage", "rum_session_replay_add_on_usage", "sca_fargate_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "siem_analyzed_logs_add_on_usage", "siem_ingested_bytes_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage", "workflow_executions_usage"].
2021
:type value: str

src/datadog_api_client/v1/model/monthly_usage_attribution_body.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ def __init__(
8989
:type updated_at: datetime, optional
9090
9191
:param values: Fields in Usage Summary by tag(s).
92+
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
9293
:type values: MonthlyUsageAttributionValues, optional
9394
"""
9495
if month is not unset:

src/datadog_api_client/v1/model/monthly_usage_attribution_values.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,7 @@ def __init__(
484484
):
485485
"""
486486
Fields in Usage Summary by tag(s).
487+
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
487488
488489
:param api_percentage: The percentage of synthetic API test usage by tag(s).
489490
:type api_percentage: float, optional

0 commit comments

Comments
 (0)