Skip to main content
DELETE
Permanently delete an embed from your data app. This will remove the embed and invalidate any associated guest tokens.
Endpoint Migration Notice: We’re transitioning to kebab-case endpoints. The new endpoint is /api/v2/data-app/embeds. The old endpoint /api/v2/dataApp/embeds will be deprecated soon. Please update your integrations to use the new endpoint format.
This action is irreversible. Once an embed configuration is deleted, all associated guest tokens will become invalid and embedded dashboards will stop working.

Endpoint Formats

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

string
required
Bearer token for API authentication. Use your API key from the data app.

Query Parameters

string
required
The unique identifier of the embed configuration to delete. Get this from the create embed response or list embeds API.
string
Optional parameter to also delete the associated dashboard along with the embed configuration. Set to "true" to enable dashboard deletion.
Destructive Operation: When set to "true", this will permanently delete the dashboard associated with this embed. This action cannot be undone.

Response

string
The ID of the deleted embed configuration for confirmation.
object
Error object returned only when the request fails. Not included in successful responses.

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 embedId is provided and valid
string
Missing or invalid data app - Check your API key and data app configuration
string
Unexpected failure - Internal server error occurred

HTTP Status Code Summary

Possible Errors

Usage Examples

Basic Deletion

Batch Deletion

Safe Deletion with Verification

Best Practices

Verify Before Delete

Always verify the embed exists before attempting deletion

Handle Errors

Implement proper error handling for failed deletions

Update Documentation

Update your integration documentation after deletions

Monitor Impact

Monitor for any broken embedded dashboards after deletion
Important: Deleting an embed configuration will invalidate all guest tokens associated with it and break any embedded dashboards using this configuration. Ensure you have updated your application before deletion.

Next Steps

Embed a Pre-built Dashboard/Metric

Create new embed configurations to replace deleted ones

List All Embeds

View all remaining embed configurations

Update an Embed

Modify existing embed configurations instead of deleting

Guest Token API

Generate new tokens for your updated configurations