Export table group

  • Updated on Sep 3, 2025
  • Published on Sep 2, 2025
Prev Next
Get
/table/group/{group_id}/export

Export a specific table group's data model

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters
group_id
stringRequired

Supermetrics table group ID

Query parameters
version
integerRequired
Responses
200

Table group data model exported successfully

Expand All
object
version
integer

Data model version

group
object (TableGroupExport)
group_id
string

Supermetrics table group ID

group_name
string

Table group name

ds_id
string

Data source ID

table_prefix
string

Prefix to table names. Enforced into upper snake case.

tables
Array of object (TableDefinition)

List of table objects

object
table_name
string

Table name. Enforced into upper snake case.

table_partition
string

Table partition. Either date or none.

Valid values[ "date", "none" ]
Default"date"
report_type
string | null

Data source report type. Required for some data sources.

fields
Array of string

List of field IDs for the table

string
fields
Array of object (FieldDefinition)

List of field objects

object
field_id
string

Field ID that appears in one of the table objects

field_name
string

Data source field name

display_name
string

Field display name

target_name
string

Field name in target table. Defaults to field ID in lower snake case.

data_type
string

Field data type

404

Requested table group was not found

object
error
string
Valid values[ "TABLE_GROUP_NOT_FOUND" ]
message
string
500

Failed to search for table groups

object
error
string
Valid values[ "TABLE_GROUP_SEARCH_FAILED" ]
message
string