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
Max length50
Pattern^[A-Za-z0-9_-]+$
Query parameters
version
integer (int32) Required
Minimum1
Maximum100
Responses
200
Table group data model exported successfully
Headers
Content-Type
string
HTTP response content type
Valid values[
"application/json"
]
Max length255
Exampleapplication/json
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example100
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example49
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
version
integer (int32)
Data model version
Minimum1
Maximum100
group
object (TableGroupExport)
group_id
string
Supermetrics table group ID
Max length50
group_name
string
Table group name
Max length255
ds_id
string
Data source ID
Max length50
table_prefix
string
Prefix to table names. Enforced into upper snake case.
Max length15
tables
Array of object (TableDefinition)
List of table objects
Max items1000
object
table_name
string
Table name. Enforced into upper snake case.
Max length255
table_partition
string
Table partition. Either date or none.
Valid values[
"date",
"none"
]
Max length50
Default"date"
report_type
string | null
Data source report type. Required for some data sources.
Max length255
fields
Array of string
List of field IDs for the table
Max items1000
string
Max length100
fields
Array of object (FieldDefinition)
List of field objects
Max items10000
object
field_id
string
Field ID that appears in one of the table objects
Max length100
field_name
string
Data source field name
Max length255
display_name
string
Field display name
Max length255
target_name
string
Field name in target table. Defaults to field ID in lower snake case.
Max length255
data_type
string
Field data type
Max length100
401
Unauthorized - invalid or missing authentication
Headers
Content-Type
string
HTTP response content type
Valid values[
"application/json"
]
Max length255
Exampleapplication/json
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example100
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example49
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
meta
object (ResponseMeta)
request_id
string
API request ID
Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string
Error code
Max length100
ExampleACCESS_TOKEN_INVALID
message
string
Error message
Max length255
ExampleInvalid Access Token
description
string
Error description
Max length255
ExampleProvided access token is either missing, invalid or expired.
404
Table Group Not Found
Headers
Content-Type
string
HTTP response content type
Valid values[
"application/json"
]
Max length255
Exampleapplication/json
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example100
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example49
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
error
string
Valid values[
"TABLE_GROUP_NOT_FOUND"
]
Max length100
message
string
Max length255
422
Unprocessable Entity - request validation failed
Headers
Content-Type
string
HTTP response content type
Valid values[
"application/json"
]
Max length255
Exampleapplication/json
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example100
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example49
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
meta
object (ResponseMeta)
request_id
string
API request ID
Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string
Error code
Max length100
ExampleACCESS_TOKEN_INVALID
message
string
Error message
Max length255
ExampleInvalid Access Token
description
string
Error description
Max length255
ExampleProvided access token is either missing, invalid or expired.
429
Too Many Requests - rate limit exceeded
Headers
Content-Type
string
HTTP response content type
Valid values[
"application/json"
]
Max length255
Exampleapplication/json
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example100
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example49
Retry-After
integer
Number of seconds to wait before making another request
Minimum1
Maximum3600
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
meta
object (ResponseMeta)
request_id
string
API request ID
Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string
Error code
Max length100
ExampleACCESS_TOKEN_INVALID
message
string
Error message
Max length255
ExampleInvalid Access Token
description
string
Error description
Max length255
ExampleProvided access token is either missing, invalid or expired.
500
Table Group Search Failed
Headers
Content-Type
string
HTTP response content type
Valid values[
"application/json"
]
Max length255
Exampleapplication/json
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example100
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example49
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
error
string
Valid values[
"TABLE_GROUP_SEARCH_FAILED"
]
Max length100
message
string
Max length255