Skip to main content
DELETE
/
v1
/
custom-kpi-datasets
/
{dataset_id}
Delete Dataset
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}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Delete Dataset

Delete a custom KPI dataset and all its KPI definitions. This only works if no campaign values have been submitted for this dataset.
This action cannot be undone. If the dataset has submitted values, the API returns 409 Conflict — lock the dataset’s campaigns instead of deleting.

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 dataset to deleteExample: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Returns HTTP 204 No Content on success.

Example

curl -X DELETE "https://api.dcycle.io/v1/custom-kpi-datasets/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -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: Dataset not found
{
  "detail": "Dataset not found"
}

409 Conflict

Cause: Dataset has submitted values — lock instead of deleting The dataset has submitted campaign values and cannot be deleted.
{
  "detail": "Dataset has submitted values — lock instead of deleting"
}

List Datasets

View all datasets

Create Dataset

Create a new dataset