Skip to main content
DELETE
https://sandbox.getcollate.io/api
/
v1
/
charts
/
{id}
DELETE /v1/charts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Charts

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Soft delete by ID
Charts.delete("2dde4b53-a577-424b-bbaa-18ac32eca8a9")

# Hard delete
Charts.delete(
    "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
    hard_delete=True
)

# Delete by name
Charts.delete_by_name("sample_superset.114")

# Delete by name with options
Charts.delete_by_name(
    "sample_superset.114",
    hard_delete=True
)

# Restore a soft-deleted chart
Charts.restore("2dde4b53-a577-424b-bbaa-18ac32eca8a9")

{
  "id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
  "name": "114",
  "displayName": "# of Games That Hit 100k in Sales By Release Year",
  "fullyQualifiedName": "sample_superset.114",
  "chartType": "Other",
  "version": 0.2,
  "updatedAt": 1769982666218,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/explore/?slice_id=114",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset"
  },
  "serviceType": "Superset",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Delete a Chart

Delete a chart by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

​
Delete by ID

​
id
string
required
UUID of the chart to delete.
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the chart. If false, the chart is soft-deleted and can be restored.

​
Delete by Name

Use DELETE /v1/charts/name/{fqn} to delete by fully qualified name.
​
fqn
string
required
Fully qualified name of the chart (e.g., sample_superset.114).
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the chart.

​
Restore a Soft-Deleted Chart

Use PUT /v1/charts/restore to restore a soft-deleted chart.
​
id
string
required
UUID of the soft-deleted chart to restore.
DELETE /v1/charts/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Charts

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Soft delete by ID
Charts.delete("2dde4b53-a577-424b-bbaa-18ac32eca8a9")

# Hard delete
Charts.delete(
    "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
    hard_delete=True
)

# Delete by name
Charts.delete_by_name("sample_superset.114")

# Delete by name with options
Charts.delete_by_name(
    "sample_superset.114",
    hard_delete=True
)

# Restore a soft-deleted chart
Charts.restore("2dde4b53-a577-424b-bbaa-18ac32eca8a9")

{
  "id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
  "name": "114",
  "displayName": "# of Games That Hit 100k in Sales By Release Year",
  "fullyQualifiedName": "sample_superset.114",
  "chartType": "Other",
  "version": 0.2,
  "updatedAt": 1769982666218,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/explore/?slice_id=114",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset"
  },
  "serviceType": "Superset",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Returns

Soft delete returns the chart object with deleted: true. Hard delete returns no content (204). Restore returns the restored chart object.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to delete this chart
404NOT_FOUNDChart with given ID or FQN does not exist