Catalog

List the published template catalog

Returns the published templates a report can be created from with /v1/reports/create-from-template, and whose sections a composition can copy. The catalog is the same for every account. With include_sections the entry also carries the 0-based position and the name of each of its sections -- what a catalog section of a composition names -- and the parameters a parameterized entry asks a value for. A parameterized entry can be materialized whole and cannot be used as a single section of a composition.

post/catalog/list

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/catalog/list
  • Auth: HTTP bearer

Request body

language'en' | 'es'

Language of the names and descriptions. Default en.

include_sectionsboolean

Add the sections and the parameters of every entry. Off by default because it costs a full read of each published version; turn it on when you are about to compose with a catalog section, because that is where its position comes from.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

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