Class MetricsApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to estimateMetricsOutputSeries.static classManage optional parameters to listActiveMetricConfigurations.static classManage optional parameters to listTagConfigurations.static classManage optional parameters to listTagIndexingRules.static classManage optional parameters to listTagsByMetricName.static classManage optional parameters to listVolumesByMetricName.static classManage optional parameters to submitMetrics. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.Deprecated.Deprecated.Enable historical metrics ingestion.Enable historical metrics ingestion.Enable historical metrics ingestion (late data ingestion) for a metric.createHistoricalMetricsConfigurationWithHttpInfoAsync(HistoricalMetricsConfigurationCreateRequest body) Enable historical metrics ingestion.createTagConfiguration(String metricName, MetricTagConfigurationCreateRequest body) Create a tag configuration.createTagConfigurationAsync(String metricName, MetricTagConfigurationCreateRequest body) Create a tag configuration.createTagConfigurationWithHttpInfo(String metricName, MetricTagConfigurationCreateRequest body) Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.createTagConfigurationWithHttpInfoAsync(String metricName, MetricTagConfigurationCreateRequest body) Create a tag configuration.Create a tag indexing rule.Create a tag indexing rule.createTagIndexingRuleExemption(String metricName, TagIndexingRuleExemptionCreateRequest body) Create a tag indexing rule exemption.createTagIndexingRuleExemptionAsync(String metricName, TagIndexingRuleExemptionCreateRequest body) Create a tag indexing rule exemption.createTagIndexingRuleExemptionWithHttpInfo(String metricName, TagIndexingRuleExemptionCreateRequest body) Exempt a metric from all tag indexing rules.createTagIndexingRuleExemptionWithHttpInfoAsync(String metricName, TagIndexingRuleExemptionCreateRequest body) Create a tag indexing rule exemption.Create a tag indexing rule for the org.Create a tag indexing rule.Deprecated.Deprecated.Deprecated.Deprecated.voiddeleteHistoricalMetricsConfiguration(String metricName) Delete a historical metrics configuration.deleteHistoricalMetricsConfigurationAsync(String metricName) Delete a historical metrics configuration.Disable historical metrics ingestion for a metric.Delete a historical metrics configuration.voiddeleteTagConfiguration(String metricName) Delete a tag configuration.deleteTagConfigurationAsync(String metricName) Delete a tag configuration.deleteTagConfigurationWithHttpInfo(String metricName) Deletes a metric's tag configuration.deleteTagConfigurationWithHttpInfoAsync(String metricName) Delete a tag configuration.voidDelete a tag indexing rule.Delete a tag indexing rule.voiddeleteTagIndexingRuleExemption(String metricName) Delete a tag indexing rule exemption.deleteTagIndexingRuleExemptionAsync(String metricName) Delete a tag indexing rule exemption.deleteTagIndexingRuleExemptionWithHttpInfo(String metricName) Remove a metric's exemption from tag indexing rules.Delete a tag indexing rule exemption.Soft-delete a tag indexing rule.Delete a tag indexing rule.estimateMetricsOutputSeries(String metricName) Tag Configuration Cardinality Estimator.estimateMetricsOutputSeries(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Tag Configuration Cardinality Estimator.estimateMetricsOutputSeriesAsync(String metricName) Tag Configuration Cardinality Estimator.estimateMetricsOutputSeriesAsync(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Tag Configuration Cardinality Estimator.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™.estimateMetricsOutputSeriesWithHttpInfoAsync(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) Tag Configuration Cardinality Estimator.Get the API client.getHistoricalMetricsConfiguration(String metricName) Get a historical metrics configuration.getHistoricalMetricsConfigurationAsync(String metricName) Get a historical metrics configuration.getHistoricalMetricsConfigurationWithHttpInfo(String metricName) Get the historical metrics ingestion configuration for a metric.Get a historical metrics configuration.getMetricTagCardinalityDetails(String metricName) Get tag key cardinality details.getMetricTagCardinalityDetailsAsync(String metricName) Get tag key cardinality details.getMetricTagCardinalityDetailsWithHttpInfo(String metricName) Returns the cardinality details of tags for a specific metric.Get tag key cardinality details.Get a tag indexing rule.Get a tag indexing rule.getTagIndexingRuleExemption(String metricName) Get a tag indexing rule exemption.getTagIndexingRuleExemptionAsync(String metricName) Get a tag indexing rule exemption.getTagIndexingRuleExemptionWithHttpInfo(String metricName) Returns why a metric is excluded from tag indexing rules.getTagIndexingRuleExemptionWithHttpInfoAsync(String metricName) Get a tag indexing rule exemption.Get a single tag indexing rule by its UUID.Get a tag indexing rule.listActiveMetricConfigurations(String metricName) List active tags and aggregations.listActiveMetricConfigurations(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List active tags and aggregations.listActiveMetricConfigurationsAsync(String metricName) List active tags and aggregations.listActiveMetricConfigurationsAsync(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List active tags and aggregations.listActiveMetricConfigurationsWithHttpInfo(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name.listActiveMetricConfigurationsWithHttpInfoAsync(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) List active tags and aggregations.listMetricAssets(String metricName) Related Assets to a Metric.listMetricAssetsAsync(String metricName) Related Assets to a Metric.listMetricAssetsWithHttpInfo(String metricName) Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any.listMetricAssetsWithHttpInfoAsync(String metricName) Related Assets to a Metric.listTagConfigurationByName(String metricName) List tag configuration by name.listTagConfigurationByNameAsync(String metricName) List tag configuration by name.listTagConfigurationByNameWithHttpInfo(String metricName) Returns the tag configuration for the given metric name.listTagConfigurationByNameWithHttpInfoAsync(String metricName) List tag configuration by name.Get a list of metrics.Get a list of metrics.Get a list of metrics.Get a list of metrics.Get a list of actively reporting metrics for your organization.listTagConfigurationsWithHttpInfoAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters) Get a list of metrics.Get a list of metrics.Get a list of metrics.List tag indexing rules.List tag indexing rules.List tag indexing rules.List tag indexing rules.listTagIndexingRulesForMetric(String metricName) List tag indexing rules for a metric.listTagIndexingRulesForMetricAsync(String metricName) List tag indexing rules for a metric.listTagIndexingRulesForMetricWithHttpInfo(String metricName) List the tag indexing rules that apply to a given metric, sorted byrule_order.listTagIndexingRulesForMetricWithHttpInfoAsync(String metricName) List tag indexing rules for a metric.List tag indexing rules for an org, sorted byrule_order, with offset/limit pagination.List tag indexing rules.listTagsByMetricName(String metricName) List tags by metric name.listTagsByMetricName(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) List tags by metric name.listTagsByMetricNameAsync(String metricName) List tags by metric name.listTagsByMetricNameAsync(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) List tags by metric name.listTagsByMetricNameWithHttpInfo(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) View indexed and ingested tags for a given metric name.listTagsByMetricNameWithHttpInfoAsync(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) List tags by metric name.listVolumesByMetricName(String metricName) List distinct metric volumes by metric name.listVolumesByMetricName(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) List distinct metric volumes by metric name.listVolumesByMetricNameAsync(String metricName) List distinct metric volumes by metric name.listVolumesByMetricNameAsync(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) List distinct metric volumes by metric name.listVolumesByMetricNameWithHttpInfo(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) View hourly average cardinality for the given metric name over the look back period.listVolumesByMetricNameWithHttpInfoAsync(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) List distinct metric volumes by metric name.Query scalar data across multiple products.Query scalar data across multiple products.Query scalar values (as seen on Query Value, Table, and Toplist widgets).Query scalar data across multiple products.Query timeseries data across multiple products.Query timeseries data across multiple products.Query timeseries data across various data sources and process the data by applying formulas and functions.Query timeseries data across multiple products.voidReorder tag indexing rules.Reorder tag indexing rules.Atomically re-sequence the tag indexing rules for an org to match the supplied list of rule UUIDs.Reorder tag indexing rules.voidsetApiClient(ApiClient apiClient) Set the API client.submitMetrics(MetricPayload body) Submit metrics.submitMetrics(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.Submit metrics.submitMetricsAsync(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.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.submitMetricsWithHttpInfoAsync(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.updateTagConfiguration(String metricName, MetricTagConfigurationUpdateRequest body) Update a tag configuration.updateTagConfigurationAsync(String metricName, MetricTagConfigurationUpdateRequest body) Update a tag configuration.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.updateTagConfigurationWithHttpInfoAsync(String metricName, MetricTagConfigurationUpdateRequest body) Update a tag configuration.Update a tag indexing rule.Update a tag indexing rule.Partially update a tag indexing rule.Update a tag indexing rule.
-
Constructor Details
-
MetricsApi
public MetricsApi() -
MetricsApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
createBulkTagsMetricsConfiguration
@Deprecated public MetricBulkTagConfigResponse createBulkTagsMetricsConfiguration(MetricBulkTagConfigCreateRequest body) throws ApiException Deprecated.Configure tags for multiple metrics.- Parameters:
body- (required)- Returns:
- MetricBulkTagConfigResponse
- Throws:
ApiException- if fails to make API call
-
createBulkTagsMetricsConfigurationAsync
@Deprecated public CompletableFuture<MetricBulkTagConfigResponse> createBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigCreateRequest body) Deprecated.Configure tags for multiple metrics.- Parameters:
body- (required)- Returns:
- CompletableFuture<MetricBulkTagConfigResponse>
-
createBulkTagsMetricsConfigurationWithHttpInfo
@Deprecated public ApiResponse<MetricBulkTagConfigResponse> createBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigCreateRequest body) throws ApiException Deprecated.Note: This endpoint is deprecated. Use Tag Indexing Rules (POST /api/v2/metrics/tag-indexing-rules) instead.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. The
exclude_tags_modevalue will set all metrics that match the prefix to the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric. Can only be used with application keys of users with theManage Tags for Metricspermission.- 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
@Deprecated public CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>> createBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigCreateRequest body) Deprecated.Configure tags for multiple metrics.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>>
-
createHistoricalMetricsConfiguration
public HistoricalMetricsConfigurationResponse createHistoricalMetricsConfiguration(HistoricalMetricsConfigurationCreateRequest body) throws ApiException Enable historical metrics ingestion.- Parameters:
body- (required)- Returns:
- HistoricalMetricsConfigurationResponse
- Throws:
ApiException- if fails to make API call
-
createHistoricalMetricsConfigurationAsync
public CompletableFuture<HistoricalMetricsConfigurationResponse> createHistoricalMetricsConfigurationAsync(HistoricalMetricsConfigurationCreateRequest body) Enable historical metrics ingestion.- Parameters:
body- (required)- Returns:
- CompletableFuture<HistoricalMetricsConfigurationResponse>
-
createHistoricalMetricsConfigurationWithHttpInfo
public ApiResponse<HistoricalMetricsConfigurationResponse> createHistoricalMetricsConfigurationWithHttpInfo(HistoricalMetricsConfigurationCreateRequest body) throws ApiException Enable historical metrics ingestion (late data ingestion) for a metric. Idempotent: enabling an already-enabled metric returns 200 instead of 201. Not supported for distribution metrics, metrics with an existing tag configuration, or most standard (non-custom) metrics.- Parameters:
body- (required)- Returns:
- ApiResponse<HistoricalMetricsConfigurationResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 201 Created - 400 Bad Request - 404 Not Found - 422 Unprocessable Entity - 429 Too many requests -
-
createHistoricalMetricsConfigurationWithHttpInfoAsync
public CompletableFuture<ApiResponse<HistoricalMetricsConfigurationResponse>> createHistoricalMetricsConfigurationWithHttpInfoAsync(HistoricalMetricsConfigurationCreateRequest body) Enable historical metrics ingestion.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<HistoricalMetricsConfigurationResponse>>
-
createTagConfiguration
public MetricTagConfigurationResponse createTagConfiguration(String metricName, MetricTagConfigurationCreateRequest body) throws ApiException Create a tag configuration.- 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.- 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. By settingexclude_tags_modeto true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are not queryable. Can only be used with application keys of users with theManage Tags for Metricspermission.- 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.- Parameters:
metricName- The name of the metric. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>
-
createTagIndexingRule
public TagIndexingRuleResponse createTagIndexingRule(TagIndexingRuleCreateRequest body) throws ApiException Create a tag indexing rule.See
createTagIndexingRuleWithHttpInfo(com.datadog.api.client.v2.model.TagIndexingRuleCreateRequest).- Parameters:
body- (required)- Returns:
- TagIndexingRuleResponse
- Throws:
ApiException- if fails to make API call
-
createTagIndexingRuleAsync
public CompletableFuture<TagIndexingRuleResponse> createTagIndexingRuleAsync(TagIndexingRuleCreateRequest body) Create a tag indexing rule.See
createTagIndexingRuleWithHttpInfoAsync(com.datadog.api.client.v2.model.TagIndexingRuleCreateRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<TagIndexingRuleResponse>
-
createTagIndexingRuleWithHttpInfo
public ApiResponse<TagIndexingRuleResponse> createTagIndexingRuleWithHttpInfo(TagIndexingRuleCreateRequest body) throws ApiException Create a tag indexing rule for the org.rule_orderis assigned server-side as max+1 among existing rules; use the reorder endpoint to change the evaluation order. Requires theManage Tags for Metricspermission.- Parameters:
body- (required)- Returns:
- ApiResponse<TagIndexingRuleResponse>
- 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 - 429 Too Many Requests -
-
createTagIndexingRuleWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRuleResponse>> createTagIndexingRuleWithHttpInfoAsync(TagIndexingRuleCreateRequest body) Create a tag indexing rule.See
createTagIndexingRuleWithHttpInfo(com.datadog.api.client.v2.model.TagIndexingRuleCreateRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<TagIndexingRuleResponse>>
-
createTagIndexingRuleExemption
public TagIndexingRuleExemptionResponse createTagIndexingRuleExemption(String metricName, TagIndexingRuleExemptionCreateRequest body) throws ApiException Create a tag indexing rule exemption.- Parameters:
metricName- The name of the metric. (required)body- (required)- Returns:
- TagIndexingRuleExemptionResponse
- Throws:
ApiException- if fails to make API call
-
createTagIndexingRuleExemptionAsync
public CompletableFuture<TagIndexingRuleExemptionResponse> createTagIndexingRuleExemptionAsync(String metricName, TagIndexingRuleExemptionCreateRequest body) Create a tag indexing rule exemption.- Parameters:
metricName- The name of the metric. (required)body- (required)- Returns:
- CompletableFuture<TagIndexingRuleExemptionResponse>
-
createTagIndexingRuleExemptionWithHttpInfo
public ApiResponse<TagIndexingRuleExemptionResponse> createTagIndexingRuleExemptionWithHttpInfo(String metricName, TagIndexingRuleExemptionCreateRequest body) throws ApiException Exempt a metric from all tag indexing rules. The response includes the created exemption resource. Requires theManage Tags for Metricspermission.- Parameters:
metricName- The name of the metric. (required)body- (required)- Returns:
- ApiResponse<TagIndexingRuleExemptionResponse>
- 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 - 429 Too Many Requests -
-
createTagIndexingRuleExemptionWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRuleExemptionResponse>> createTagIndexingRuleExemptionWithHttpInfoAsync(String metricName, TagIndexingRuleExemptionCreateRequest body) Create a tag indexing rule exemption.- Parameters:
metricName- The name of the metric. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<TagIndexingRuleExemptionResponse>>
-
deleteBulkTagsMetricsConfiguration
@Deprecated public MetricBulkTagConfigResponse deleteBulkTagsMetricsConfiguration(MetricBulkTagConfigDeleteRequest body) throws ApiException Deprecated.Delete tags for multiple metrics.- Parameters:
body- (required)- Returns:
- MetricBulkTagConfigResponse
- Throws:
ApiException- if fails to make API call
-
deleteBulkTagsMetricsConfigurationAsync
@Deprecated public CompletableFuture<MetricBulkTagConfigResponse> deleteBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigDeleteRequest body) Deprecated.Delete tags for multiple metrics.- Parameters:
body- (required)- Returns:
- CompletableFuture<MetricBulkTagConfigResponse>
-
deleteBulkTagsMetricsConfigurationWithHttpInfo
@Deprecated public ApiResponse<MetricBulkTagConfigResponse> deleteBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigDeleteRequest body) throws ApiException Deprecated.Note: This endpoint is deprecated. Use Tag Indexing Rules (POST /api/v2/metrics/tag-indexing-rules) instead.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 Metricspermission.- 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
@Deprecated public CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>> deleteBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigDeleteRequest body) Deprecated.Delete tags for multiple metrics.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>>
-
deleteHistoricalMetricsConfiguration
Delete a historical metrics configuration.See
deleteHistoricalMetricsConfigurationWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Throws:
ApiException- if fails to make API call
-
deleteHistoricalMetricsConfigurationAsync
Delete a historical metrics configuration.See
deleteHistoricalMetricsConfigurationWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture
-
deleteHistoricalMetricsConfigurationWithHttpInfo
public ApiResponse<Void> deleteHistoricalMetricsConfigurationWithHttpInfo(String metricName) throws ApiException Disable historical metrics ingestion for a metric. Idempotent: always returns 204, whether or not the configuration existed or the metric itself still exists, so that Terraform destroy succeeds for a metric removed out-of-band.- 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 - 400 Bad Request - 429 Too many requests -
-
deleteHistoricalMetricsConfigurationWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> deleteHistoricalMetricsConfigurationWithHttpInfoAsync(String metricName) Delete a historical metrics configuration.See
deleteHistoricalMetricsConfigurationWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteTagConfiguration
Delete a tag configuration.- Parameters:
metricName- The name of the metric. (required)- Throws:
ApiException- if fails to make API call
-
deleteTagConfigurationAsync
Delete a tag configuration.See
deleteTagConfigurationWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture
-
deleteTagConfigurationWithHttpInfo
Deletes a metric's tag configuration. Can only be used with application keys from users with theManage Tags for Metricspermission. Note: This operation is irreversible.- 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.- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteTagIndexingRule
Delete a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)- Throws:
ApiException- if fails to make API call
-
deleteTagIndexingRuleAsync
Delete a tag indexing rule.See
deleteTagIndexingRuleWithHttpInfoAsync(java.lang.String).- Parameters:
id- ID of the tag indexing rule. (required)- Returns:
- CompletableFuture
-
deleteTagIndexingRuleWithHttpInfo
Soft-delete a tag indexing rule. Idempotent: returns 204 whether the rule existed or was already deleted. Remaining rules in the org are automatically re-sequenced to keeprule_orderdense and 1-based. Requires theManage Tags for Metricspermission.- Parameters:
id- ID of the tag indexing rule. (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 - 400 Bad Request - 403 Forbidden - 429 Too Many Requests -
-
deleteTagIndexingRuleWithHttpInfoAsync
Delete a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteTagIndexingRuleExemption
Delete a tag indexing rule exemption.See
deleteTagIndexingRuleExemptionWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Throws:
ApiException- if fails to make API call
-
deleteTagIndexingRuleExemptionAsync
Delete a tag indexing rule exemption.See
deleteTagIndexingRuleExemptionWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture
-
deleteTagIndexingRuleExemptionWithHttpInfo
public ApiResponse<Void> deleteTagIndexingRuleExemptionWithHttpInfo(String metricName) throws ApiException Remove a metric's exemption from tag indexing rules. Idempotent: returns 204 whether or not an exemption existed. Any associated legacy tag configuration record is also removed. Requires theManage Tags for Metricspermission.- 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 - 400 Bad Request - 403 Forbidden - 429 Too Many Requests -
-
deleteTagIndexingRuleExemptionWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> deleteTagIndexingRuleExemptionWithHttpInfoAsync(String metricName) Delete a tag indexing rule exemption.See
deleteTagIndexingRuleExemptionWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
estimateMetricsOutputSeries
Tag Configuration Cardinality Estimator.- 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.- 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.- 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.- 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.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<MetricEstimateResponse>>
-
getHistoricalMetricsConfiguration
public HistoricalMetricsConfigurationResponse getHistoricalMetricsConfiguration(String metricName) throws ApiException Get a historical metrics configuration.See
getHistoricalMetricsConfigurationWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- HistoricalMetricsConfigurationResponse
- Throws:
ApiException- if fails to make API call
-
getHistoricalMetricsConfigurationAsync
public CompletableFuture<HistoricalMetricsConfigurationResponse> getHistoricalMetricsConfigurationAsync(String metricName) Get a historical metrics configuration.See
getHistoricalMetricsConfigurationWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<HistoricalMetricsConfigurationResponse>
-
getHistoricalMetricsConfigurationWithHttpInfo
public ApiResponse<HistoricalMetricsConfigurationResponse> getHistoricalMetricsConfigurationWithHttpInfo(String metricName) throws ApiException Get the historical metrics ingestion configuration for a metric. Existence of the resource means historical metrics ingestion is enabled; returns 404 when it is not enabled for the metric.- Parameters:
metricName- The name of the metric. (required)- Returns:
- ApiResponse<HistoricalMetricsConfigurationResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 404 Not Found - 429 Too many requests -
-
getHistoricalMetricsConfigurationWithHttpInfoAsync
public CompletableFuture<ApiResponse<HistoricalMetricsConfigurationResponse>> getHistoricalMetricsConfigurationWithHttpInfoAsync(String metricName) Get a historical metrics configuration.See
getHistoricalMetricsConfigurationWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<HistoricalMetricsConfigurationResponse>>
-
getMetricTagCardinalityDetails
public MetricTagCardinalitiesResponse getMetricTagCardinalityDetails(String metricName) throws ApiException Get tag key cardinality details.See
getMetricTagCardinalityDetailsWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- MetricTagCardinalitiesResponse
- Throws:
ApiException- if fails to make API call
-
getMetricTagCardinalityDetailsAsync
public CompletableFuture<MetricTagCardinalitiesResponse> getMetricTagCardinalityDetailsAsync(String metricName) Get tag key cardinality details.See
getMetricTagCardinalityDetailsWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<MetricTagCardinalitiesResponse>
-
getMetricTagCardinalityDetailsWithHttpInfo
public ApiResponse<MetricTagCardinalitiesResponse> getMetricTagCardinalityDetailsWithHttpInfo(String metricName) throws ApiException Returns the cardinality details of tags for a specific metric.- Parameters:
metricName- The name of the metric. (required)- Returns:
- ApiResponse<MetricTagCardinalitiesResponse>
- 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 -
-
getMetricTagCardinalityDetailsWithHttpInfoAsync
public CompletableFuture<ApiResponse<MetricTagCardinalitiesResponse>> getMetricTagCardinalityDetailsWithHttpInfoAsync(String metricName) Get tag key cardinality details.See
getMetricTagCardinalityDetailsWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<MetricTagCardinalitiesResponse>>
-
getTagIndexingRule
Get a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)- Returns:
- TagIndexingRuleResponse
- Throws:
ApiException- if fails to make API call
-
getTagIndexingRuleAsync
Get a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)- Returns:
- CompletableFuture<TagIndexingRuleResponse>
-
getTagIndexingRuleWithHttpInfo
public ApiResponse<TagIndexingRuleResponse> getTagIndexingRuleWithHttpInfo(String id) throws ApiException Get a single tag indexing rule by its UUID.- Parameters:
id- ID of the tag indexing rule. (required)- Returns:
- ApiResponse<TagIndexingRuleResponse>
- 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 - 404 Not Found - 429 Too Many Requests -
-
getTagIndexingRuleWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRuleResponse>> getTagIndexingRuleWithHttpInfoAsync(String id) Get a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)- Returns:
- CompletableFuture<ApiResponse<TagIndexingRuleResponse>>
-
getTagIndexingRuleExemption
public TagIndexingRuleExemptionResponse getTagIndexingRuleExemption(String metricName) throws ApiException Get a tag indexing rule exemption.See
getTagIndexingRuleExemptionWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- TagIndexingRuleExemptionResponse
- Throws:
ApiException- if fails to make API call
-
getTagIndexingRuleExemptionAsync
public CompletableFuture<TagIndexingRuleExemptionResponse> getTagIndexingRuleExemptionAsync(String metricName) Get a tag indexing rule exemption.See
getTagIndexingRuleExemptionWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<TagIndexingRuleExemptionResponse>
-
getTagIndexingRuleExemptionWithHttpInfo
public ApiResponse<TagIndexingRuleExemptionResponse> getTagIndexingRuleExemptionWithHttpInfo(String metricName) throws ApiException Returns why a metric is excluded from tag indexing rules. Returns 200 withkind=exemptionwhen an explicit exemption exists, 200 withkind=legacy_tag_configurationwhen the metric has a legacy tag configuration acting as an implicit exclusion, or 404 when neither applies.- Parameters:
metricName- The name of the metric. (required)- Returns:
- ApiResponse<TagIndexingRuleExemptionResponse>
- 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 - 404 Not Found - 429 Too Many Requests -
-
getTagIndexingRuleExemptionWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRuleExemptionResponse>> getTagIndexingRuleExemptionWithHttpInfoAsync(String metricName) Get a tag indexing rule exemption.See
getTagIndexingRuleExemptionWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<TagIndexingRuleExemptionResponse>>
-
listActiveMetricConfigurations
public MetricSuggestedTagsAndAggregationsResponse listActiveMetricConfigurations(String metricName) throws ApiException List active tags and aggregations.- 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.- 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.- 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.- 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, notebooks, monitors, the Metrics Explorer, and using the API 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.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<MetricSuggestedTagsAndAggregationsResponse>>
-
listMetricAssets
Related Assets to a Metric.- Parameters:
metricName- The name of the metric. (required)- Returns:
- MetricAssetsResponse
- Throws:
ApiException- if fails to make API call
-
listMetricAssetsAsync
Related Assets to a Metric.- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<MetricAssetsResponse>
-
listMetricAssetsWithHttpInfo
public ApiResponse<MetricAssetsResponse> listMetricAssetsWithHttpInfo(String metricName) throws ApiException Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any. Updated every 24 hours.- Parameters:
metricName- The name of the metric. (required)- Returns:
- ApiResponse<MetricAssetsResponse>
- 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 -
-
listMetricAssetsWithHttpInfoAsync
public CompletableFuture<ApiResponse<MetricAssetsResponse>> listMetricAssetsWithHttpInfoAsync(String metricName) Related Assets to a Metric.- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<MetricAssetsResponse>>
-
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.A metric may exist and submit data without having a tag configuration. If no tag configuration exists for the metric, this endpoint returns
404 Not Found. This response does not indicate that the metric itself is missing.- 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 No tag configuration exists for the metric - 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
Get a list of metrics.- Returns:
- MetricsAndMetricTagConfigurationsResponse
- Throws:
ApiException- if fails to make API call
-
listTagConfigurationsAsync
Get a list of metrics.- Returns:
- CompletableFuture<MetricsAndMetricTagConfigurationsResponse>
-
listTagConfigurations
public MetricsAndMetricTagConfigurationsResponse listTagConfigurations(MetricsApi.ListTagConfigurationsOptionalParameters parameters) throws ApiException Get a list of metrics.- 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.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<MetricsAndMetricTagConfigurationsResponse>
-
listTagConfigurationsWithPagination
Get a list of metrics.- Returns:
- PaginationIterable<MetricsAndMetricTagConfigurations>
-
listTagConfigurationsWithPagination
public PaginationIterable<MetricsAndMetricTagConfigurations> listTagConfigurationsWithPagination(MetricsApi.ListTagConfigurationsOptionalParameters parameters) Get a list of metrics.- Returns:
- MetricsAndMetricTagConfigurationsResponse
-
listTagConfigurationsWithHttpInfo
public ApiResponse<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsWithHttpInfo(MetricsApi.ListTagConfigurationsOptionalParameters parameters) throws ApiException Get a list of actively reporting metrics for your organization. Pagination is optional using thepage[cursor]andpage[size]query parameters.Query parameters use bracket notation (for example,
filter[tags],filter[queried][window][seconds]). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example:GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500.- 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.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<MetricsAndMetricTagConfigurationsResponse>>
-
listTagIndexingRules
List tag indexing rules.- Returns:
- TagIndexingRulesResponse
- Throws:
ApiException- if fails to make API call
-
listTagIndexingRulesAsync
List tag indexing rules.- Returns:
- CompletableFuture<TagIndexingRulesResponse>
-
listTagIndexingRules
public TagIndexingRulesResponse listTagIndexingRules(MetricsApi.ListTagIndexingRulesOptionalParameters parameters) throws ApiException List tag indexing rules.- Parameters:
parameters- Optional parameters for the request.- Returns:
- TagIndexingRulesResponse
- Throws:
ApiException- if fails to make API call
-
listTagIndexingRulesAsync
public CompletableFuture<TagIndexingRulesResponse> listTagIndexingRulesAsync(MetricsApi.ListTagIndexingRulesOptionalParameters parameters) List tag indexing rules.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<TagIndexingRulesResponse>
-
listTagIndexingRulesWithHttpInfo
public ApiResponse<TagIndexingRulesResponse> listTagIndexingRulesWithHttpInfo(MetricsApi.ListTagIndexingRulesOptionalParameters parameters) throws ApiException List tag indexing rules for an org, sorted byrule_order, with offset/limit pagination.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<TagIndexingRulesResponse>
- 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 - 429 Too Many Requests -
-
listTagIndexingRulesWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRulesResponse>> listTagIndexingRulesWithHttpInfoAsync(MetricsApi.ListTagIndexingRulesOptionalParameters parameters) List tag indexing rules.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<TagIndexingRulesResponse>>
-
listTagIndexingRulesForMetric
public TagIndexingRulesResponse listTagIndexingRulesForMetric(String metricName) throws ApiException List tag indexing rules for a metric.See
listTagIndexingRulesForMetricWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- TagIndexingRulesResponse
- Throws:
ApiException- if fails to make API call
-
listTagIndexingRulesForMetricAsync
public CompletableFuture<TagIndexingRulesResponse> listTagIndexingRulesForMetricAsync(String metricName) List tag indexing rules for a metric.See
listTagIndexingRulesForMetricWithHttpInfoAsync(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<TagIndexingRulesResponse>
-
listTagIndexingRulesForMetricWithHttpInfo
public ApiResponse<TagIndexingRulesResponse> listTagIndexingRulesForMetricWithHttpInfo(String metricName) throws ApiException List the tag indexing rules that apply to a given metric, sorted byrule_order. Matching is performed server-side using each rule'smetric_name_matchesglob patterns.- Parameters:
metricName- The name of the metric. (required)- Returns:
- ApiResponse<TagIndexingRulesResponse>
- 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 - 429 Too Many Requests -
-
listTagIndexingRulesForMetricWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRulesResponse>> listTagIndexingRulesForMetricWithHttpInfoAsync(String metricName) List tag indexing rules for a metric.See
listTagIndexingRulesForMetricWithHttpInfo(java.lang.String).- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<ApiResponse<TagIndexingRulesResponse>>
-
listTagsByMetricName
List tags by metric name.- Parameters:
metricName- The name of the metric. (required)- Returns:
- MetricAllTagsResponse
- Throws:
ApiException- if fails to make API call
-
listTagsByMetricNameAsync
List tags by metric name.- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<MetricAllTagsResponse>
-
listTagsByMetricName
public MetricAllTagsResponse listTagsByMetricName(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) throws ApiException List tags by metric name.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- MetricAllTagsResponse
- Throws:
ApiException- if fails to make API call
-
listTagsByMetricNameAsync
public CompletableFuture<MetricAllTagsResponse> listTagsByMetricNameAsync(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) List tags by metric name.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<MetricAllTagsResponse>
-
listTagsByMetricNameWithHttpInfo
public ApiResponse<MetricAllTagsResponse> listTagsByMetricNameWithHttpInfo(String metricName, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) throws ApiException View indexed and ingested tags for a given metric name. Results are filtered by thewindow[seconds]parameter, which defaults to 14400 (4 hours).- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- 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, MetricsApi.ListTagsByMetricNameOptionalParameters parameters) List tags by metric name.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<MetricAllTagsResponse>>
-
listVolumesByMetricName
List distinct metric volumes by metric name.- Parameters:
metricName- The name of the metric. (required)- Returns:
- MetricVolumesResponse
- Throws:
ApiException- if fails to make API call
-
listVolumesByMetricNameAsync
List distinct metric volumes by metric name.- Parameters:
metricName- The name of the metric. (required)- Returns:
- CompletableFuture<MetricVolumesResponse>
-
listVolumesByMetricName
public MetricVolumesResponse listVolumesByMetricName(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) throws ApiException List distinct metric volumes by metric name.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- MetricVolumesResponse
- Throws:
ApiException- if fails to make API call
-
listVolumesByMetricNameAsync
public CompletableFuture<MetricVolumesResponse> listVolumesByMetricNameAsync(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) List distinct metric volumes by metric name.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<MetricVolumesResponse>
-
listVolumesByMetricNameWithHttpInfo
public ApiResponse<MetricVolumesResponse> listVolumesByMetricNameWithHttpInfo(String metricName, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) throws ApiException View hourly average cardinality for the given metric name over the look back period. For Metric Name Pricing customers, view total point volume for the given metric name over the look back period.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- 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, MetricsApi.ListVolumesByMetricNameOptionalParameters parameters) List distinct metric volumes by metric name.- Parameters:
metricName- The name of the metric. (required)parameters- Optional parameters for the request.- 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. Datadog recommends using this endpoint over the v1/api/v1/queryendpoint for querying timeseries data.- 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>>
-
reorderTagIndexingRules
Reorder tag indexing rules.See
reorderTagIndexingRulesWithHttpInfo(com.datadog.api.client.v2.model.TagIndexingRuleOrderRequest).- Parameters:
body- (required)- Throws:
ApiException- if fails to make API call
-
reorderTagIndexingRulesAsync
Reorder tag indexing rules.- Parameters:
body- (required)- Returns:
- CompletableFuture
-
reorderTagIndexingRulesWithHttpInfo
public ApiResponse<Void> reorderTagIndexingRulesWithHttpInfo(TagIndexingRuleOrderRequest body) throws ApiException Atomically re-sequence the tag indexing rules for an org to match the supplied list of rule UUIDs. The server assignsrule_order1, 2, … matching each rule UUID by position in the list. The UUIDs of all active rules must be provided; omitting any active rule UUID returns a 400 error. Requires theManage Tags for Metricspermission.- Parameters:
body- (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 - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too Many Requests -
-
reorderTagIndexingRulesWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> reorderTagIndexingRulesWithHttpInfoAsync(TagIndexingRuleOrderRequest body) Reorder tag indexing rules.See
reorderTagIndexingRulesWithHttpInfo(com.datadog.api.client.v2.model.TagIndexingRuleOrderRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
submitMetrics
Submit metrics.- Parameters:
body- (required)- Returns:
- IntakePayloadAccepted
- Throws:
ApiException- if fails to make API call
-
submitMetricsAsync
Submit metrics.- Parameters:
body- (required)- Returns:
- CompletableFuture<IntakePayloadAccepted>
-
submitMetrics
public IntakePayloadAccepted submitMetrics(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) throws ApiException Submit metrics.- 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.- 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.- 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.- 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.- 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. By settingexclude_tags_modeto true the behavior is changed from an allow-list to a deny-list, and tags in the defined list will not be queryable. Can only be used with application keys from users with theManage Tags for Metricspermission. This endpoint requires a tag configuration to be created first.- 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.- Parameters:
metricName- The name of the metric. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<MetricTagConfigurationResponse>>
-
updateTagIndexingRule
public TagIndexingRuleResponse updateTagIndexingRule(String id, TagIndexingRuleUpdateRequest body) throws ApiException Update a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)body- (required)- Returns:
- TagIndexingRuleResponse
- Throws:
ApiException- if fails to make API call
-
updateTagIndexingRuleAsync
public CompletableFuture<TagIndexingRuleResponse> updateTagIndexingRuleAsync(String id, TagIndexingRuleUpdateRequest body) Update a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)body- (required)- Returns:
- CompletableFuture<TagIndexingRuleResponse>
-
updateTagIndexingRuleWithHttpInfo
public ApiResponse<TagIndexingRuleResponse> updateTagIndexingRuleWithHttpInfo(String id, TagIndexingRuleUpdateRequest body) throws ApiException Partially update a tag indexing rule. Fields omitted from the request body are left unchanged. Settingrule_orderto a value already used by another rule returns 409; use the reorder endpoint for atomic re-sequencing. Requires theManage Tags for Metricspermission.- Parameters:
id- ID of the tag indexing rule. (required)body- (required)- Returns:
- ApiResponse<TagIndexingRuleResponse>
- 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 - 404 Not Found - 409 Conflict - 429 Too Many Requests -
-
updateTagIndexingRuleWithHttpInfoAsync
public CompletableFuture<ApiResponse<TagIndexingRuleResponse>> updateTagIndexingRuleWithHttpInfoAsync(String id, TagIndexingRuleUpdateRequest body) Update a tag indexing rule.- Parameters:
id- ID of the tag indexing rule. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<TagIndexingRuleResponse>>
-