Skip to content

Commit 2561359

Browse files
Update v2 metrics list endpoint filter by metric type to use metric type category (#2179)
Co-authored-by: ci.datadog-api-spec <[email protected]> 9ff6445
1 parent 345a411 commit 2561359

9 files changed

+70
-9
lines changed

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6248,6 +6248,13 @@ datadog\_api\_client.v2.model.metric\_tag\_configuration\_create\_request module
62486248
:members:
62496249
:show-inheritance:
62506250

6251+
datadog\_api\_client.v2.model.metric\_tag\_configuration\_metric\_type\_category module
6252+
---------------------------------------------------------------------------------------
6253+
6254+
.. automodule:: datadog_api_client.v2.model.metric_tag_configuration_metric_type_category
6255+
:members:
6256+
:show-inheritance:
6257+
62516258
datadog\_api\_client.v2.model.metric\_tag\_configuration\_metric\_types module
62526259
------------------------------------------------------------------------------
62536260

datadog_api_client.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3146,6 +3146,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
31463146
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_create_attributes">datadog_api_client.v2.model.metric_tag_configuration_create_attributes module</a></li>
31473147
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_create_data">datadog_api_client.v2.model.metric_tag_configuration_create_data module</a></li>
31483148
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_create_request">datadog_api_client.v2.model.metric_tag_configuration_create_request module</a></li>
3149+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_metric_type_category">datadog_api_client.v2.model.metric_tag_configuration_metric_type_category module</a></li>
31493150
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_metric_types">datadog_api_client.v2.model.metric_tag_configuration_metric_types module</a></li>
31503151
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_response">datadog_api_client.v2.model.metric_tag_configuration_response module</a></li>
31513152
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_type">datadog_api_client.v2.model.metric_tag_configuration_type module</a></li>

datadog_api_client.v2.api.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5426,15 +5426,15 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
54265426
</dd></dl>
54275427
<dl class="py method">
54285428
<dt class="sig sig-object py" id="datadog_api_client.v2.api.metrics_api.MetricsApi.list_tag_configurations">
5429-
<span class="sig-name descname"><span class="pre">list_tag_configurations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_configured</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_tags_configured</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_metric_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_metric_types.MetricTagConfigurationMetricTypes" title="datadog_api_client.v2.model.metric_tag_configuration_metric_types.MetricTagConfigurationMetricTypes"><span class="pre">MetricTagConfigurationMetricTypes</span></a><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_percentiles</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_queried</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_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">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><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.metrics_and_metric_tag_configurations_response.MetricsAndMetricTagConfigurationsResponse" title="datadog_api_client.v2.model.metrics_and_metric_tag_configurations_response.MetricsAndMetricTagConfigurationsResponse"><span class="pre">MetricsAndMetricTagConfigurationsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.metrics_api.MetricsApi.list_tag_configurations" title="Link to this definition">¶</a></dt>
5429+
<span class="sig-name descname"><span class="pre">list_tag_configurations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_configured</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_tags_configured</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_metric_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_metric_type_category.MetricTagConfigurationMetricTypeCategory" title="datadog_api_client.v2.model.metric_tag_configuration_metric_type_category.MetricTagConfigurationMetricTypeCategory"><span class="pre">MetricTagConfigurationMetricTypeCategory</span></a><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_percentiles</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_queried</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_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">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><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.metrics_and_metric_tag_configurations_response.MetricsAndMetricTagConfigurationsResponse" title="datadog_api_client.v2.model.metrics_and_metric_tag_configurations_response.MetricsAndMetricTagConfigurationsResponse"><span class="pre">MetricsAndMetricTagConfigurationsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.metrics_api.MetricsApi.list_tag_configurations" title="Link to this definition">¶</a></dt>
54305430
<dd><p>Get a list of metrics.</p>
54315431
<p>Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).</p>
54325432
<dl class="field-list simple">
54335433
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
54345434
<dd class="field-odd"><ul class="simple">
54355435
<li><p><strong>filter_configured</strong> (<em>bool</em><em>, </em><em>optional</em>) – Filter custom metrics that have configured tags.</p></li>
54365436
<li><p><strong>filter_tags_configured</strong> (<em>str</em><em>, </em><em>optional</em>) – Filter tag configurations by configured tags.</p></li>
5437-
<li><p><strong>filter_metric_type</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_metric_types.MetricTagConfigurationMetricTypes" title="datadog_api_client.v2.model.metric_tag_configuration_metric_types.MetricTagConfigurationMetricTypes"><em>MetricTagConfigurationMetricTypes</em></a><em>, </em><em>optional</em>) – Filter metrics by metric type.</p></li>
5437+
<li><p><strong>filter_metric_type</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_metric_type_category.MetricTagConfigurationMetricTypeCategory" title="datadog_api_client.v2.model.metric_tag_configuration_metric_type_category.MetricTagConfigurationMetricTypeCategory"><em>MetricTagConfigurationMetricTypeCategory</em></a><em>, </em><em>optional</em>) – Filter metrics by metric type.</p></li>
54385438
<li><p><strong>filter_include_percentiles</strong> (<em>bool</em><em>, </em><em>optional</em>) – Filter distributions with additional percentile
54395439
aggregations enabled or disabled.</p></li>
54405440
<li><p><strong>filter_queried</strong> (<em>bool</em><em>, </em><em>optional</em>) – (Beta) Filter custom metrics that have or have not been queried in the specified window[seconds].

datadog_api_client.v2.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5218,6 +5218,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
52185218
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_create_request.MetricTagConfigurationCreateRequest"><code class="docutils literal notranslate"><span class="pre">MetricTagConfigurationCreateRequest</span></code></a></li>
52195219
</ul>
52205220
</li>
5221+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_metric_type_category">datadog_api_client.v2.model.metric_tag_configuration_metric_type_category module</a><ul>
5222+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_metric_type_category.MetricTagConfigurationMetricTypeCategory"><code class="docutils literal notranslate"><span class="pre">MetricTagConfigurationMetricTypeCategory</span></code></a></li>
5223+
</ul>
5224+
</li>
52215225
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.metric_tag_configuration_metric_types">datadog_api_client.v2.model.metric_tag_configuration_metric_types module</a><ul>
52225226
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_metric_types.MetricTagConfigurationMetricTypes"><code class="docutils literal notranslate"><span class="pre">MetricTagConfigurationMetricTypes</span></code></a></li>
52235227
</ul>

0 commit comments

Comments
 (0)