Get a JSON representation of a data model (Beta)

This endpoint returns a representation of an existing data model, including metadata and contents. The response is a nested JSON object representing the data model's pages, elements, columns, sources, and more. The representation can be used to store, copy, or modify the data model programmatically.

For more information on managing data models via the Sigma API, see Create and manage data models from code. For more information on using this endpoint, including an end-to-end example, see Get the JSON representation of a data model.

Usage notes

• Retrieve the dataModelId by calling the /v2/dataModels endpoint. Invalid or nonexistent IDs return an error.
• The response includes the data sources, metadata, and relationships necessary to recreate the data model. The data itself is not included in the response.
• To create a new data model from the representation, use the /v2/dataModels/spec endpoint.

Usage scenarios

• Version control: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants.
• Administration: Administrators can use this endpoint to programmatically analyze and govern data models across an organization.
• Migration: Administrators can use this endpoint to programmatically migrate data models between organizations or tenants.