APG PayAPG Paydocs

Reporting

List report dashboards

GET/report-dashboards
Request
GEThttps://api.tst.au.apgpay.dev/report-dashboards
curl -X GET https://api.tst.au.apgpay.dev/report-dashboards \
  -H "Authorization: Bearer $API_KEY"

Return a page of the dashboards the caller can read, in the order they were saved. q matches part of a title. Walk the pages by passing nextStartingAfter back as startingAfter; page and endingBefore are refused with 400.

Permissions

Required permission
reports:query

Requires the `query` action on `reports` for the supplied runtime context

Query parameters

qstring

Free-text search. Supplying it engages the search index; omit it to filter only.

startingAfterstring

Cursor pagination, forward only: the nextStartingAfter of the page before.

limitinteger (int32)

Maximum items per page.

columnsarray of RdshColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

reportSpaceIdstring

Only the dashboards saved in this space.

ownerstring

me for what the caller saved.

reportChartIdstring

Only the dashboards with a tile showing this chart, as deleting it would leave them.

Responses

The response is a tagged shape: type is always "RdshPageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "RdshPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "RdshPageAttributes",
  "data": [
    {
      "type": "RdshViewAttributes",
      "reportDashboardId": "rdsh_9f2Kd8QpLzXw",
      "reportSpaceId": "rspc_9f2Kd8QpLzXw",
      "title": "string",
      "description": "string",
      "layout": {
        "type": "RdshLayoutAttributes",
        "tabs": [
          {
            "type": "RdshTabAttributes",
            "tabId": "string",
            "title": "string"
          }
        ],
        "tiles": [
          {
            "type": "RdshTileAttributes",
            "reportChartId": "rcht_9f2Kd8QpLzXw",
            "tabId": "string",
            "x": 1250,
            "y": 1250,
            "w": 1250,
            "h": 1250,
            "click": {
              "type": "RdshTileClickSetsDimension",
              "dimension": "string"
            },
            "keepsOwnRange": true,
            "thresholds": [
              {
                "type": "RdshThresholdAttributes",
                "measure": "string",
                "comparison": "Above",
                "value": "string",
                "tone": "Danger"
              }
            ],
            "rowFilters": [
              {
                "type": "RdshRowFilterAttributes",
                "dimension": "string",
                "column": "string"
              }
            ]
          }
        ]
      },
      "filters": {
        "type": "RdshFiltersAttributes",
        "range": {
          "type": "RqryRangeBetween",
          "from": "2026-08-19",
          "to": "2026-08-19"
        },
        "timezone": "string",
        "dimensionFilters": [
          {
            "type": "RdshDimensionFilterAttributes",
            "dimension": "string",
            "operator": "Equals",
            "values": [
              "string"
            ],
            "fromTile": "string"
          }
        ],
        "periodClick": {
          "type": "RdshPeriodClickAttributes",
          "fromTile": "string",
          "range": {
            "type": "RqryRangeBetween",
            "from": "2026-08-19",
            "to": "2026-08-19"
          }
        }
      },
      "access": "Private",
      "tenant": {
        "type": "RspcTenantEnterprise",
        "enterpriseId": "ent_9f2Kd8QpLzXw"
      },
      "ownedByCaller": true,
      "editable": true,
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses