Update metrics all-tags endpoint documentation (#3601)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -32619,7 +32619,7 @@ components:
       x-enum-varnames:
       - ACTIVELY_QUERIED_CONFIGURATIONS
     MetricAllTags:
-      description: Object for a single metric's indexed tags.
+      description: Object for a single metric's indexed and ingested tags.
       properties:
         attributes:
           $ref: '#/components/schemas/MetricAllTagsAttributes'
@@ -32629,21 +32629,33 @@ components:
           $ref: '#/components/schemas/MetricType'
       type: object
     MetricAllTagsAttributes:
-      description: Object containing the definition of a metric's tags.
+      description: Object containing the definition of a metric's indexed and ingested
+        tags.
       properties:
+        ingested_tags:
+          description: List of ingested tags that are not indexed.
+          example:
+          - env:prod
+          - service:web
+          - version:1.0
+          items:
+            description: Ingested tags for the metric.
+            type: string
+          type: array
         tags:
-          description: List of indexed tag value pairs.
+          description: List of indexed tags.
           example:
           - sport:golf
           - sport:football
           - animal:dog
           items:
-            description: Tag key-value pairs.
+            description: Indexed tags for the metric.
             type: string
           type: array
       type: object
     MetricAllTagsResponse:
-      description: Response object that includes a single metric's indexed tags.
+      description: Response object that includes a single metric's indexed and ingested
+        tags.
       properties:
         data:
           $ref: '#/components/schemas/MetricAllTags'
@@ -77321,11 +77333,74 @@ paths:
         - metrics_read
   /api/v2/metrics/{metric_name}/all-tags:
     get:
-      description: View indexed tag key-value pairs for a given metric name over the
-        previous hour.
+      description: 'View indexed and ingested tags for a given metric name.
+
+        Results are filtered by the `window[seconds]` parameter, which defaults to
+        14400 (4 hours).'
       operationId: ListTagsByMetricName
       parameters:
       - $ref: '#/components/parameters/MetricName'
+      - description: 'The number of seconds of look back (from now) to query for tag
+          data.
+
+          Default value is 14400 (4 hours), minimum value is 14400 (4 hours).'
+        example: 14400
+        in: query
+        name: window[seconds]
+        required: false
+        schema:
+          format: int64
+          type: integer
+      - description: 'Filter results to tags from data points that have the specified
+          tags.
+
+          For example, `filter[tags]=env:staging,host:123` returns tags only from
+          data points with both `env:staging` and `host:123`.'
+        example: env:staging,host:123
+        in: query
+        name: filter[tags]
+        required: false
+        schema:
+          type: string
+      - description: 'Filter returned tags to those matching a substring.
+
+          For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`,
+          etc.'
+        example: env
+        in: query
+        name: filter[match]
+        required: false
+        schema:
+          type: string
+      - description: 'Whether to include tag values in the response.
+
+          Defaults to true.'
+        example: true
+        in: query
+        name: filter[include_tag_values]
+        required: false
+        schema:
+          type: boolean
+      - description: 'Whether to allow partial results.
+
+          Defaults to false.'
+        example: false
+        in: query
+        name: filter[allow_partial]
+        required: false
+        schema:
+          type: boolean
+      - description: Maximum number of results to return.
+        example: 1000
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 1000000
+          format: int32
+          maximum: 1000000
+          minimum: 1
+          type: integer
       responses:
         '200':
           content:

api/datadogV2/api_metrics.go

@@ -1080,15 +1080,76 @@ func (a *MetricsApi) ListTagConfigurationsWithPagination(ctx _context.Context, o
 	return items, cancel
 }
 
+// ListTagsByMetricNameOptionalParameters holds optional parameters for ListTagsByMetricName.
+type ListTagsByMetricNameOptionalParameters struct {
+	WindowSeconds          *int64
+	FilterTags             *string
+	FilterMatch            *string
+	FilterIncludeTagValues *bool
+	FilterAllowPartial     *bool
+	PageLimit              *int32
+}
+
+// NewListTagsByMetricNameOptionalParameters creates an empty struct for parameters.
+func NewListTagsByMetricNameOptionalParameters() *ListTagsByMetricNameOptionalParameters {
+	this := ListTagsByMetricNameOptionalParameters{}
+	return &this
+}
+
+// WithWindowSeconds sets the corresponding parameter name and returns the struct.
+func (r *ListTagsByMetricNameOptionalParameters) WithWindowSeconds(windowSeconds int64) *ListTagsByMetricNameOptionalParameters {
+	r.WindowSeconds = &windowSeconds
+	return r
+}
+
+// WithFilterTags sets the corresponding parameter name and returns the struct.
+func (r *ListTagsByMetricNameOptionalParameters) WithFilterTags(filterTags string) *ListTagsByMetricNameOptionalParameters {
+	r.FilterTags = &filterTags
+	return r
+}
+
+// WithFilterMatch sets the corresponding parameter name and returns the struct.
+func (r *ListTagsByMetricNameOptionalParameters) WithFilterMatch(filterMatch string) *ListTagsByMetricNameOptionalParameters {
+	r.FilterMatch = &filterMatch
+	return r
+}
+
+// WithFilterIncludeTagValues sets the corresponding parameter name and returns the struct.
+func (r *ListTagsByMetricNameOptionalParameters) WithFilterIncludeTagValues(filterIncludeTagValues bool) *ListTagsByMetricNameOptionalParameters {
+	r.FilterIncludeTagValues = &filterIncludeTagValues
+	return r
+}
+
+// WithFilterAllowPartial sets the corresponding parameter name and returns the struct.
+func (r *ListTagsByMetricNameOptionalParameters) WithFilterAllowPartial(filterAllowPartial bool) *ListTagsByMetricNameOptionalParameters {
+	r.FilterAllowPartial = &filterAllowPartial
+	return r
+}
+
+// WithPageLimit sets the corresponding parameter name and returns the struct.
+func (r *ListTagsByMetricNameOptionalParameters) WithPageLimit(pageLimit int32) *ListTagsByMetricNameOptionalParameters {
+	r.PageLimit = &pageLimit
+	return r
+}
+
 // ListTagsByMetricName List tags by metric name.
-// View indexed tag key-value pairs for a given metric name over the previous hour.
-func (a *MetricsApi) ListTagsByMetricName(ctx _context.Context, metricName string) (MetricAllTagsResponse, *_nethttp.Response, error) {
+// View indexed and ingested tags for a given metric name.
+// Results are filtered by the `window[seconds]` parameter, which defaults to 14400 (4 hours).
+func (a *MetricsApi) ListTagsByMetricName(ctx _context.Context, metricName string, o ...ListTagsByMetricNameOptionalParameters) (MetricAllTagsResponse, *_nethttp.Response, error) {
 	var (
 		localVarHTTPMethod  = _nethttp.MethodGet
 		localVarPostBody    interface{}
 		localVarReturnValue MetricAllTagsResponse
+		optionalParams      ListTagsByMetricNameOptionalParameters
 	)
 
+	if len(o) > 1 {
+		return localVarReturnValue, nil, datadog.ReportError("only one argument of type ListTagsByMetricNameOptionalParameters is allowed")
+	}
+	if len(o) == 1 {
+		optionalParams = o[0]
+	}
+
 	localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.MetricsApi.ListTagsByMetricName")
 	if err != nil {
 		return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
@@ -1100,6 +1161,24 @@ func (a *MetricsApi) ListTagsByMetricName(ctx _context.Context, metricName strin
 	localVarHeaderParams := make(map[string]string)
 	localVarQueryParams := _neturl.Values{}
 	localVarFormParams := _neturl.Values{}
+	if optionalParams.WindowSeconds != nil {
+		localVarQueryParams.Add("window[seconds]", datadog.ParameterToString(*optionalParams.WindowSeconds, ""))
+	}
+	if optionalParams.FilterTags != nil {
+		localVarQueryParams.Add("filter[tags]", datadog.ParameterToString(*optionalParams.FilterTags, ""))
+	}
+	if optionalParams.FilterMatch != nil {
+		localVarQueryParams.Add("filter[match]", datadog.ParameterToString(*optionalParams.FilterMatch, ""))
+	}
+	if optionalParams.FilterIncludeTagValues != nil {
+		localVarQueryParams.Add("filter[include_tag_values]", datadog.ParameterToString(*optionalParams.FilterIncludeTagValues, ""))
+	}
+	if optionalParams.FilterAllowPartial != nil {
+		localVarQueryParams.Add("filter[allow_partial]", datadog.ParameterToString(*optionalParams.FilterAllowPartial, ""))
+	}
+	if optionalParams.PageLimit != nil {
+		localVarQueryParams.Add("page[limit]", datadog.ParameterToString(*optionalParams.PageLimit, ""))
+	}
 	localVarHeaderParams["Accept"] = "application/json"
 
 	if a.Client.Cfg.DelegatedTokenConfig != nil {

api/datadogV2/model_metric_all_tags.go

@@ -8,9 +8,9 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// MetricAllTags Object for a single metric's indexed tags.
+// MetricAllTags Object for a single metric's indexed and ingested tags.
 type MetricAllTags struct {
-	// Object containing the definition of a metric's tags.
+	// Object containing the definition of a metric's indexed and ingested tags.
 	Attributes *MetricAllTagsAttributes `json:"attributes,omitempty"`
 	// The metric name for this resource.
 	Id *string `json:"id,omitempty"`

api/datadogV2/model_metric_all_tags_attributes.go

@@ -8,9 +8,11 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// MetricAllTagsAttributes Object containing the definition of a metric's tags.
+// MetricAllTagsAttributes Object containing the definition of a metric's indexed and ingested tags.
 type MetricAllTagsAttributes struct {
-	// List of indexed tag value pairs.
+	// List of ingested tags that are not indexed.
+	IngestedTags []string `json:"ingested_tags,omitempty"`
+	// List of indexed tags.
 	Tags []string `json:"tags,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
@@ -34,6 +36,34 @@ func NewMetricAllTagsAttributesWithDefaults() *MetricAllTagsAttributes {
 	return &this
 }
 
+// GetIngestedTags returns the IngestedTags field value if set, zero value otherwise.
+func (o *MetricAllTagsAttributes) GetIngestedTags() []string {
+	if o == nil || o.IngestedTags == nil {
+		var ret []string
+		return ret
+	}
+	return o.IngestedTags
+}
+
+// GetIngestedTagsOk returns a tuple with the IngestedTags field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *MetricAllTagsAttributes) GetIngestedTagsOk() (*[]string, bool) {
+	if o == nil || o.IngestedTags == nil {
+		return nil, false
+	}
+	return &o.IngestedTags, true
+}
+
+// HasIngestedTags returns a boolean if a field has been set.
+func (o *MetricAllTagsAttributes) HasIngestedTags() bool {
+	return o != nil && o.IngestedTags != nil
+}
+
+// SetIngestedTags gets a reference to the given []string and assigns it to the IngestedTags field.
+func (o *MetricAllTagsAttributes) SetIngestedTags(v []string) {
+	o.IngestedTags = v
+}
+
 // GetTags returns the Tags field value if set, zero value otherwise.
 func (o *MetricAllTagsAttributes) GetTags() []string {
 	if o == nil || o.Tags == nil {
@@ -68,6 +98,9 @@ func (o MetricAllTagsAttributes) MarshalJSON() ([]byte, error) {
 	if o.UnparsedObject != nil {
 		return datadog.Marshal(o.UnparsedObject)
 	}
+	if o.IngestedTags != nil {
+		toSerialize["ingested_tags"] = o.IngestedTags
+	}
 	if o.Tags != nil {
 		toSerialize["tags"] = o.Tags
 	}
@@ -81,17 +114,19 @@ func (o MetricAllTagsAttributes) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON deserializes the given payload.
 func (o *MetricAllTagsAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Tags []string `json:"tags,omitempty"`
+		IngestedTags []string `json:"ingested_tags,omitempty"`
+		Tags         []string `json:"tags,omitempty"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"tags"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"ingested_tags", "tags"})
 	} else {
 		return err
 	}
+	o.IngestedTags = all.IngestedTags
 	o.Tags = all.Tags
 
 	if len(additionalProperties) > 0 {

api/datadogV2/model_metric_all_tags_response.go

@@ -8,9 +8,9 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// MetricAllTagsResponse Response object that includes a single metric's indexed tags.
+// MetricAllTagsResponse Response object that includes a single metric's indexed and ingested tags.
 type MetricAllTagsResponse struct {
-	// Object for a single metric's indexed tags.
+	// Object for a single metric's indexed and ingested tags.
 	Data *MetricAllTags `json:"data,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

examples/v2/metrics/ListTagsByMetricName.go

@@ -20,7 +20,7 @@ func main() {
 	configuration := datadog.NewConfiguration()
 	apiClient := datadog.NewAPIClient(configuration)
 	api := datadogV2.NewMetricsApi(apiClient)
-	resp, r, err := api.ListTagsByMetricName(ctx, MetricTagConfigurationDataID)
+	resp, r, err := api.ListTagsByMetricName(ctx, MetricTagConfigurationDataID, *datadogV2.NewListTagsByMetricNameOptionalParameters())
 
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.ListTagsByMetricName`: %v\n", err)