Initiate a batch deletion of metric values

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description#

Batch delete the given metric values.

For each value, provide either the id or both the reportingPeriod and coordinates (if any). If both are provided, the given id will be used.

POST /prototype/platform/programs/{programId}/metrics/{metricId}/values/batchDeletion

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
programId	path	string	true	The unique identifier of the program
metricId	path	string	true	The unique identifier of the metric
body	body	MetricValueIdentifier	true	The metric values to delete

Body parameter example#

{
  "data": [
    {
      "coordinates": {
        "b38353ce-32bc-4ea7-852a-bf5e12b72d95": "Ames, IA"
      },
      "reportingPeriod": {
        "end": 12,
        "start": 1,
        "year": 2024
      }
    }
  ]
}

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values/batchDeletion \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values/batchDeletion \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values/batchDeletion" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values/batchDeletion', headers = headers)