APG PayAPG Paydocs

Reporting

List report dataset dimension values

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

Find the values a dimension can be filtered to, a page at a time. q is the search text, required for a Search lookup. The values page by cursor in a fixed order: a lookup searched by name in name order, a declared list in its declared order, anything else in its values' order. Pass nextStartingAfter back as startingAfter for the next page; hasMore says whether one follows. A cursor continues only the walk that issued it, the same dimension and q, and is refused with 400 otherwise. The walk is forward only, so endingBefore and page are refused with 400. A listed dimension's page is its declaration's, which the caller may keep for five minutes (Cache-Control: private, max-age=300); a searched or referenced one is read from the data each time and carries no Cache-Control.

Permissions

Required permission
reports:query

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

Path parameters

reportDatasetIdstring
required

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.

dimensionstring
required

The dimension to list values of. Required.

Responses

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

Discriminated by type
type = "RdsetValuePageAttributes"
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": "RdsetValuePageAttributes",
  "data": [
    {
      "type": "RdsetValueAttributes",
      "value": "string",
      "label": "string"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses