STsteep
reports

GET /v1/reports

List reports in the workspace (metadata only, not content). Filter by creator, sharing, team, or metric; page with limit and skip. For keyword search use search reports; for full content use get report by id.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

limitinteger

Maximum number of reports to return.

skipinteger

Number of reports to skip, for paging.

createdBystring

Only reports created by this user. Pass a workspace member's user id from list workspace members, or the literal me for the calling user (me requires a user token).

sharedWithstring

Only reports shared directly with this user, excluding reports they created. Pass a workspace member's user id from list workspace members, or the literal me for the calling user (me requires a user token). Cannot be combined with teamId.

teamIdstring

Only reports shared with this team. Cannot be combined with sharedWith.

metricIdstring

Only reports whose blocks reference this metric (chart, table, big-number or map blocks). Pass a metric id from list metrics, search metrics, or get metric by id. Use to find which reports reference a given metric.

sort'createdAt' | 'updatedAt'

Field to sort by.

order'asc' | 'desc'

Sort direction.

Response

Response for status 200

totalnumber required
limitnumber required
skipnumber required

Changes

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