Skip to main content
DELETE
Permanently delete a datamart from your organization. This will remove the datamart and all its associated configurations.
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

Authentication

This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:
  1. In Settings page, navigate to the Service Tokens section.
  2. Click the “Generate Token” button to create a new service token if you don’t have one already.
Use this token as the Bearer value in your Authorization header.

Headers

string
required
Bearer token for API authentication. Use your service token.

Query Parameters

string
required
The name of the datamart to delete. Must match an existing datamart name in your organization.

Response

string
The name of the deleted datamart for confirmation.
null
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

string
Invalid request body - Check that datamartName is provided and valid
string
Unexpected failure - Internal server error occurred

HTTP Status Code Summary

Possible Errors

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.

Next Steps

Create Datamart

Create a new datamart to replace the deleted one

List Datamarts

View all remaining datamarts in your organization

Embed a Pre-built Dashboard/Metric

Create new embed configurations for your remaining datamarts

Guest Token API

Generate tokens for your updated configurations