APG PayAPG Paydocs

Reporting

Get report dashboard

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

Return one dashboard the caller can read, with the tiles it may read.

Permissions

Required permission
reports:query

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

Path parameters

reportDashboardIdstring
required

Responses

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

Discriminated by type
type = "RdshViewAttributes"
reportDashboardIdRdshIdrequired

Identifier of a saved dashboard.

Example rdsh_9f2Kd8QpLzXw

reportSpaceIdRspcIdrequired

Identifier of a report space.

Example rspc_9f2Kd8QpLzXw

titlestringrequired
descriptionstring

What the dashboard is for, shown under its title.

Where each chart sits. A reader is shown the tiles whose charts it may read, and no others; a layout it writes keeps the tiles it was not shown.

What the dashboard opens filtered by.

accessRspcAccessrequired
PrivateSharedSystemUnknown
ownedByCallerbooleanrequired

Example true

editablebooleanrequired

Whether the caller may change, move or delete it.

Example true

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses