Skip to content

Update UA API docs to reflect deprecated values for estimated usage types #2666

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.

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-08 19:08:06.138597",
"spec_repo_commit": "7b042e12"
"regenerated": "2025-07-09 16:47:20.055079",
"spec_repo_commit": "d0906173"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-08 19:08:06.154349",
"spec_repo_commit": "7b042e12"
"regenerated": "2025-07-09 16:47:20.070361",
"spec_repo_commit": "d0906173"
}
}
}
28 changes: 23 additions & 5 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4171,7 +4171,10 @@ components:
type: array
type: object
HourlyUsageAttributionUsageType:
description: Supported products for hourly usage attribution requests.
description: 'Supported products for hourly usage attribution requests.

The following values have been **deprecated**: `estimated_indexed_spans_usage`,
`estimated_ingested_spans_usage`.'
enum:
- api_usage
- apm_fargate_usage
Expand Down Expand Up @@ -8535,7 +8538,10 @@ components:
- SCA_FARGATE_PERCENTAGE
- ALL
MonthlyUsageAttributionValues:
description: Fields in Usage Summary by tag(s).
description: 'Fields in Usage Summary by tag(s).

The following values have been **deprecated**: `estimated_indexed_spans_usage`,
`estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.'
properties:
api_percentage:
description: The percentage of synthetic API test usage by tag(s).
Expand Down Expand Up @@ -35406,7 +35412,9 @@ paths:
schema:
format: date-time
type: string
- description: Usage type to retrieve.
- description: 'Usage type to retrieve. The following values have been **deprecated**:

`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
in: query
name: usage_type
required: true
Expand Down Expand Up @@ -35956,8 +35964,13 @@ paths:
schema:
format: date-time
type: string
- description: Comma-separated list of usage types to return, or `*` for all
- description: 'Comma-separated list of usage types to return, or `*` for all
usage types.

The following values have been **deprecated**:

`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
`estimated_ingested_spans_percentage`.'
in: query
name: fields
required: true
Expand All @@ -35969,7 +35982,12 @@ paths:
required: false
schema:
$ref: '#/components/schemas/UsageSortDirection'
- description: The field to sort by.
- description: 'The field to sort by.

The following values have been **deprecated**:

`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
`estimated_ingested_spans_percentage`.'
in: query
name: sort_name
required: false
Expand Down
7 changes: 6 additions & 1 deletion src/datadog_api_client/v1/api/usage_metering_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1282,7 +1282,8 @@ def get_hourly_usage_attribution(

:param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour.
:type start_hr: datetime
:param usage_type: Usage type to retrieve.
:param usage_type: Usage type to retrieve. The following values have been **deprecated** :
``estimated_indexed_spans_usage`` , ``estimated_ingested_spans_usage``.
:type usage_type: HourlyUsageAttributionUsageType
:param end_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage ending
**before** this hour.
Expand Down Expand Up @@ -1444,12 +1445,16 @@ def get_monthly_usage_attribution(
Maximum of 15 months ago.
:type start_month: datetime
:param fields: Comma-separated list of usage types to return, or ``*`` for all usage types.
The following values have been **deprecated** :
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
:type fields: MonthlyUsageAttributionSupportedMetrics
:param end_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for usage ending this month.
:type end_month: datetime, optional
:param sort_direction: The direction to sort by: ``[desc, asc]``.
:type sort_direction: UsageSortDirection, optional
:param sort_name: The field to sort by.
The following values have been **deprecated** :
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
:type sort_name: MonthlyUsageAttributionSupportedMetrics, optional
: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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ def __init__(
:type updated_at: str, optional

:param usage_type: Supported products for hourly usage attribution requests.
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_ingested_spans_usage``.
:type usage_type: HourlyUsageAttributionUsageType, optional
"""
if hour is not unset:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
class HourlyUsageAttributionUsageType(ModelSimple):
"""
Supported products for hourly usage attribution requests.
The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.

: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"].
:type value: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ def __init__(
:type updated_at: datetime, optional

:param values: Fields in Usage Summary by tag(s).
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
:type values: MonthlyUsageAttributionValues, optional
"""
if month is not unset:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,7 @@ def __init__(
):
"""
Fields in Usage Summary by tag(s).
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.

:param api_percentage: The percentage of synthetic API test usage by tag(s).
:type api_percentage: float, optional
Expand Down
Loading