Environment

get

Export the full environment configuration including models, relationships, metrics, glossary terms, and AI analysts. Supports filtering by entity type and output format.

Authorizations
AuthorizationstringRequired

API key obtained from Settings > API Keys. Pass as: Authorization: Bearer

Query parameters
entitiesstringOptional

Comma-separated list of entity types to include. Valid values: models, relationships, metrics, glossary, ai_analysts. Defaults to all.

Example: models,relationships,metrics,glossary,ai_analysts
formatstring Β· enumOptional

Output format. Defaults to json.

Default: jsonPossible values:
Responses
chevron-right
200

Environment export

application/json
versionstringOptionalExample: 1.0
exported_atstring Β· date-timeOptional
modelsobject[]Optional

Models with dimensions, measures, filters, and grain

relationshipsobject[]Optional

Relationships between models

metricsobject[]Optional

Defined metrics with expressions and joins

glossaryobject[]Optional

Glossary terms with definitions and mappings

ai_analystsobject[]Optional

AI analysts with semantic layer access configuration

get
/api/public/v1/environment
put

Sync (upsert) the environment configuration from a JSON payload. Supports models, relationships, metrics, glossary terms, and AI analysts. Only include the entity types you want to sync β€” omitted types are left untouched. Blocks if any referenced data source does not exist.

Authorizations
AuthorizationstringRequired

API key obtained from Settings > API Keys. Pass as: Authorization: Bearer

Body
modelsobject[]Optional

Models to create or update (matched by name)

relationshipsobject[]Optional

Relationships between models

metricsobject[]Optional

Metrics to create or update (matched by name)

glossaryobject[]Optional

Glossary terms to create or update (matched by term)

ai_analystsobject[]Optional

AI analysts to create or update (matched by name)

orphanedstring Β· enumOptional

What to do with existing entities not present in the payload. "delete" removes them, "keep" (default) leaves them.

Default: keepPossible values:
Responses
chevron-right
200

Sync summary

application/json
createdintegerOptional

Number of entities created

updatedintegerOptional

Number of entities updated

deletedintegerOptional

Number of orphaned entities deleted (0 if orphaned=keep)

unchangedintegerOptional

Number of entities that were already up to date

put
/api/public/v1/environment

Last updated

Was this helpful?