Skip to content

Commit 99dd89a

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 2ee70e91 of spec repo
1 parent 603948a commit 99dd89a

File tree

12 files changed

+416
-4
lines changed

12 files changed

+416
-4
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-06-23 18:01:49.583341",
8-
"spec_repo_commit": "9a201ac7"
7+
"regenerated": "2025-06-23 19:57:10.881556",
8+
"spec_repo_commit": "2ee70e91"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-23 18:01:49.599181",
13-
"spec_repo_commit": "9a201ac7"
12+
"regenerated": "2025-06-23 19:57:10.896271",
13+
"spec_repo_commit": "2ee70e91"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22492,6 +22492,61 @@ components:
2249222492
type: string
2249322493
type: array
2249422494
type: object
22495+
MetricTagCardinalitiesData:
22496+
description: A list of tag cardinalities associated with the given metric.
22497+
items:
22498+
$ref: '#/components/schemas/MetricTagCardinality'
22499+
type: array
22500+
MetricTagCardinalitiesMeta:
22501+
description: Response metadata object.
22502+
properties:
22503+
metric_name:
22504+
description: 'The name of metric for which the tag cardinalities are returned.
22505+
22506+
This matches the metric name provided in the request.
22507+
22508+
'
22509+
type: string
22510+
type: object
22511+
MetricTagCardinalitiesResponse:
22512+
description: 'Response object that includes an array of objects representing
22513+
the cardinality details of a metric''s tags.
22514+
22515+
'
22516+
properties:
22517+
data:
22518+
$ref: '#/components/schemas/MetricTagCardinalitiesData'
22519+
meta:
22520+
$ref: '#/components/schemas/MetricTagCardinalitiesMeta'
22521+
readOnly: true
22522+
type: object
22523+
MetricTagCardinality:
22524+
description: Object containing metadata and attributes related to a specific
22525+
tag key associated with the metric.
22526+
example:
22527+
attributes:
22528+
cardinality_delta: 25
22529+
id: http.request.latency
22530+
type: get-tag-cardinalities
22531+
properties:
22532+
attributes:
22533+
$ref: '#/components/schemas/MetricTagCardinalityAttributes'
22534+
id:
22535+
description: The name of the tag key.
22536+
type: string
22537+
type:
22538+
default: get-tag-cardinalities
22539+
description: This describes the endpoint action.
22540+
type: string
22541+
type: object
22542+
MetricTagCardinalityAttributes:
22543+
description: An object containing properties related to the tag key
22544+
properties:
22545+
cardinality_delta:
22546+
description: This describes the recent change in the tag keys cardinality
22547+
format: int64
22548+
type: integer
22549+
type: object
2249522550
MetricTagConfiguration:
2249622551
description: Object for a single metric tag configuration.
2249722552
example:
@@ -51863,6 +51918,50 @@ paths:
5186351918
x-permission:
5186451919
operator: OPEN
5186551920
permissions: []
51921+
/api/v2/metrics/{metric_name}/tag-cardinalities:
51922+
get:
51923+
description: Returns the cardinality details of tags for a specific metric.
51924+
operationId: GetTagKeyCardinalityDetails
51925+
parameters:
51926+
- $ref: '#/components/parameters/MetricName'
51927+
responses:
51928+
'200':
51929+
content:
51930+
application/json:
51931+
schema:
51932+
$ref: '#/components/schemas/MetricTagCardinalitiesResponse'
51933+
description: Success
51934+
'400':
51935+
content:
51936+
application/json:
51937+
schema:
51938+
$ref: '#/components/schemas/APIErrorResponse'
51939+
description: Bad Request
51940+
'403':
51941+
content:
51942+
application/json:
51943+
schema:
51944+
$ref: '#/components/schemas/APIErrorResponse'
51945+
description: Forbidden
51946+
'404':
51947+
content:
51948+
application/json:
51949+
schema:
51950+
$ref: '#/components/schemas/APIErrorResponse'
51951+
description: Not Found
51952+
'429':
51953+
content:
51954+
application/json:
51955+
schema:
51956+
$ref: '#/components/schemas/APIErrorResponse'
51957+
description: Too Many Requests
51958+
summary: Get tag key cardinality details
51959+
tags:
51960+
- Metrics
51961+
x-permission:
51962+
operator: OR
51963+
permissions:
51964+
- metrics_read
5186651965
/api/v2/metrics/{metric_name}/tags:
5186751966
delete:
5186851967
description: 'Deletes a metric''s tag configuration. Can only be used with application

docs/datadog_api_client.v2.model.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9573,6 +9573,34 @@ datadog\_api\_client.v2.model.metric\_suggested\_tags\_attributes module
95739573
:members:
95749574
:show-inheritance:
95759575

9576+
datadog\_api\_client.v2.model.metric\_tag\_cardinalities\_meta module
9577+
---------------------------------------------------------------------
9578+
9579+
.. automodule:: datadog_api_client.v2.model.metric_tag_cardinalities_meta
9580+
:members:
9581+
:show-inheritance:
9582+
9583+
datadog\_api\_client.v2.model.metric\_tag\_cardinalities\_response module
9584+
-------------------------------------------------------------------------
9585+
9586+
.. automodule:: datadog_api_client.v2.model.metric_tag_cardinalities_response
9587+
:members:
9588+
:show-inheritance:
9589+
9590+
datadog\_api\_client.v2.model.metric\_tag\_cardinality module
9591+
-------------------------------------------------------------
9592+
9593+
.. automodule:: datadog_api_client.v2.model.metric_tag_cardinality
9594+
:members:
9595+
:show-inheritance:
9596+
9597+
datadog\_api\_client.v2.model.metric\_tag\_cardinality\_attributes module
9598+
-------------------------------------------------------------------------
9599+
9600+
.. automodule:: datadog_api_client.v2.model.metric_tag_cardinality_attributes
9601+
:members:
9602+
:show-inheritance:
9603+
95769604
datadog\_api\_client.v2.model.metric\_tag\_configuration module
95779605
---------------------------------------------------------------
95789606

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Get tag key cardinality details returns "Success" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.metrics_api import MetricsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = MetricsApi(api_client)
11+
response = api_instance.get_tag_key_cardinality_details(
12+
metric_name="metric_name",
13+
)
14+
15+
print(response)

src/datadog_api_client/v2/api/metrics_api.py

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
from datadog_api_client.v2.model.metric_all_tags_response import MetricAllTagsResponse
3131
from datadog_api_client.v2.model.metric_assets_response import MetricAssetsResponse
3232
from datadog_api_client.v2.model.metric_estimate_response import MetricEstimateResponse
33+
from datadog_api_client.v2.model.metric_tag_cardinalities_response import MetricTagCardinalitiesResponse
3334
from datadog_api_client.v2.model.metric_tag_configuration_response import MetricTagConfigurationResponse
3435
from datadog_api_client.v2.model.metric_tag_configuration_update_request import MetricTagConfigurationUpdateRequest
3536
from datadog_api_client.v2.model.metric_tag_configuration_create_request import MetricTagConfigurationCreateRequest
@@ -214,6 +215,29 @@ def __init__(self, api_client=None):
214215
api_client=api_client,
215216
)
216217

218+
self._get_tag_key_cardinality_details_endpoint = _Endpoint(
219+
settings={
220+
"response_type": (MetricTagCardinalitiesResponse,),
221+
"auth": ["apiKeyAuth", "appKeyAuth"],
222+
"endpoint_path": "/api/v2/metrics/{metric_name}/tag-cardinalities",
223+
"operation_id": "get_tag_key_cardinality_details",
224+
"http_method": "GET",
225+
"version": "v2",
226+
},
227+
params_map={
228+
"metric_name": {
229+
"required": True,
230+
"openapi_types": (str,),
231+
"attribute": "metric_name",
232+
"location": "path",
233+
},
234+
},
235+
headers_map={
236+
"accept": ["application/json"],
237+
},
238+
api_client=api_client,
239+
)
240+
217241
self._list_active_metric_configurations_endpoint = _Endpoint(
218242
settings={
219243
"response_type": (MetricSuggestedTagsAndAggregationsResponse,),
@@ -628,6 +652,23 @@ def estimate_metrics_output_series(
628652

629653
return self._estimate_metrics_output_series_endpoint.call_with_http_info(**kwargs)
630654

655+
def get_tag_key_cardinality_details(
656+
self,
657+
metric_name: str,
658+
) -> MetricTagCardinalitiesResponse:
659+
"""Get tag key cardinality details.
660+
661+
Returns the cardinality details of tags for a specific metric.
662+
663+
:param metric_name: The name of the metric.
664+
:type metric_name: str
665+
:rtype: MetricTagCardinalitiesResponse
666+
"""
667+
kwargs: Dict[str, Any] = {}
668+
kwargs["metric_name"] = metric_name
669+
670+
return self._get_tag_key_cardinality_details_endpoint.call_with_http_info(**kwargs)
671+
631672
def list_active_metric_configurations(
632673
self,
633674
metric_name: str,
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import Union
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
class MetricTagCardinalitiesMeta(ModelNormal):
17+
@cached_property
18+
def openapi_types(_):
19+
return {
20+
"metric_name": (str,),
21+
}
22+
23+
attribute_map = {
24+
"metric_name": "metric_name",
25+
}
26+
27+
def __init__(self_, metric_name: Union[str, UnsetType] = unset, **kwargs):
28+
"""
29+
Response metadata object.
30+
31+
:param metric_name: The name of metric for which the tag cardinalities are returned.
32+
This matches the metric name provided in the request.
33+
:type metric_name: str, optional
34+
"""
35+
if metric_name is not unset:
36+
kwargs["metric_name"] = metric_name
37+
super().__init__(kwargs)
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import List, Union, TYPE_CHECKING
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
if TYPE_CHECKING:
17+
from datadog_api_client.v2.model.metric_tag_cardinality import MetricTagCardinality
18+
from datadog_api_client.v2.model.metric_tag_cardinalities_meta import MetricTagCardinalitiesMeta
19+
20+
21+
class MetricTagCardinalitiesResponse(ModelNormal):
22+
@cached_property
23+
def openapi_types(_):
24+
from datadog_api_client.v2.model.metric_tag_cardinality import MetricTagCardinality
25+
from datadog_api_client.v2.model.metric_tag_cardinalities_meta import MetricTagCardinalitiesMeta
26+
27+
return {
28+
"data": ([MetricTagCardinality],),
29+
"meta": (MetricTagCardinalitiesMeta,),
30+
}
31+
32+
attribute_map = {
33+
"data": "data",
34+
"meta": "meta",
35+
}
36+
37+
def __init__(
38+
self_,
39+
data: Union[List[MetricTagCardinality], UnsetType] = unset,
40+
meta: Union[MetricTagCardinalitiesMeta, UnsetType] = unset,
41+
**kwargs,
42+
):
43+
"""
44+
Response object that includes an array of objects representing the cardinality details of a metric's tags.
45+
46+
:param data: A list of tag cardinalities associated with the given metric.
47+
:type data: [MetricTagCardinality], optional
48+
49+
:param meta: Response metadata object.
50+
:type meta: MetricTagCardinalitiesMeta, optional
51+
"""
52+
if data is not unset:
53+
kwargs["data"] = data
54+
if meta is not unset:
55+
kwargs["meta"] = meta
56+
super().__init__(kwargs)

0 commit comments

Comments
 (0)