APG PayAPG Paydocs

Reporting

Get report range

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

Return one named time range, by its name.

Permissions

Required permission
reports:query

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

Path parameters

reportRangeIdstring
required

Responses

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

Discriminated by type
type = "RrngAttributes"
reportRangeIdstringrequired

The range's name, which is also its id, such as last_30_days. It never changes, so a link or a saved filter can name it.

labelstringrequired

How the range reads inside a sentence, such as the last 30 days; a picker capitalises it.

groupRrngGrouprequired

Where a picker lists it. The list is in display order, each group's ranges together.

DayRollingCalendarAllTimeUnknown

The range a question asks with it. Absent for all_time, which asks with no time slice.

maxDaysinteger (int32)

The most local days the range can span, to hold against a grain's RdsetRuleMaxRange before asking. Absent for all_time.

Example 1250

periodGrainstring

The grain the range is one whole period of, such as month for this_month, so its answer can be a single figure. Absent for a range of several periods.

Example
{
  "type": "RrngAttributes",
  "reportRangeId": "string",
  "label": "string",
  "group": "Day",
  "range": {
    "type": "RqryRangeBetween",
    "from": "2026-08-19",
    "to": "2026-08-19"
  },
  "maxDays": 1250,
  "periodGrain": "string"
}

Error responses