@datadog/datadog-api-client 1.2.0 → 1.4.0

package/dist/packages/datadog-api-client-v2/apis/MetricsApi.d.ts

@@ -10,6 +10,7 @@ import { MetricContentEncoding } from "../models/MetricContentEncoding";
 import { MetricEstimateResponse } from "../models/MetricEstimateResponse";
 import { MetricPayload } from "../models/MetricPayload";
 import { MetricsAndMetricTagConfigurationsResponse } from "../models/MetricsAndMetricTagConfigurationsResponse";
+import { MetricSuggestedTagsAndAggregationsResponse } from "../models/MetricSuggestedTagsAndAggregationsResponse";
 import { MetricTagConfigurationCreateRequest } from "../models/MetricTagConfigurationCreateRequest";
 import { MetricTagConfigurationMetricTypes } from "../models/MetricTagConfigurationMetricTypes";
 import { MetricTagConfigurationResponse } from "../models/MetricTagConfigurationResponse";
@@ -21,8 +22,9 @@ export declare class MetricsApiRequestFactory extends BaseAPIRequestFactory {
     deleteBulkTagsMetricsConfiguration(body: MetricBulkTagConfigDeleteRequest, _options?: Configuration): Promise<RequestContext>;
     deleteTagConfiguration(metricName: string, _options?: Configuration): Promise<RequestContext>;
     estimateMetricsOutputSeries(metricName: string, filterGroups?: string, filterHoursAgo?: number, filterNumAggregations?: number, filterPct?: boolean, filterTimespanH?: number, _options?: Configuration): Promise<RequestContext>;
+    listActiveMetricConfigurations(metricName: string, windowSeconds?: number, _options?: Configuration): Promise<RequestContext>;
     listTagConfigurationByName(metricName: string, _options?: Configuration): Promise<RequestContext>;
-    listTagConfigurations(filterConfigured?: boolean, filterTagsConfigured?: string, filterMetricType?: MetricTagConfigurationMetricTypes, filterIncludePercentiles?: boolean, filterTags?: string, windowSeconds?: number, _options?: Configuration): Promise<RequestContext>;
+    listTagConfigurations(filterConfigured?: boolean, filterTagsConfigured?: string, filterMetricType?: MetricTagConfigurationMetricTypes, filterIncludePercentiles?: boolean, filterQueried?: boolean, filterTags?: string, windowSeconds?: number, _options?: Configuration): Promise<RequestContext>;
     listTagsByMetricName(metricName: string, _options?: Configuration): Promise<RequestContext>;
     listVolumesByMetricName(metricName: string, _options?: Configuration): Promise<RequestContext>;
     submitMetrics(body: MetricPayload, contentEncoding?: MetricContentEncoding, _options?: Configuration): Promise<RequestContext>;
@@ -69,6 +71,14 @@ export declare class MetricsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     estimateMetricsOutputSeries(response: ResponseContext): Promise<MetricEstimateResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to listActiveMetricConfigurations
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listActiveMetricConfigurations(response: ResponseContext): Promise<MetricSuggestedTagsAndAggregationsResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -180,6 +190,19 @@ export interface MetricsApiEstimateMetricsOutputSeriesRequest {
      */
     filterTimespanH?: number;
 }
+export interface MetricsApiListActiveMetricConfigurationsRequest {
+    /**
+     * The name of the metric.
+     * @type string
+     */
+    metricName: string;
+    /**
+     * The number of seconds of look back (from now).
+     * Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month).
+     * @type number
+     */
+    windowSeconds?: number;
+}
 export interface MetricsApiListTagConfigurationByNameRequest {
     /**
      * The name of the metric.
@@ -189,7 +212,7 @@ export interface MetricsApiListTagConfigurationByNameRequest {
 }
 export interface MetricsApiListTagConfigurationsRequest {
     /**
-     * Filter metrics that have configured tags.
+     * Filter custom metrics that have configured tags.
      * @type boolean
      */
     filterConfigured?: boolean;
@@ -199,7 +222,7 @@ export interface MetricsApiListTagConfigurationsRequest {
      */
     filterTagsConfigured?: string;
     /**
-     * Filter tag configurations by metric type.
+     * Filter metrics by metric type.
      * @type MetricTagConfigurationMetricTypes
      */
     filterMetricType?: MetricTagConfigurationMetricTypes;
@@ -209,15 +232,21 @@ export interface MetricsApiListTagConfigurationsRequest {
      * @type boolean
      */
     filterIncludePercentiles?: boolean;
+    /**
+     * Filter custom metrics that have or have not been queried in the specified window[seconds].
+     * If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
+     * @type boolean
+     */
+    filterQueried?: boolean;
     /**
      * Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
-     * Cannot be combined with other filters.
+     * Can only be combined with the filter[queried] filter.
      * @type string
      */
     filterTags?: string;
     /**
-     * The number of seconds of look back (from now) to apply to a filter[tag] query.
-     * Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days).
+     * The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.
+     * Defaults value is 3600 (1 hour), maximum value is 1,209,600 (2 weeks).
      * @type number
      */
     windowSeconds?: number;
@@ -300,14 +329,18 @@ export declare class MetricsApi {
      * @param param The request object
      */
     estimateMetricsOutputSeries(param: MetricsApiEstimateMetricsOutputSeriesRequest, options?: Configuration): Promise<MetricEstimateResponse>;
+    /**
+     * List tags and aggregations that are actively queried on dashboards and monitors for a given metric name.
+     * @param param The request object
+     */
+    listActiveMetricConfigurations(param: MetricsApiListActiveMetricConfigurationsRequest, options?: Configuration): Promise<MetricSuggestedTagsAndAggregationsResponse>;
     /**
      * Returns the tag configuration for the given metric name.
      * @param param The request object
      */
     listTagConfigurationByName(param: MetricsApiListTagConfigurationByNameRequest, options?: Configuration): Promise<MetricTagConfigurationResponse>;
     /**
-     * Returns all configured count/gauge/rate/distribution metric names
-     * (with additional filters if specified).
+     * Returns all metrics (matching additional filters if specified).
      * @param param The request object
      */
     listTagConfigurations(param?: MetricsApiListTagConfigurationsRequest, options?: Configuration): Promise<MetricsAndMetricTagConfigurationsResponse>;