Skip to main content
DELETE
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
kpis
/
{kpi_id}
Delete KPI
const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/kpis/{kpi_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​
Delete KPI

Remove a KPI definition from a dataset. This only works if no values have been submitted for this KPI.
This action cannot be undone. If the KPI has submitted values, the API returns 409 Conflict.

​
Request

​
Headers

​
x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
​
x-organization-id
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

​
Path Parameters

​
dataset_id
string
required
UUID of the parent dataset
​
kpi_id
string
required
UUID of the KPI to delete

​
Response

Returns HTTP 204 No Content on success.

​
Example

curl -X DELETE "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/kpis/${KPI_ID}" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

​
Common Errors

​
401 Unauthorized

Cause: Missing or invalid API key 
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

​
403 Forbidden

Cause: The authenticated user is not a member of the organization 
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

​
404 Not Found

Cause: KPI not found 
{
  "detail": "KPI not found"
}

​
409 Conflict

Cause: KPI has submitted values The KPI has submitted values and cannot be deleted. 
{
  "detail": "KPI has submitted values"
}

Create KPI

Add a new KPI to the dataset

Get Dataset

View the dataset with all its KPIs