APG PayAPG Paydocs

Reporting

Create report pins

POST/report-pins

Pin a dashboard the caller can read.

Permissions

Required permission
reports:query

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

Request body

This body is a tagged shape: type is always "RpinCmdCreate". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "RpinCmdCreate"
reportDashboardIdRdshIdrequired

Identifier of a saved dashboard.

Example rdsh_9f2Kd8QpLzXw

positioninteger (int32)

Its place in the list, from 0. Absent for the end.

Example 1250

curl -X POST https://api.tst.au.apgpay.dev/report-pins \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RpinCmdCreate",
  "reportDashboardId": "rdsh_9f2Kd8QpLzXw",
  "position": 1250
}'

Responses

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

Discriminated by type
type = "RpinCreateRspAttributes"

The resource that was created.

Example
{
  "type": "RpinCreateRspAttributes",
  "created": {
    "type": "RpinViewAttributes",
    "reportPinId": "rpin_9f2Kd8QpLzXw",
    "reportDashboardId": "rdsh_9f2Kd8QpLzXw",
    "position": 1250,
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses