Update metrics all-tags endpoint documentation (#3083)

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

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

datadog_api_client.v2.api.html

@@ -10023,12 +10023,26 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.metrics_api.MetricsApi.list_tags_by_metric_name">
-<span class="sig-name descname"><span class="pre">list_tags_by_metric_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_all_tags_response.MetricAllTagsResponse" title="datadog_api_client.v2.model.metric_all_tags_response.MetricAllTagsResponse"><span class="pre">MetricAllTagsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.metrics_api.MetricsApi.list_tags_by_metric_name" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">list_tags_by_metric_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window_seconds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_tags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_match</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_include_tag_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_allow_partial</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_all_tags_response.MetricAllTagsResponse" title="datadog_api_client.v2.model.metric_all_tags_response.MetricAllTagsResponse"><span class="pre">MetricAllTagsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.metrics_api.MetricsApi.list_tags_by_metric_name" title="Link to this definition">¶</a></dt>
 <dd><p>List tags by metric name.</p>
-<p>View indexed tag key-value pairs for a given metric name over the previous hour.</p>
+<p>View indexed and ingested tags for a given metric name.
+Results are filtered by the <code class="docutils literal notranslate"><span class="pre">window[seconds]</span></code> parameter, which defaults to 14400 (4 hours).</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>metric_name</strong> (<em>str</em>) – The name of the metric.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>metric_name</strong> (<em>str</em>) – The name of the metric.</p></li>
+<li><p><strong>window_seconds</strong> (<em>int</em><em>, </em><em>optional</em>) – 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).</p></li>
+<li><p><strong>filter_tags</strong> (<em>str</em><em>, </em><em>optional</em>) – Filter results to tags from data points that have the specified tags.
+For example, <code class="docutils literal notranslate"><span class="pre">filter[tags]=env:staging,host:123</span></code> returns tags only from data points with both <code class="docutils literal notranslate"><span class="pre">env:staging</span></code> and <code class="docutils literal notranslate"><span class="pre">host:123</span></code>.</p></li>
+<li><p><strong>filter_match</strong> (<em>str</em><em>, </em><em>optional</em>) – Filter returned tags to those matching a substring.
+For example, <code class="docutils literal notranslate"><span class="pre">filter[match]=env</span></code> returns tags like <code class="docutils literal notranslate"><span class="pre">env:prod</span></code> , <code class="docutils literal notranslate"><span class="pre">environment:staging</span></code> , etc.</p></li>
+<li><p><strong>filter_include_tag_values</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to include tag values in the response.
+Defaults to true.</p></li>
+<li><p><strong>filter_allow_partial</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to allow partial results.
+Defaults to false.</p></li>
+<li><p><strong>page_limit</strong> (<em>int</em><em>, </em><em>optional</em>) – Maximum number of results to return.</p></li>
+</ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_all_tags_response.MetricAllTagsResponse" title="datadog_api_client.v2.model.metric_all_tags_response.MetricAllTagsResponse">MetricAllTagsResponse</a></p>

datadog_api_client.v2.model.html

@@ -71421,11 +71421,11 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dt class="sig sig-object py">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MetricAllTags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
-<p>Object for a single metric’s indexed tags.</p>
+<p>Object for a single metric’s indexed and ingested tags.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>attributes</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_all_tags_attributes.MetricAllTagsAttributes" title="datadog_api_client.v2.model.metric_all_tags_attributes.MetricAllTagsAttributes"><em>MetricAllTagsAttributes</em></a><em>, </em><em>optional</em>) – Object containing the definition of a metric’s tags.</p></li>
+<li><p><strong>attributes</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_all_tags_attributes.MetricAllTagsAttributes" title="datadog_api_client.v2.model.metric_all_tags_attributes.MetricAllTagsAttributes"><em>MetricAllTagsAttributes</em></a><em>, </em><em>optional</em>) – Object containing the definition of a metric’s indexed and ingested tags.</p></li>
 <li><p><strong>id</strong> (<em>str</em><em>, </em><em>optional</em>) – The metric name for this resource.</p></li>
 <li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_type.MetricType" title="datadog_api_client.v2.model.metric_type.MetricType"><em>MetricType</em></a><em>, </em><em>optional</em>) – The metric resource type.</p></li>
 </ul>
@@ -71443,10 +71443,13 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dt class="sig sig-object py">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MetricAllTagsAttributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
-<p>Object containing the definition of a metric’s tags.</p>
+<p>Object containing the definition of a metric’s indexed and ingested tags.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>tags</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of indexed tag value pairs.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>ingested_tags</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of ingested tags that are not indexed.</p></li>
+<li><p><strong>tags</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of indexed tags.</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>
@@ -71461,10 +71464,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dt class="sig sig-object py">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MetricAllTagsResponse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
-<p>Response object that includes a single metric’s indexed tags.</p>
+<p>Response object that includes a single metric’s indexed and ingested tags.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_all_tags.MetricAllTags" title="datadog_api_client.v2.model.metric_all_tags.MetricAllTags"><em>MetricAllTags</em></a><em>, </em><em>optional</em>) – Object for a single metric’s indexed tags.</p>
+<dd class="field-odd"><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_all_tags.MetricAllTags" title="datadog_api_client.v2.model.metric_all_tags.MetricAllTags"><em>MetricAllTags</em></a><em>, </em><em>optional</em>) – Object for a single metric’s indexed and ingested tags.</p>
 </dd>
 </dl>
 </dd></dl>