Endpoint Migration Notice: We’re transitioning to kebab-case endpoints. The new endpoint is
/api/v2/data-app/datamart
. The old endpoint /api/v2/dataApp/datamart
will be deprecated soon. Please update your integrations to use the new endpoint format.This action is irreversible. Once a datamart is deleted, all its data configurations and associated embed configurations will be permanently removed.
Endpoint Formats
- New Endpoint (Recommended)
- Legacy Endpoint (Deprecated Soon)
Authentication
All API requests must include your API key in the Authorization header. Get your API token when creating a data app - see our data app creation guide for details. Finding your API token: For detailed instructions, see the API Token guide.Headers
Bearer token for API authentication. Use your API key from the data app.
Query Parameters
The name of the datamart to delete. Must match an existing datamart name in your organization.
Response
The name of the deleted datamart for confirmation.
Error field, null when successful.
Examples
Legacy Endpoint Examples
The following examples use the deprecated POST endpoint. These are provided for reference only. Please use the DELETE endpoint examples above for all new integrations.
Error Codes
Invalid request body - Check that datamartName is provided and valid
Unexpected failure - Internal server error occurred
HTTP Status Code Summary
Status Code | Description |
---|---|
200 | OK - Datamart deleted successfully |
400 | Bad Request - Invalid request parameters or datamart not found |
401 | Unauthorized - Invalid or expired API token |
500 | Internal Server Error - Unexpected server error |
Possible Errors
Code | Message | HTTP Status |
---|---|---|
INVALID_REQUEST_BODY | Datamart not found | 400 |
INTERNAL_SERVER_ERROR | Unexpected failure | 500 |
Best Practices
Check Dependencies
Before deleting, verify no embed configurations depend on this datamart
Backup Data
Consider exporting important configurations before deletion
Test Environment
Test deletion process in a non-production environment first
Documentation
Document the deletion for audit and compliance purposes
Quick Start Guide
1
List your datamarts
First, see which datamarts you have available to identify the one to delete:
2
Check dependencies
Before deleting, ensure no embed configurations are using this datamart. Use the List Embeds API to verify.
3
Delete the datamart
Make the deletion request with the exact datamart name as a query parameter:
4
Update dependent configurations
Update any embed configurations that were using this datamart to reference a different datamart:
Critical: This action permanently deletes the datamart and cannot be undone. Ensure all dependent configurations are updated before deletion.