com.datadog.api.client.v2.api

Class MetricsApi

java.lang.Object

com.datadog.api.client.v2.api.MetricsApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class MetricsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricsApi.EstimateMetricsOutputSeriesOptionalParameters Manage optional parameters to estimateMetricsOutputSeries.
static class	MetricsApi.ListActiveMetricConfigurationsOptionalParameters Manage optional parameters to listActiveMetricConfigurations.
static class	MetricsApi.ListTagConfigurationsOptionalParameters Manage optional parameters to listTagConfigurations.
static class	MetricsApi.SubmitMetricsOptionalParameters Manage optional parameters to submitMetrics.

Constructor Summary

Constructors

Constructor and Description
MetricsApi()
MetricsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
MetricBulkTagConfigResponse	createBulkTagsMetricsConfiguration(MetricBulkTagConfigCreateRequest body) Configure tags for multiple metrics.
CompletableFuture<MetricBulkTagConfigResponse>	createBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigCreateRequest body) Configure tags for multiple metrics.
ApiResponse<MetricBulkTagConfigResponse>	createBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigCreateRequest body) Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>>	createBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigCreateRequest body) Configure tags for multiple metrics.
MetricTagConfigurationResponse	createTagConfiguration(String metricName, MetricTagConfigurationCreateRequest body) Create a tag configuration.
CompletableFuture<MetricTagConfigurationResponse>	createTagConfigurationAsync(String metricName, MetricTagConfigurationCreateRequest body) Create a tag configuration.
ApiResponse<MetricTagConfigurationResponse>	createTagConfigurationWithHttpInfo(String metricName, MetricTagConfigurationCreateRequest body) Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>	createTagConfigurationWithHttpInfoAsync(String metricName, MetricTagConfigurationCreateRequest body) Create a tag configuration.
MetricBulkTagConfigResponse	deleteBulkTagsMetricsConfiguration(MetricBulkTagConfigDeleteRequest body) Configure tags for multiple metrics.
CompletableFuture<MetricBulkTagConfigResponse>	deleteBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigDeleteRequest body) Configure tags for multiple metrics.
ApiResponse<MetricBulkTagConfigResponse>	deleteBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigDeleteRequest body) Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>>	deleteBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigDeleteRequest body) Configure tags for multiple metrics.
void	deleteTagConfiguration(String metricName) Delete a tag configuration.
CompletableFuture<Void>	deleteTagConfigurationAsync(String metricName) Delete a tag configuration.
ApiResponse<Void>	deleteTagConfigurationWithHttpInfo(String metricName) Deletes a metric's tag configuration.
CompletableFuture<ApiResponse<Void>>	deleteTagConfigurationWithHttpInfoAsync(String metricName) Delete a tag configuration.
MetricEstimateResponse	estimateMetricsOutputSeries(String metricName) Tag Configuration Cardinality Estimator.
MetricEstimateResponse	estimateMetricsOutputSeries(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Tag Configuration Cardinality Estimator.
CompletableFuture<MetricEstimateResponse>	estimateMetricsOutputSeriesAsync(String metricName) Tag Configuration Cardinality Estimator.
CompletableFuture<MetricEstimateResponse>	estimateMetricsOutputSeriesAsync(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Tag Configuration Cardinality Estimator.
ApiResponse<MetricEstimateResponse>	estimateMetricsOutputSeriesWithHttpInfo(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™.
CompletableFuture<ApiResponse<MetricEstimateResponse>>	estimateMetricsOutputSeriesWithHttpInfoAsync(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Tag Configuration Cardinality Estimator.
ApiClient	getApiClient() Get the API client.
MetricSuggestedTagsAndAggregationsResponse	listActiveMetricConfigurations(String metricName) List active tags and aggregations.
MetricSuggestedTagsAndAggregationsResponse	listActiveMetricConfigurations(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List active tags and aggregations.
CompletableFuture<MetricSuggestedTagsAndAggregationsResponse>	listActiveMetricConfigurationsAsync(String metricName) List active tags and aggregations.
CompletableFuture<MetricSuggestedTagsAndAggregationsResponse>	listActiveMetricConfigurationsAsync(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List active tags and aggregations.
ApiResponse<MetricSuggestedTagsAndAggregationsResponse>	listActiveMetricConfigurationsWithHttpInfo(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List tags and aggregations that are actively queried on dashboards and monitors for a given metric name.
CompletableFuture<ApiResponse<MetricSuggestedTagsAndAggregationsResponse>>	listActiveMetricConfigurationsWithHttpInfoAsync(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List active tags and aggregations.
MetricTagConfigurationResponse	listTagConfigurationByName(String metricName) List tag configuration by name.
CompletableFuture<MetricTagConfigurationResponse>	listTagConfigurationByNameAsync(String metricName) List tag configuration by name.
ApiResponse<MetricTagConfigurationResponse>	listTagConfigurationByNameWithHttpInfo(String metricName) Returns the tag configuration for the given metric name.
CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>	listTagConfigurationByNameWithHttpInfoAsync(String metricName) List tag configuration by name.
MetricsAndMetricTagConfigurationsResponse	listTagConfigurations() Get a list of metrics.
MetricsAndMetricTagConfigurationsResponse	listTagConfigurations(MetricsApi.ListTagConfigurationsOptionalParameters parameters) Get a list of metrics.
CompletableFuture<MetricsAndMetricTagConfigurationsResponse>	listTagConfigurationsAsync() Get a list of metrics.
CompletableFuture<MetricsAndMetricTagConfigurationsResponse>	listTagConfigurationsAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters) Get a list of metrics.
ApiResponse<MetricsAndMetricTagConfigurationsResponse>	listTagConfigurationsWithHttpInfo(MetricsApi.ListTagConfigurationsOptionalParameters parameters) Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).
CompletableFuture<ApiResponse<MetricsAndMetricTagConfigurationsResponse>>	listTagConfigurationsWithHttpInfoAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters) Get a list of metrics.
MetricAllTagsResponse	listTagsByMetricName(String metricName) List tags by metric name.
CompletableFuture<MetricAllTagsResponse>	listTagsByMetricNameAsync(String metricName) List tags by metric name.
ApiResponse<MetricAllTagsResponse>	listTagsByMetricNameWithHttpInfo(String metricName) View indexed tag key-value pairs for a given metric name.
CompletableFuture<ApiResponse<MetricAllTagsResponse>>	listTagsByMetricNameWithHttpInfoAsync(String metricName) List tags by metric name.
MetricVolumesResponse	listVolumesByMetricName(String metricName) List distinct metric volumes by metric name.
CompletableFuture<MetricVolumesResponse>	listVolumesByMetricNameAsync(String metricName) List distinct metric volumes by metric name.
ApiResponse<MetricVolumesResponse>	listVolumesByMetricNameWithHttpInfo(String metricName) View distinct metrics volumes for the given metric name.
CompletableFuture<ApiResponse<MetricVolumesResponse>>	listVolumesByMetricNameWithHttpInfoAsync(String metricName) List distinct metric volumes by metric name.
ScalarFormulaQueryResponse	queryScalarData(ScalarFormulaQueryRequest body) Query scalar data across multiple products.
CompletableFuture<ScalarFormulaQueryResponse>	queryScalarDataAsync(ScalarFormulaQueryRequest body) Query scalar data across multiple products.
ApiResponse<ScalarFormulaQueryResponse>	queryScalarDataWithHttpInfo(ScalarFormulaQueryRequest body) Query scalar values (as seen on Query Value, Table and Toplist widgets).
CompletableFuture<ApiResponse<ScalarFormulaQueryResponse>>	queryScalarDataWithHttpInfoAsync(ScalarFormulaQueryRequest body) Query scalar data across multiple products.
TimeseriesFormulaQueryResponse	queryTimeseriesData(TimeseriesFormulaQueryRequest body) Query timeseries data across multiple products.
CompletableFuture<TimeseriesFormulaQueryResponse>	queryTimeseriesDataAsync(TimeseriesFormulaQueryRequest body) Query timeseries data across multiple products.
ApiResponse<TimeseriesFormulaQueryResponse>	queryTimeseriesDataWithHttpInfo(TimeseriesFormulaQueryRequest body) Query timeseries data across various data sources and process the data by applying formulas and functions.
CompletableFuture<ApiResponse<TimeseriesFormulaQueryResponse>>	queryTimeseriesDataWithHttpInfoAsync(TimeseriesFormulaQueryRequest body) Query timeseries data across multiple products.
void	setApiClient(ApiClient apiClient) Set the API client.
IntakePayloadAccepted	submitMetrics(MetricPayload body) Submit metrics.
IntakePayloadAccepted	submitMetrics(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.
CompletableFuture<IntakePayloadAccepted>	submitMetricsAsync(MetricPayload body) Submit metrics.
CompletableFuture<IntakePayloadAccepted>	submitMetricsAsync(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.
ApiResponse<IntakePayloadAccepted>	submitMetricsWithHttpInfo(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.
CompletableFuture<ApiResponse<IntakePayloadAccepted>>	submitMetricsWithHttpInfoAsync(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.
MetricTagConfigurationResponse	updateTagConfiguration(String metricName, MetricTagConfigurationUpdateRequest body) Update a tag configuration.
CompletableFuture<MetricTagConfigurationResponse>	updateTagConfigurationAsync(String metricName, MetricTagConfigurationUpdateRequest body) Update a tag configuration.
ApiResponse<MetricTagConfigurationResponse>	updateTagConfigurationWithHttpInfo(String metricName, MetricTagConfigurationUpdateRequest body) Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations of a count, rate, or gauge metric.
CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>	updateTagConfigurationWithHttpInfoAsync(String metricName, MetricTagConfigurationUpdateRequest body) Update a tag configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsApi

public MetricsApi()

MetricsApi

public MetricsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createBulkTagsMetricsConfiguration

public MetricBulkTagConfigResponse createBulkTagsMetricsConfiguration(MetricBulkTagConfigCreateRequest body)
                                                               throws ApiException

Configure tags for multiple metrics.

See createBulkTagsMetricsConfigurationWithHttpInfo(com.datadog.api.client.v2.model.MetricBulkTagConfigCreateRequest).

Parameters:

body - (required)

Returns:

MetricBulkTagConfigResponse

Throws:

ApiException - if fails to make API call

createBulkTagsMetricsConfigurationAsync

public CompletableFuture<MetricBulkTagConfigResponse> createBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigCreateRequest body)

Configure tags for multiple metrics.

See createBulkTagsMetricsConfigurationWithHttpInfoAsync(com.datadog.api.client.v2.model.MetricBulkTagConfigCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<MetricBulkTagConfigResponse>

createBulkTagsMetricsConfigurationWithHttpInfo

public ApiResponse<MetricBulkTagConfigResponse> createBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigCreateRequest body)
                                                                                        throws ApiException

Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations. Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app. If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not expect deterministic ordering of concurrent calls. Can only be used with application keys of users with the Manage Tags for Metrics permission.

Parameters:

body - (required)

Returns:

ApiResponse<MetricBulkTagConfigResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

createBulkTagsMetricsConfigurationWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>> createBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigCreateRequest body)

Configure tags for multiple metrics.

See createBulkTagsMetricsConfigurationWithHttpInfo(com.datadog.api.client.v2.model.MetricBulkTagConfigCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>>

createTagConfiguration

public MetricTagConfigurationResponse createTagConfiguration(String metricName,
                                                             MetricTagConfigurationCreateRequest body)
                                                      throws ApiException

Create a tag configuration.

See createTagConfigurationWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.MetricTagConfigurationCreateRequest).

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

MetricTagConfigurationResponse

Throws:

ApiException - if fails to make API call

createTagConfigurationAsync

public CompletableFuture<MetricTagConfigurationResponse> createTagConfigurationAsync(String metricName,
                                                                                     MetricTagConfigurationCreateRequest body)

Create a tag configuration.

See createTagConfigurationWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.MetricTagConfigurationCreateRequest).

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

CompletableFuture<MetricTagConfigurationResponse>

createTagConfigurationWithHttpInfo

public ApiResponse<MetricTagConfigurationResponse> createTagConfigurationWithHttpInfo(String metricName,
                                                                                      MetricTagConfigurationCreateRequest body)
                                                                               throws ApiException

Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric or configure custom aggregations on any count, rate, or gauge metric. Can only be used with application keys of users with the Manage Tags for Metrics permission.

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

ApiResponse<MetricTagConfigurationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too Many Requests	-

createTagConfigurationWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricTagConfigurationResponse>> createTagConfigurationWithHttpInfoAsync(String metricName,
                                                                                                              MetricTagConfigurationCreateRequest body)

Create a tag configuration.

See createTagConfigurationWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.MetricTagConfigurationCreateRequest).

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>

deleteBulkTagsMetricsConfiguration

public MetricBulkTagConfigResponse deleteBulkTagsMetricsConfiguration(MetricBulkTagConfigDeleteRequest body)
                                                               throws ApiException

Configure tags for multiple metrics.

See deleteBulkTagsMetricsConfigurationWithHttpInfo(com.datadog.api.client.v2.model.MetricBulkTagConfigDeleteRequest).

Parameters:

body - (required)

Returns:

MetricBulkTagConfigResponse

Throws:

ApiException - if fails to make API call

deleteBulkTagsMetricsConfigurationAsync

public CompletableFuture<MetricBulkTagConfigResponse> deleteBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigDeleteRequest body)

Configure tags for multiple metrics.

See deleteBulkTagsMetricsConfigurationWithHttpInfoAsync(com.datadog.api.client.v2.model.MetricBulkTagConfigDeleteRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<MetricBulkTagConfigResponse>

deleteBulkTagsMetricsConfigurationWithHttpInfo

public ApiResponse<MetricBulkTagConfigResponse> deleteBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigDeleteRequest body)
                                                                                        throws ApiException

Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. Metrics are selected by passing a metric name prefix. Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app. Can only be used with application keys of users with the Manage Tags for Metrics permission.

Parameters:

body - (required)

Returns:

ApiResponse<MetricBulkTagConfigResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

deleteBulkTagsMetricsConfigurationWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>> deleteBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigDeleteRequest body)

Configure tags for multiple metrics.

See deleteBulkTagsMetricsConfigurationWithHttpInfo(com.datadog.api.client.v2.model.MetricBulkTagConfigDeleteRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>>

deleteTagConfiguration

public void deleteTagConfiguration(String metricName)
                            throws ApiException

Delete a tag configuration.

See deleteTagConfigurationWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Throws:

ApiException - if fails to make API call

deleteTagConfigurationAsync

public CompletableFuture<Void> deleteTagConfigurationAsync(String metricName)

Delete a tag configuration.

See deleteTagConfigurationWithHttpInfoAsync(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture

deleteTagConfigurationWithHttpInfo

public ApiResponse<Void> deleteTagConfigurationWithHttpInfo(String metricName)
                                                     throws ApiException

Deletes a metric's tag configuration. Can only be used with application keys from users with the Manage Tags for Metrics permission.

Parameters:

metricName - The name of the metric. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
403	Forbidden	-
404	Not found	-
429	Too Many Requests	-

deleteTagConfigurationWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteTagConfigurationWithHttpInfoAsync(String metricName)

Delete a tag configuration.

See deleteTagConfigurationWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

estimateMetricsOutputSeries

public MetricEstimateResponse estimateMetricsOutputSeries(String metricName)
                                                   throws ApiException

Tag Configuration Cardinality Estimator.

See estimateMetricsOutputSeriesWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.EstimateMetricsOutputSeriesOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

Returns:

MetricEstimateResponse

Throws:

ApiException - if fails to make API call

estimateMetricsOutputSeriesAsync

public CompletableFuture<MetricEstimateResponse> estimateMetricsOutputSeriesAsync(String metricName)

Tag Configuration Cardinality Estimator.

See estimateMetricsOutputSeriesWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.EstimateMetricsOutputSeriesOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<MetricEstimateResponse>

estimateMetricsOutputSeries

public MetricEstimateResponse estimateMetricsOutputSeries(String metricName,
                                                          MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters)
                                                   throws ApiException

Tag Configuration Cardinality Estimator.

See estimateMetricsOutputSeriesWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.EstimateMetricsOutputSeriesOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

MetricEstimateResponse

Throws:

ApiException - if fails to make API call

estimateMetricsOutputSeriesAsync

public CompletableFuture<MetricEstimateResponse> estimateMetricsOutputSeriesAsync(String metricName,
                                                                                  MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters)

Tag Configuration Cardinality Estimator.

See estimateMetricsOutputSeriesWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.EstimateMetricsOutputSeriesOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MetricEstimateResponse>

estimateMetricsOutputSeriesWithHttpInfo

public ApiResponse<MetricEstimateResponse> estimateMetricsOutputSeriesWithHttpInfo(String metricName,
                                                                                   MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters)
                                                                            throws ApiException

Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™.

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<MetricEstimateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Success	-
400	API error response.	-
403	API error response.	-
404	API error response.	-
429	Too Many Requests	-

estimateMetricsOutputSeriesWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricEstimateResponse>> estimateMetricsOutputSeriesWithHttpInfoAsync(String metricName,
                                                                                                           MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters)

Tag Configuration Cardinality Estimator.

See estimateMetricsOutputSeriesWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.EstimateMetricsOutputSeriesOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MetricEstimateResponse>>

listActiveMetricConfigurations

public MetricSuggestedTagsAndAggregationsResponse listActiveMetricConfigurations(String metricName)
                                                                          throws ApiException

List active tags and aggregations.

See listActiveMetricConfigurationsWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.ListActiveMetricConfigurationsOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

Returns:

MetricSuggestedTagsAndAggregationsResponse

Throws:

ApiException - if fails to make API call

listActiveMetricConfigurationsAsync

public CompletableFuture<MetricSuggestedTagsAndAggregationsResponse> listActiveMetricConfigurationsAsync(String metricName)

List active tags and aggregations.

See listActiveMetricConfigurationsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.ListActiveMetricConfigurationsOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<MetricSuggestedTagsAndAggregationsResponse>

listActiveMetricConfigurations

public MetricSuggestedTagsAndAggregationsResponse listActiveMetricConfigurations(String metricName,
                                                                                 MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters)
                                                                          throws ApiException

List active tags and aggregations.

See listActiveMetricConfigurationsWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.ListActiveMetricConfigurationsOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

MetricSuggestedTagsAndAggregationsResponse

Throws:

ApiException - if fails to make API call

listActiveMetricConfigurationsAsync

public CompletableFuture<MetricSuggestedTagsAndAggregationsResponse> listActiveMetricConfigurationsAsync(String metricName,
                                                                                                         MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters)

List active tags and aggregations.

See listActiveMetricConfigurationsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.ListActiveMetricConfigurationsOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MetricSuggestedTagsAndAggregationsResponse>

listActiveMetricConfigurationsWithHttpInfo

public ApiResponse<MetricSuggestedTagsAndAggregationsResponse> listActiveMetricConfigurationsWithHttpInfo(String metricName,
                                                                                                          MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters)
                                                                                                   throws ApiException

List tags and aggregations that are actively queried on dashboards and monitors for a given metric name.

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<MetricSuggestedTagsAndAggregationsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

listActiveMetricConfigurationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricSuggestedTagsAndAggregationsResponse>> listActiveMetricConfigurationsWithHttpInfoAsync(String metricName,
                                                                                                                                  MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters)

List active tags and aggregations.

See listActiveMetricConfigurationsWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.MetricsApi.ListActiveMetricConfigurationsOptionalParameters).

Parameters:

metricName - The name of the metric. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MetricSuggestedTagsAndAggregationsResponse>>

listTagConfigurationByName

public MetricTagConfigurationResponse listTagConfigurationByName(String metricName)
                                                          throws ApiException

List tag configuration by name.

See listTagConfigurationByNameWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

MetricTagConfigurationResponse

Throws:

ApiException - if fails to make API call

listTagConfigurationByNameAsync

public CompletableFuture<MetricTagConfigurationResponse> listTagConfigurationByNameAsync(String metricName)

List tag configuration by name.

See listTagConfigurationByNameWithHttpInfoAsync(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<MetricTagConfigurationResponse>

listTagConfigurationByNameWithHttpInfo

public ApiResponse<MetricTagConfigurationResponse> listTagConfigurationByNameWithHttpInfo(String metricName)
                                                                                   throws ApiException

Returns the tag configuration for the given metric name.

Parameters:

metricName - The name of the metric. (required)

Returns:

ApiResponse<MetricTagConfigurationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

listTagConfigurationByNameWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricTagConfigurationResponse>> listTagConfigurationByNameWithHttpInfoAsync(String metricName)

List tag configuration by name.

See listTagConfigurationByNameWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>

listTagConfigurations

public MetricsAndMetricTagConfigurationsResponse listTagConfigurations()
                                                                throws ApiException

Get a list of metrics.

See listTagConfigurationsWithHttpInfo(com.datadog.api.client.v2.api.MetricsApi.ListTagConfigurationsOptionalParameters).

Returns:

MetricsAndMetricTagConfigurationsResponse

Throws:

ApiException - if fails to make API call

listTagConfigurationsAsync

public CompletableFuture<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsAsync()

Get a list of metrics.

See listTagConfigurationsWithHttpInfoAsync(com.datadog.api.client.v2.api.MetricsApi.ListTagConfigurationsOptionalParameters).

Returns:

CompletableFuture<MetricsAndMetricTagConfigurationsResponse>

listTagConfigurations

public MetricsAndMetricTagConfigurationsResponse listTagConfigurations(MetricsApi.ListTagConfigurationsOptionalParameters parameters)
                                                                throws ApiException

Get a list of metrics.

See listTagConfigurationsWithHttpInfo(com.datadog.api.client.v2.api.MetricsApi.ListTagConfigurationsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

MetricsAndMetricTagConfigurationsResponse

Throws:

ApiException - if fails to make API call

listTagConfigurationsAsync

public CompletableFuture<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters)

Get a list of metrics.

See listTagConfigurationsWithHttpInfoAsync(com.datadog.api.client.v2.api.MetricsApi.ListTagConfigurationsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MetricsAndMetricTagConfigurationsResponse>

listTagConfigurationsWithHttpInfo

public ApiResponse<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsWithHttpInfo(MetricsApi.ListTagConfigurationsOptionalParameters parameters)
                                                                                         throws ApiException

Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<MetricsAndMetricTagConfigurationsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
429	Too Many Requests	-

listTagConfigurationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricsAndMetricTagConfigurationsResponse>> listTagConfigurationsWithHttpInfoAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters)

Get a list of metrics.

See listTagConfigurationsWithHttpInfo(com.datadog.api.client.v2.api.MetricsApi.ListTagConfigurationsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MetricsAndMetricTagConfigurationsResponse>>

listTagsByMetricName

public MetricAllTagsResponse listTagsByMetricName(String metricName)
                                           throws ApiException

List tags by metric name.

See listTagsByMetricNameWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

MetricAllTagsResponse

Throws:

ApiException - if fails to make API call

listTagsByMetricNameAsync

public CompletableFuture<MetricAllTagsResponse> listTagsByMetricNameAsync(String metricName)

List tags by metric name.

See listTagsByMetricNameWithHttpInfoAsync(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<MetricAllTagsResponse>

listTagsByMetricNameWithHttpInfo

public ApiResponse<MetricAllTagsResponse> listTagsByMetricNameWithHttpInfo(String metricName)
                                                                    throws ApiException

View indexed tag key-value pairs for a given metric name.

Parameters:

metricName - The name of the metric. (required)

Returns:

ApiResponse<MetricAllTagsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

listTagsByMetricNameWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricAllTagsResponse>> listTagsByMetricNameWithHttpInfoAsync(String metricName)

List tags by metric name.

See listTagsByMetricNameWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<ApiResponse<MetricAllTagsResponse>>

listVolumesByMetricName

public MetricVolumesResponse listVolumesByMetricName(String metricName)
                                              throws ApiException

List distinct metric volumes by metric name.

See listVolumesByMetricNameWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

MetricVolumesResponse

Throws:

ApiException - if fails to make API call

listVolumesByMetricNameAsync

public CompletableFuture<MetricVolumesResponse> listVolumesByMetricNameAsync(String metricName)

List distinct metric volumes by metric name.

See listVolumesByMetricNameWithHttpInfoAsync(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<MetricVolumesResponse>

listVolumesByMetricNameWithHttpInfo

public ApiResponse<MetricVolumesResponse> listVolumesByMetricNameWithHttpInfo(String metricName)
                                                                       throws ApiException

View distinct metrics volumes for the given metric name.

Custom metrics generated in-app from other products will return null for ingested volumes.

Parameters:

metricName - The name of the metric. (required)

Returns:

ApiResponse<MetricVolumesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

listVolumesByMetricNameWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricVolumesResponse>> listVolumesByMetricNameWithHttpInfoAsync(String metricName)

List distinct metric volumes by metric name.

See listVolumesByMetricNameWithHttpInfo(java.lang.String).

Parameters:

metricName - The name of the metric. (required)

Returns:

CompletableFuture<ApiResponse<MetricVolumesResponse>>

queryScalarData

public ScalarFormulaQueryResponse queryScalarData(ScalarFormulaQueryRequest body)
                                           throws ApiException

Query scalar data across multiple products.

See queryScalarDataWithHttpInfo(com.datadog.api.client.v2.model.ScalarFormulaQueryRequest).

Parameters:

body - (required)

Returns:

ScalarFormulaQueryResponse

Throws:

ApiException - if fails to make API call

queryScalarDataAsync

public CompletableFuture<ScalarFormulaQueryResponse> queryScalarDataAsync(ScalarFormulaQueryRequest body)

Query scalar data across multiple products.

See queryScalarDataWithHttpInfoAsync(com.datadog.api.client.v2.model.ScalarFormulaQueryRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ScalarFormulaQueryResponse>

queryScalarDataWithHttpInfo

public ApiResponse<ScalarFormulaQueryResponse> queryScalarDataWithHttpInfo(ScalarFormulaQueryRequest body)
                                                                    throws ApiException

Query scalar values (as seen on Query Value, Table and Toplist widgets). Multiple data sources are supported with the ability to process the data using formulas and functions.

Parameters:

body - (required)

Returns:

ApiResponse<ScalarFormulaQueryResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too many requests	-

queryScalarDataWithHttpInfoAsync

public CompletableFuture<ApiResponse<ScalarFormulaQueryResponse>> queryScalarDataWithHttpInfoAsync(ScalarFormulaQueryRequest body)

Query scalar data across multiple products.

See queryScalarDataWithHttpInfo(com.datadog.api.client.v2.model.ScalarFormulaQueryRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ScalarFormulaQueryResponse>>

queryTimeseriesData

public TimeseriesFormulaQueryResponse queryTimeseriesData(TimeseriesFormulaQueryRequest body)
                                                   throws ApiException

Query timeseries data across multiple products.

See queryTimeseriesDataWithHttpInfo(com.datadog.api.client.v2.model.TimeseriesFormulaQueryRequest).

Parameters:

body - (required)

Returns:

TimeseriesFormulaQueryResponse

Throws:

ApiException - if fails to make API call

queryTimeseriesDataAsync

public CompletableFuture<TimeseriesFormulaQueryResponse> queryTimeseriesDataAsync(TimeseriesFormulaQueryRequest body)

Query timeseries data across multiple products.

See queryTimeseriesDataWithHttpInfoAsync(com.datadog.api.client.v2.model.TimeseriesFormulaQueryRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<TimeseriesFormulaQueryResponse>

queryTimeseriesDataWithHttpInfo

public ApiResponse<TimeseriesFormulaQueryResponse> queryTimeseriesDataWithHttpInfo(TimeseriesFormulaQueryRequest body)
                                                                            throws ApiException

Query timeseries data across various data sources and process the data by applying formulas and functions.

Parameters:

body - (required)

Returns:

ApiResponse<TimeseriesFormulaQueryResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too many requests	-

queryTimeseriesDataWithHttpInfoAsync

public CompletableFuture<ApiResponse<TimeseriesFormulaQueryResponse>> queryTimeseriesDataWithHttpInfoAsync(TimeseriesFormulaQueryRequest body)

Query timeseries data across multiple products.

See queryTimeseriesDataWithHttpInfo(com.datadog.api.client.v2.model.TimeseriesFormulaQueryRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<TimeseriesFormulaQueryResponse>>

submitMetrics

public IntakePayloadAccepted submitMetrics(MetricPayload body)
                                    throws ApiException

Submit metrics.

See submitMetricsWithHttpInfo(com.datadog.api.client.v2.model.MetricPayload, com.datadog.api.client.v2.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

Returns:

IntakePayloadAccepted

Throws:

ApiException - if fails to make API call

submitMetricsAsync

public CompletableFuture<IntakePayloadAccepted> submitMetricsAsync(MetricPayload body)

Submit metrics.

See submitMetricsWithHttpInfoAsync(com.datadog.api.client.v2.model.MetricPayload, com.datadog.api.client.v2.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

Returns:

CompletableFuture<IntakePayloadAccepted>

submitMetrics

public IntakePayloadAccepted submitMetrics(MetricPayload body,
                                           MetricsApi.SubmitMetricsOptionalParameters parameters)
                                    throws ApiException

Submit metrics.

See submitMetricsWithHttpInfo(com.datadog.api.client.v2.model.MetricPayload, com.datadog.api.client.v2.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

IntakePayloadAccepted

Throws:

ApiException - if fails to make API call

submitMetricsAsync

public CompletableFuture<IntakePayloadAccepted> submitMetricsAsync(MetricPayload body,
                                                                   MetricsApi.SubmitMetricsOptionalParameters parameters)

Submit metrics.

See submitMetricsWithHttpInfoAsync(com.datadog.api.client.v2.model.MetricPayload, com.datadog.api.client.v2.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<IntakePayloadAccepted>

submitMetricsWithHttpInfo

public ApiResponse<IntakePayloadAccepted> submitMetricsWithHttpInfo(MetricPayload body,
                                                                    MetricsApi.SubmitMetricsOptionalParameters parameters)
                                                             throws ApiException

The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes).

If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:

• 64 bits for the timestamp
• 64 bits for the value
• 20 bytes for the metric names
• 50 bytes for the timeseries
• The full payload is approximately 100 bytes.

Host name is one of the resources in the Resources field.

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<IntakePayloadAccepted>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Payload accepted	-
400	Bad Request	-
403	Authentication error	-
408	Request timeout	-
413	Payload too large	-
429	Too many requests	-

submitMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<IntakePayloadAccepted>> submitMetricsWithHttpInfoAsync(MetricPayload body,
                                                                                            MetricsApi.SubmitMetricsOptionalParameters parameters)

Submit metrics.

See submitMetricsWithHttpInfo(com.datadog.api.client.v2.model.MetricPayload, com.datadog.api.client.v2.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<IntakePayloadAccepted>>

updateTagConfiguration

public MetricTagConfigurationResponse updateTagConfiguration(String metricName,
                                                             MetricTagConfigurationUpdateRequest body)
                                                      throws ApiException

Update a tag configuration.

See updateTagConfigurationWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.MetricTagConfigurationUpdateRequest).

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

MetricTagConfigurationResponse

Throws:

ApiException - if fails to make API call

updateTagConfigurationAsync

public CompletableFuture<MetricTagConfigurationResponse> updateTagConfigurationAsync(String metricName,
                                                                                     MetricTagConfigurationUpdateRequest body)

Update a tag configuration.

See updateTagConfigurationWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.MetricTagConfigurationUpdateRequest).

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

CompletableFuture<MetricTagConfigurationResponse>

updateTagConfigurationWithHttpInfo

public ApiResponse<MetricTagConfigurationResponse> updateTagConfigurationWithHttpInfo(String metricName,
                                                                                      MetricTagConfigurationUpdateRequest body)
                                                                               throws ApiException

Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations of a count, rate, or gauge metric. Can only be used with application keys from users with the Manage Tags for Metrics permission.

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

ApiResponse<MetricTagConfigurationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
422	Unprocessable Entity	-
429	Too Many Requests	-

updateTagConfigurationWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricTagConfigurationResponse>> updateTagConfigurationWithHttpInfoAsync(String metricName,
                                                                                                              MetricTagConfigurationUpdateRequest body)

Update a tag configuration.

See updateTagConfigurationWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.MetricTagConfigurationUpdateRequest).

Parameters:

metricName - The name of the metric. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>