Create report dashboards
/report-dashboardsSave a dashboard, or a copy of one. Saving in a shared space needs Reports_Manage as well.
RdshCmdCopyRdshCmdCreatePermissions
reports:queryRequires the `query` action on `reports` for the supplied runtime context
Request body
This body is a typed union. Pick a variant to see its fields and a matching example.
typetype = "RdshCmdCopy"copyOfRdshIdrequiredThe dashboard to copy.
Example rdsh_9f2Kd8QpLzXw
reportSpaceIdRspcIdWhere to save the copy. Absent for the original's space, or for the caller's default space when the original is in the System space.
Example rspc_9f2Kd8QpLzXw
titlestringAbsent for the original's title with (copy) after it.
chartsRdshChartCopyingrequiredReferenceCopyUnknownonlyReportChartIdsarray of RchtIdCopy only the tiles showing these charts. Empty for every tile.
Example rcht_9f2Kd8QpLzXw
What the copy opens filtered by. Absent for the original's.
typeenumrequiredRdshFiltersAttributesReplaces every tile's range but those that keep their own. Absent to leave each tile's own.
typeFrom one date to another, both inclusive, in the question's timezone.
fromstring (date)requiredExample 2026-08-19
tostring (date)requiredExample 2026-08-19
The current period of grain so far.
grainstringrequiredThe last count whole periods of grain before the current one, ending where it starts.
countinteger (int32)requiredExample 42
grainstringrequiredFrom startsAt up to but not including endsAt, exactly: the first and last buckets are cut at the period's ends rather than widened to whole buckets, so a statement cycle that starts at 16:00 starts there. Buckets are still local time in the question's timezone.
periodstringA period the dataset declares in its periods, such as a statement cycle, or absent for bounds the caller names alone.
startsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
endsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
The whole period of grain before the current one.
grainstringrequiredtimezonestringAbsent to leave each tile's own timezone.
typeenumrequiredRdshDimensionFilterAttributesdimensionstringrequiredoperatorRdsetFilterOperatorHow it filters, one of the operators the dataset lists for the dimension. Absent for In, and a filter read back as In has none. In and NotIn take any number of values, Between two, Absent none, and every other one value.
EqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
valuesarray of stringfromTilestringThe tile a click set it from, which keeps showing every value so the others can be clicked: its chart's id, or <tabId>/<chart id> on a dashboard with tabs.
Absent unless range was set by clicking a trend tile.
typeenumrequiredRdshPeriodClickAttributesfromTilestringrequiredThe tile clicked: its chart's id, or <tabId>/<chart id> on a dashboard with tabs.
The dashboard's range before the click, which the tile clicked keeps. Absent where the dashboard had none, so the tile keeps its chart's own.
typeFrom one date to another, both inclusive, in the question's timezone.
fromstring (date)requiredExample 2026-08-19
tostring (date)requiredExample 2026-08-19
The current period of grain so far.
grainstringrequiredThe last count whole periods of grain before the current one, ending where it starts.
countinteger (int32)requiredExample 42
grainstringrequiredFrom startsAt up to but not including endsAt, exactly: the first and last buckets are cut at the period's ends rather than widened to whole buckets, so a statement cycle that starts at 16:00 starts there. Buckets are still local time in the question's timezone.
periodstringA period the dataset declares in its periods, such as a statement cycle, or absent for bounds the caller names alone.
startsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
endsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
The whole period of grain before the current one.
grainstringrequiredcurl -X POST https://api.tst.au.apgpay.dev/report-dashboards \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "RdshCmdCopy",
"copyOf": "rdsh_9f2Kd8QpLzXw",
"reportSpaceId": "rspc_9f2Kd8QpLzXw",
"title": "string",
"charts": "Reference",
"onlyReportChartIds": [
"rcht_9f2Kd8QpLzXw"
],
"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"
}
}
}
}'Responses
The response is a tagged shape: type is always "RdshCreateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "RdshCreateRspAttributes"The resource that was created.
typeenumrequiredRdshViewAttributesreportDashboardIdRdshIdrequiredIdentifier of a saved dashboard.
Example rdsh_9f2Kd8QpLzXw
reportSpaceIdRspcIdrequiredIdentifier of a report space.
Example rspc_9f2Kd8QpLzXw
titlestringrequireddescriptionstringWhat 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.
typeenumrequiredRdshLayoutAttributesEmpty for a dashboard of one page.
typeenumrequiredRdshTabAttributestabIdstringrequiredThe tab's own id within the dashboard, which its tiles name.
titlestringrequiredtypeenumrequiredRdshTileAttributesreportChartIdRchtIdrequiredIdentifier of a saved chart.
Example rcht_9f2Kd8QpLzXw
tabIdstringThe tab it is on. Absent on a dashboard without tabs, or for the first tab.
xinteger (int32)requiredThe column its left edge is in, from 0.
Example 1250
yinteger (int32)requiredThe row its top edge is in, from 0.
Example 1250
winteger (int32)requiredIts width, in columns of the 24.
Example 1250
hinteger (int32)requiredIts height, in rows.
Example 1250
typeFilters the dashboard by the value clicked.
dimensionstringrequiredSets the dashboard's period to the bucket clicked.
Sets the dashboard's period to the bucket clicked.
keepsOwnRangebooleanrequiredKeeps the chart's own range whatever period the dashboard is set to, as a year's trend beside a month's figures does.
Example true
Levels the tile's figures are shaded at. A figure takes the tone of the first it passes, so the more severe is listed first.
typeenumrequiredRdshThresholdAttributesmeasurestringThe measure it judges. Absent for the first measure the chart shows.
comparisonRdshThresholdComparisonrequiredAboveAtLeastBelowAtMostUnknownvaluestringrequiredThe level, written as a decimal.
toneRchtTonerequiredDangerWarningSuccessMutedUnknownHow the tile takes a dashboard filter on a dimension its chart cannot be asked by, such as a band: it keeps the rows whose column holds a value the filter picked.
typeenumrequiredRdshRowFilterAttributesdimensionstringrequiredThe dashboard filter's dimension.
columnstringrequiredThe answer's column whose value the filter's values are matched against.
What the dashboard opens filtered by.
typeenumrequiredRdshFiltersAttributesReplaces every tile's range but those that keep their own. Absent to leave each tile's own.
typeFrom one date to another, both inclusive, in the question's timezone.
fromstring (date)requiredExample 2026-08-19
tostring (date)requiredExample 2026-08-19
The current period of grain so far.
grainstringrequiredThe last count whole periods of grain before the current one, ending where it starts.
countinteger (int32)requiredExample 42
grainstringrequiredFrom startsAt up to but not including endsAt, exactly: the first and last buckets are cut at the period's ends rather than widened to whole buckets, so a statement cycle that starts at 16:00 starts there. Buckets are still local time in the question's timezone.
periodstringA period the dataset declares in its periods, such as a statement cycle, or absent for bounds the caller names alone.
startsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
endsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
The whole period of grain before the current one.
grainstringrequiredtimezonestringAbsent to leave each tile's own timezone.
typeenumrequiredRdshDimensionFilterAttributesdimensionstringrequiredoperatorRdsetFilterOperatorHow it filters, one of the operators the dataset lists for the dimension. Absent for In, and a filter read back as In has none. In and NotIn take any number of values, Between two, Absent none, and every other one value.
EqualsInNotEqualsNotInBetweenAbsentContainsAboveAtLeastBelow+2 moreShow fewer
AtMost, Unknown
valuesarray of stringfromTilestringThe tile a click set it from, which keeps showing every value so the others can be clicked: its chart's id, or <tabId>/<chart id> on a dashboard with tabs.
Absent unless range was set by clicking a trend tile.
typeenumrequiredRdshPeriodClickAttributesfromTilestringrequiredThe tile clicked: its chart's id, or <tabId>/<chart id> on a dashboard with tabs.
The dashboard's range before the click, which the tile clicked keeps. Absent where the dashboard had none, so the tile keeps its chart's own.
typeFrom one date to another, both inclusive, in the question's timezone.
fromstring (date)requiredExample 2026-08-19
tostring (date)requiredExample 2026-08-19
The current period of grain so far.
grainstringrequiredThe last count whole periods of grain before the current one, ending where it starts.
countinteger (int32)requiredExample 42
grainstringrequiredFrom startsAt up to but not including endsAt, exactly: the first and last buckets are cut at the period's ends rather than widened to whole buckets, so a statement cycle that starts at 16:00 starts there. Buckets are still local time in the question's timezone.
periodstringA period the dataset declares in its periods, such as a statement cycle, or absent for bounds the caller names alone.
startsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
endsAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
The whole period of grain before the current one.
grainstringrequiredaccessRspcAccessrequiredPrivateSharedSystemUnknowntypeThe tenant an item was saved under: the platform, or the enterprise, marketplace or merchant its saver signed in as.
enterpriseIdEntIdrequiredIdentifier of an enterprise.
Example ent_9f2Kd8QpLzXw
The tenant an item was saved under: the platform, or the enterprise, marketplace or merchant its saver signed in as.
marketplaceIdMktpIdrequiredIdentifier of a marketplace.
Example mktp_9f2Kd8QpLzXw
The tenant an item was saved under: the platform, or the enterprise, marketplace or merchant its saver signed in as.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
The platform, which no enterprise, marketplace or merchant bounds.
The platform, which no enterprise, marketplace or merchant bounds.
ownedByCallerbooleanrequiredExample true
editablebooleanrequiredWhether the caller may change, move or delete it.
Example true
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
{
"type": "RdshCreateRspAttributes",
"created": {
"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
statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}