Skip to content

Commit 5670b8a

Browse files
Update Metrics Query descriptions and scopes (#1540)
Co-authored-by: ci.datadog-api-spec <[email protected]> 8788749
1 parent 5fb78be commit 5670b8a

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

datadog_api_client.v2.api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4803,7 +4803,7 @@ <h1 id="datadog-api-client-v2-api--page-root">datadog_api_client.v2.api<a class=
48034803
<dt class="sig sig-object py" id="datadog_api_client.v2.api.metrics_api.MetricsApi.query_scalar_data">
48044804
<span class="sig-name descname"><span class="pre">query_scalar_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</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.scalar_formula_query_request.ScalarFormulaQueryRequest" title="datadog_api_client.v2.model.scalar_formula_query_request.ScalarFormulaQueryRequest"><span class="pre">ScalarFormulaQueryRequest</span></a></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.scalar_formula_query_response.ScalarFormulaQueryResponse" title="datadog_api_client.v2.model.scalar_formula_query_response.ScalarFormulaQueryResponse"><span class="pre">ScalarFormulaQueryResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.metrics_api.MetricsApi.query_scalar_data" title="Permalink to this definition">¶</a></dt>
48054805
<dd><p>Query scalar data across multiple products.</p>
4806-
<p>Query scalar values (as seen on Query Value, Table and Toplist widgets).
4806+
<p>Query scalar values (as seen on Query Value, Table, and Toplist widgets).
48074807
Multiple data sources are supported with the ability to
48084808
process the data using formulas and functions.</p>
48094809
<dl class="field-list simple">

datadog_api_client.v2.model.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17072,7 +17072,7 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
1707217072
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
1707317073
<dd class="field-odd"><ul class="simple">
1707417074
<li><p><strong>aggregation</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.events_aggregation.EventsAggregation" title="datadog_api_client.v2.model.events_aggregation.EventsAggregation"><em>EventsAggregation</em></a>) – The type of aggregation that can be performed on events-based queries.</p></li>
17075-
<li><p><strong>metric</strong> (<em>str</em><em>, </em><em>optional</em>) – Metric whose calculated value should be used to define the sort order of a query’s results.</p></li>
17075+
<li><p><strong>metric</strong> (<em>str</em><em>, </em><em>optional</em>) – The metric’s calculated value which should be used to define the sort order of a query’s results.</p></li>
1707617076
<li><p><strong>order</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.query_sort_order.QuerySortOrder" title="datadog_api_client.v2.model.query_sort_order.QuerySortOrder"><em>QuerySortOrder</em></a><em>, </em><em>optional</em>) – Direction of sort.</p></li>
1707717077
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.events_sort_type.EventsSortType" title="datadog_api_client.v2.model.events_sort_type.EventsSortType"><em>EventsSortType</em></a><em>, </em><em>optional</em>) – The type of sort to use on the calculated value.</p></li>
1707817078
</ul>
@@ -23722,7 +23722,7 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
2372223722
<dt class="sig sig-object py" id="datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator">
2372323723
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MetricsAggregator</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><a class="headerlink" href="#datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator" title="Permalink to this definition">¶</a></dt>
2372423724
<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelSimple" title="datadog_api_client.model_utils.ModelSimple"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSimple</span></code></a></p>
23725-
<p>The type of aggregation that can be performed on metrics queries.</p>
23725+
<p>The type of aggregation that can be performed on metrics-based queries.</p>
2372623726
<dl class="field-list simple">
2372723727
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2372823728
<dd class="field-odd"><ul class="simple">
@@ -23812,7 +23812,7 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
2381223812
<dl class="field-list simple">
2381323813
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2381423814
<dd class="field-odd"><ul class="simple">
23815-
<li><p><strong>aggregator</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator" title="datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator"><em>MetricsAggregator</em></a>) – The type of aggregation that can be performed on metrics queries.</p></li>
23815+
<li><p><strong>aggregator</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator" title="datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator"><em>MetricsAggregator</em></a>) – The type of aggregation that can be performed on metrics-based queries.</p></li>
2381623816
<li><p><strong>data_source</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metrics_data_source.MetricsDataSource" title="datadog_api_client.v2.model.metrics_data_source.MetricsDataSource"><em>MetricsDataSource</em></a>) – A data source that is powered by the Metrics platform.</p></li>
2381723817
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The variable name for use in formulas.</p></li>
2381823818
<li><p><strong>query</strong> (<em>str</em>) – A classic metrics query string.</p></li>
@@ -27087,7 +27087,7 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
2708727087
<dl class="field-list simple">
2708827088
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2708927089
<dd class="field-odd"><ul class="simple">
27090-
<li><p><strong>aggregator</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator" title="datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator"><em>MetricsAggregator</em></a>) – The type of aggregation that can be performed on metrics queries.</p></li>
27090+
<li><p><strong>aggregator</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator" title="datadog_api_client.v2.model.metrics_aggregator.MetricsAggregator"><em>MetricsAggregator</em></a>) – The type of aggregation that can be performed on metrics-based queries.</p></li>
2709127091
<li><p><strong>data_source</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metrics_data_source.MetricsDataSource" title="datadog_api_client.v2.model.metrics_data_source.MetricsDataSource"><em>MetricsDataSource</em></a>) – A data source that is powered by the Metrics platform.</p></li>
2709227092
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The variable name for use in formulas.</p></li>
2709327093
<li><p><strong>query</strong> (<em>str</em>) – A classic metrics query string.</p></li>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)