Get a report manifest

Everything a viewer needs to render one report, addressed by its path in the package, including its extension, exactly as list-reports gives it (sales/q3.malloy). A .malloy report, of either layout, carries the manifest fields (tiles or query, dashboardColumns, startingGivens, autorun, givens): its tiles run through the model query endpoint with givens, using path as the model. A .malloynb, the one cell format left, carries notebook instead: its cells, each run through the model query endpoint, its text as query.

GET/environments/{environmentName}/packages/{packageName}/reports/{path}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

environmentName*string

Name of the environment

Match^[a-zA-Z0-9_-]+$
packageName*string

Name of the package

Match^[a-zA-Z0-9_-]+$
path*string

The report's path within the package, including .malloy (or .malloynb): the path list-reports returns.

Query Parameters

versionId?string

The published version of the package to serve, a semantic version such as 1.2.0 or 1.2.0-rc1. latest, omitted or empty (versionId=, which a proxy forwarding a page's query string may send), the request is served from the package's latest version.

Any other value that is not a semantic version answers 400 with reason VERSION_ID_INVALID, so a malformed value is told apart from a missing version. An unknown version answers 404 with reason VERSION_NOT_FOUND, and an archived one answers 410 with reason VERSION_ARCHIVED. A package that has no versions (one loaded from publisher.config.json or registered from a directory) is served as before when this is omitted, and answers 404 VERSION_NOT_FOUND when it is given.

Build metadata must be percent-encoded: send 1.2.0+build.5 as 1.2.0%2Bbuild.5, since a bare + in a query string decodes to a space.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json