Dashboard v3 Template Admin

Read a template file without importing it

What the file declares: the template it is, the columns it needs, whether it carries example data, whether it carries the template's card image, and — the reason this is a separate call — whether the catalog already has it. Uploading a template that already exists updates it in place rather than adding a second copy, and someone has to be told that before they commit rather than after. A file carrying NO data also comes back with dataset_names — this workspace's datasets, so the name it has to be bound to can be completed rather than guessed. Writes nothing.

post/dashboards/v3/templates/admin/inspect

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/v3/templates/admin/inspect
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Response

What the uploaded template file contains

slugstring required
titlestring required
formatstring required
includes_databoolean required
has_thumbnailboolean
data_namestring nullable
needsobject[]
missingstring[] nullable
existsboolean
unchangedboolean
data_changedboolean
current_datasetstring nullable
dataset_namesstring[]

Changes

No recorded changes to this operation across all 4 revisions of this API.