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));import requests
url = "https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/kpis/{kpi_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.delete(url, headers=headers)
print(response.text)curl --request DELETE \
--url https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/kpis/{kpi_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'Delete KPI
Delete a KPI definition from a dataset
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));import requests
url = "https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/kpis/{kpi_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.delete(url, headers=headers)
print(response.text)curl --request DELETE \
--url https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/kpis/{kpi_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'← Custom 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
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faPath Parameters
string
required
UUID of the parent dataset
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}"
import requests
import os
headers = {
"x-api-key": os.getenv("DCYCLE_API_KEY"),
"x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}
dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
kpi_id = "c3d4e5f6-a7b8-9012-cdef-123456789012"
response = requests.delete(
f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/kpis/{kpi_id}",
headers=headers,
)
if response.status_code == 204:
print("KPI deleted")
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
};
const datasetId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const kpiId = 'c3d4e5f6-a7b8-9012-cdef-123456789012';
axios.delete(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/kpis/${kpiId}`, { headers })
.then(() => console.log('KPI deleted'));
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"
}
Related Endpoints
Create KPI
Add a new KPI to the dataset
Get Dataset
View the dataset with all its KPIs
Was this page helpful?