Skip to content

Commit

Permalink
Standardize docs references to timeseries (#1858)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> 2df0430
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec committed Feb 6, 2024
1 parent 86eedf9 commit 5fb633b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions datadog_api_client.v1.model.html
Original file line number Diff line number Diff line change
Expand Up @@ -17436,7 +17436,7 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<p>The metrics’ payload.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>series</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.series.Series" title="datadog_api_client.v1.model.series.Series"><em>Series</em></a><em>]</em>) – A list of time series to submit to Datadog.</p>
<dd class="field-odd"><p><strong>series</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.series.Series" title="datadog_api_client.v1.model.series.Series"><em>Series</em></a><em>]</em>) – A list of timeseries to submit to Datadog.</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -17458,7 +17458,7 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<li><p><strong>interval</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of milliseconds between data samples.</p></li>
<li><p><strong>length</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of data samples.</p></li>
<li><p><strong>metric</strong> (<em>str</em><em>, </em><em>optional</em>) – Metric name.</p></li>
<li><p><strong>pointlist</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.point.Point" title="datadog_api_client.v1.model.point.Point"><em>Point</em></a><em>]</em><em>, </em><em>optional</em>) – List of points of the time series in milliseconds.</p></li>
<li><p><strong>pointlist</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.point.Point" title="datadog_api_client.v1.model.point.Point"><em>Point</em></a><em>]</em><em>, </em><em>optional</em>) – List of points of the timeseries in milliseconds.</p></li>
<li><p><strong>query_index</strong> (<em>int</em><em>, </em><em>optional</em>) – The index of the series’ query within the request.</p></li>
<li><p><strong>scope</strong> (<em>str</em><em>, </em><em>optional</em>) – Metric scope, comma separated list of tags.</p></li>
<li><p><strong>start</strong> (<em>int</em><em>, </em><em>optional</em>) – Start of the time window, milliseconds since Unix epoch.</p></li>
Expand Down Expand Up @@ -21846,11 +21846,11 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<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>denominator</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries" title="datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries"><em>SLOHistoryMetricsSeries</em></a>) – A representation of <code class="docutils literal notranslate"><span class="pre">metric</span></code> based SLO time series for the provided queries.
<li><p><strong>denominator</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries" title="datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries"><em>SLOHistoryMetricsSeries</em></a>) – A representation of <code class="docutils literal notranslate"><span class="pre">metric</span></code> based SLO timeseries for the provided queries.
This is the same response type from <code class="docutils literal notranslate"><span class="pre">batch_query</span></code> endpoint.</p></li>
<li><p><strong>interval</strong> (<em>int</em>) – The aggregated query interval for the series data. It’s implicit based on the query time window.</p></li>
<li><p><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Optional message if there are specific query issues/warnings.</p></li>
<li><p><strong>numerator</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries" title="datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries"><em>SLOHistoryMetricsSeries</em></a>) – A representation of <code class="docutils literal notranslate"><span class="pre">metric</span></code> based SLO time series for the provided queries.
<li><p><strong>numerator</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries" title="datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries"><em>SLOHistoryMetricsSeries</em></a>) – A representation of <code class="docutils literal notranslate"><span class="pre">metric</span></code> based SLO timeseries for the provided queries.
This is the same response type from <code class="docutils literal notranslate"><span class="pre">batch_query</span></code> endpoint.</p></li>
<li><p><strong>query</strong> (<em>str</em>) – The combined numerator and denominator query CSV.</p></li>
<li><p><strong>res_type</strong> (<em>str</em>) – The series result type. This mimics <code class="docutils literal notranslate"><span class="pre">batch_query</span></code> response type.</p></li>
Expand All @@ -21867,7 +21867,7 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<dt class="sig sig-object py" id="datadog_api_client.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SLOHistoryMetricsSeries</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.v1.model.slo_history_metrics_series.SLOHistoryMetricsSeries" title="Link to this definition">¶</a></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>A representation of <code class="docutils literal notranslate"><span class="pre">metric</span></code> based SLO time series for the provided queries.
<p>A representation of <code class="docutils literal notranslate"><span class="pre">metric</span></code> based SLO timeseries for the provided queries.
This is the same response type from <code class="docutils literal notranslate"><span class="pre">batch_query</span></code> endpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down Expand Up @@ -21939,7 +21939,7 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<li><p><strong>error_budget_remaining</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.slo_error_budget_remaining_data.SLOErrorBudgetRemainingData" title="datadog_api_client.v1.model.slo_error_budget_remaining_data.SLOErrorBudgetRemainingData"><em>SLOErrorBudgetRemainingData</em></a><em>, </em><em>optional</em>) – A mapping of threshold <code class="docutils literal notranslate"><span class="pre">timeframe</span></code> to the remaining error budget.</p></li>
<li><p><strong>errors</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.slo_history_response_error_with_type.SLOHistoryResponseErrorWithType" title="datadog_api_client.v1.model.slo_history_response_error_with_type.SLOHistoryResponseErrorWithType"><em>SLOHistoryResponseErrorWithType</em></a><em>]</em><em>, </em><em>optional</em>) – An array of error objects returned while querying the history data for the service level objective.</p></li>
<li><p><strong>group</strong> (<em>str</em><em>, </em><em>optional</em>) – For groups in a grouped SLO, this is the group name.</p></li>
<li><p><strong>history</strong> (<em>[</em><em>[</em><em>float</em><em>]</em><em>]</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this includes the aggregated history as arrays that include time series and uptime data where <code class="docutils literal notranslate"><span class="pre">0=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">OK</span></code> state and <code class="docutils literal notranslate"><span class="pre">1=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">alert</span></code> state.</p></li>
<li><p><strong>history</strong> (<em>[</em><em>[</em><em>float</em><em>]</em><em>]</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this includes the aggregated history as arrays that include timeseries and uptime data where <code class="docutils literal notranslate"><span class="pre">0=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">OK</span></code> state and <code class="docutils literal notranslate"><span class="pre">1=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">alert</span></code> state.</p></li>
<li><p><strong>monitor_modified</strong> (<em>int</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this is the last modified timestamp in epoch seconds of the monitor.</p></li>
<li><p><strong>monitor_type</strong> (<em>str</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this describes the type of monitor.</p></li>
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.</p></li>
Expand Down Expand Up @@ -22052,7 +22052,7 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<li><p><strong>error_budget_remaining</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.slo_error_budget_remaining_data.SLOErrorBudgetRemainingData" title="datadog_api_client.v1.model.slo_error_budget_remaining_data.SLOErrorBudgetRemainingData"><em>SLOErrorBudgetRemainingData</em></a><em>, </em><em>optional</em>) – A mapping of threshold <code class="docutils literal notranslate"><span class="pre">timeframe</span></code> to the remaining error budget.</p></li>
<li><p><strong>errors</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.slo_history_response_error_with_type.SLOHistoryResponseErrorWithType" title="datadog_api_client.v1.model.slo_history_response_error_with_type.SLOHistoryResponseErrorWithType"><em>SLOHistoryResponseErrorWithType</em></a><em>]</em><em>, </em><em>optional</em>) – An array of error objects returned while querying the history data for the service level objective.</p></li>
<li><p><strong>group</strong> (<em>str</em><em>, </em><em>optional</em>) – For groups in a grouped SLO, this is the group name.</p></li>
<li><p><strong>history</strong> (<em>[</em><em>[</em><em>float</em><em>]</em><em>]</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this includes the aggregated history as arrays that include time series and uptime data where <code class="docutils literal notranslate"><span class="pre">0=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">OK</span></code> state and <code class="docutils literal notranslate"><span class="pre">1=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">alert</span></code> state.</p></li>
<li><p><strong>history</strong> (<em>[</em><em>[</em><em>float</em><em>]</em><em>]</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this includes the aggregated history as arrays that include timeseries and uptime data where <code class="docutils literal notranslate"><span class="pre">0=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">OK</span></code> state and <code class="docutils literal notranslate"><span class="pre">1=monitor</span></code> is in <code class="docutils literal notranslate"><span class="pre">alert</span></code> state.</p></li>
<li><p><strong>monitor_modified</strong> (<em>int</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this is the last modified timestamp in epoch seconds of the monitor.</p></li>
<li><p><strong>monitor_type</strong> (<em>str</em><em>, </em><em>optional</em>) – For <code class="docutils literal notranslate"><span class="pre">monitor</span></code> based SLOs, this describes the type of monitor.</p></li>
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.</p></li>
Expand Down
2 changes: 1 addition & 1 deletion datadog_api_client.v2.model.html
Original file line number Diff line number Diff line change
Expand Up @@ -30412,7 +30412,7 @@ <h1 id="datadog-api-client-v2-model--page-root">datadog_api_client.v2.model<a cl
<p>The metrics’ payload.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>series</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.metric_series.MetricSeries" title="datadog_api_client.v2.model.metric_series.MetricSeries"><em>MetricSeries</em></a><em>]</em>) – A list of time series to submit to Datadog.</p>
<dd class="field-odd"><p><strong>series</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.metric_series.MetricSeries" title="datadog_api_client.v2.model.metric_series.MetricSeries"><em>MetricSeries</em></a><em>]</em>) – A list of timeseries to submit to Datadog.</p>
</dd>
</dl>
</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 5fb633b

Please sign in to comment.