Get report type schema

get

https://api.extole.io/v6/report-types/{id}/schema

Returns the schema a report type produces - the ordered columns that appear in its output. For report types with preconfigured columns, these are the report type's preview columns. Use this to discover a report type's output shape without running the report.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Schema the report type produces, as an ordered, non-empty list of output columns.

400The request cannot be fulfilled. Either the report type id is missing from the request (report_type_missing), or the report type exists but does not support a schema because it has no preview columns (report_type_schema_not_supported) - inspect the response code field for the specific error.

401Unauthorized

402Payment Required

403Forbidden

404Report type was not found. The supplied id does not match any report type accessible to the calling client.

415Unsupported Media Type

429Too Many Requests