APG PayAPG Paydocs

Reporting

Update report dashboard

PATCH/report-dashboards/{reportDashboardId}

Rename, move, lay out or set the presentation of a dashboard the caller may change. Changing one in a shared space needs Reports_Manage as well.

4 actionsRdshUpdateMoveRdshUpdateRenameRdshUpdateReplaceLayoutRdshUpdateSetPresentation

Permissions

Required permission
reports:query

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

Path parameters

reportDashboardIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "RdshUpdateMove"
reportSpaceIdRspcIdrequired

Identifier of a report space.

Example rspc_9f2Kd8QpLzXw

curl -X PATCH https://api.tst.au.apgpay.dev/report-dashboards/{reportDashboardId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RdshUpdateMove",
  "reportSpaceId": "rspc_9f2Kd8QpLzXw"
}'

Responses

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

Discriminated by type
type = "RdshUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "RdshUpdateRspAttributes",
  "updated": {
    "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