Skip to main content
DELETE
/
business_metrics
/
{business_metric_token}
/
values
Delete business metric values
curl --request DELETE \
  --url https://api.vantage.sh/v2/business_metrics/{business_metric_token}/values \
  --header 'Authorization: Bearer <token>'
{
  "deleted_count": 120
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
business_metric_token
string
required

Query Parameters

​
start_date
string

Inclusive lower bound (ISO 8601 date or datetime, UTC). Date-only values start at 00:00:00 UTC that day.

​
end_date
string

Inclusive upper bound (ISO 8601 date or datetime, UTC). Date-only values include the full calendar day through 23:59:59.999999999 UTC.

​
label
string

When present in the query string (including as an empty value), only unit metrics with this exact label are deleted. Omit the parameter to delete all labels in range.

​
forecasted
boolean
default:false

When true, deletes forecasted unit metrics instead of historical ones.

Response

BusinessMetricValuesDeleteResponse model

​
deleted_count
integer<int32>
required

Number of unit metric rows removed.

Example:

120