Get report hidden dashboard

GET/report-hidden-dashboards/{reportHiddenDashboardId}

Request

GEThttps://api.tst.au.apgpay.dev/report-hidden-dashboards/{reportHiddenDashboardId}

curl -X GET https://api.tst.au.apgpay.dev/report-hidden-dashboards/{reportHiddenDashboardId} \
  -H "Authorization: Bearer $API_KEY"

Return one of the caller's hidden dashboards.

Permissions

Required permission

reports:query

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

Path parameters

reportHiddenDashboardIdstring

required

Responses

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

Discriminated by type

type = "RhidViewAttributes"

reportHiddenDashboardIdRhidIdrequired

Identifier of a dashboard the caller has hidden.

Example rhid_9f2Kd8QpLzXw

reportDashboardIdRdshIdrequired

Identifier of a saved dashboard.

Example rdsh_9f2Kd8QpLzXw

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example

{
  "type": "RhidViewAttributes",
  "reportHiddenDashboardId": "rhid_9f2Kd8QpLzXw",
  "reportDashboardId": "rdsh_9f2Kd8QpLzXw",
  "createdAt": "2026-08-19T04:21:07Z"
}

Error responses

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An 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.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}