Reports

Get a report’s metadata

Everything needed to present a saved query as a form: title, description, which connection and database the numbers come from, the variables to fill in, and the chart configuration. Never returns the SQL, so this is the endpoint to use when a caller should be able to run a query without reading it. Scoped to the caller’s company and to their own or shared queries; anything else is a 404 rather than a 403, so the endpoint cannot be used to discover query ids. Available to API keys with the read scope.

get/queries/{id}/report

Request

  • Base URL: https://saturnsql.com/api
  • URL: https://saturnsql.com/api/queries/{id}/report
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring cuid required

Response

Report metadata

idstring
titlestring
descriptionstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.