> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get a data source schema > Introspects the live schema of a data source: queryable tables (or collections) with typed fields. ## OpenAPI ````yaml /en/openapi/v3-current/reporter.yaml get /v1/data-sources/{dataSourceId}/schema openapi: 3.1.0 info: contact: name: Discord community url: https://discord.gg/DnhqKwkGv3 description: >- This is OpenAPI documentation for Reporter. The unified reporter binary serves the REST API (RUN_MODE=api) and/or the RabbitMQ report-generation worker (RUN_MODE=worker); RUN_MODE=all runs both in one process for local development. All REST endpoints documented here serve only when RUN_MODE=api or all (port :4005); the worker (port :4006) exposes health/readyz/version only. license: name: Lerian Studio General License title: Midaz Reporter API version: 4.0.0 servers: - url: http://localhost:4005 - url: https://localhost:4005 security: - BearerAuth: [] tags: - description: Generated report instances and their lifecycle. name: Reports - description: Reusable report definitions. name: Templates - description: Interactive construction of report templates. name: Template Builder - description: Scheduled report due-date tracking. name: Deadlines - description: Configured inputs that feed report data. name: Data Sources - description: Aggregated reporting metrics. name: Metrics - description: Published business event catalog and delivery policies. name: Streaming paths: /v1/data-sources/{dataSourceId}/schema: get: tags: - Data Sources summary: Get a data source schema description: >- Introspects the live schema of a data source: queryable tables (or collections) with typed fields. operationId: getDataSourceSchema parameters: - description: Unique data source identifier. example: 00000000-0000-0000-0000-000000000000 in: path name: dataSourceId required: true schema: description: Unique data source identifier. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataSourceSchemaResult' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '412': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Precondition Failed '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error components: schemas: DataSourceSchemaResult: properties: configName: description: Stable business key referenced by templates. examples: - midaz_onboarding type: string databaseName: description: Database name. examples: - onboarding type: string id: description: Unique data source identifier. examples: - 00000000-0000-0000-0000-000000000000 type: string tables: description: Queryable tables or collections with typed fields. items: $ref: '#/components/schemas/SchemaTable' type: - array - 'null' type: description: Data source engine type. examples: - postgresql type: string type: object Detail: properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details examples: - - location: body.templateId message: expected string to match 'uuid' format value: not-a-uuid items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object SchemaTable: properties: fields: items: $ref: '#/components/schemas/SchemaField' type: - array - 'null' name: type: string schema: type: string type: object ErrorDetail: properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' examples: - body.templateId type: string message: description: Error message text examples: - expected string to match 'uuid' format type: string value: description: The value at the given location examples: - not-a-uuid type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object SchemaField: properties: family: description: >- What the declared type holds, in one vocabulary for every engine: date (a day, a clock and a zone), date_without_zone (a day and a clock and no zone), day (a day and no clock at all — PostgreSQL's date), time (a clock reading with no day and no zone in it), time_with_zone (a clock reading carrying its own UTC offset), duration (a length of time), number, boolean, string, object, array, or unknown. A family names which parts of a written value the field holds, and a bound must state exactly those: a day field reduces a bound naming a clock to its day, so offer a day-granularity control there; a field keeping no zone (date_without_zone, day, time) discards a stated UTC offset and the bound is refused instead; a time_with_zone field resolves a bound stating none in the data source's session zone and so requires one; and only a zone-keeping field is compared on the report calendar. A type name cannot be read for any of this — read this rather than parsing type. examples: - time_with_zone type: string name: description: Field or column name, exactly as the data source spells it. examples: - hora_corte type: string type: description: Declared type in the data source's own vocabulary, for display. examples: - time without time zone type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````