Skip to main content
GET
/
v1
/
deployments
/
{deploymentId}
/
reports
List reports
curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "name": "<string>",
      "publicId": "<string>",
      "refreshedByUser": {
        "email": "<string>",
        "id": 123,
        "firstName": "<string>",
        "picture": "<string>"
      },
      "updatedAt": "2023-12-25",
      "user": {
        "email": "<string>",
        "id": 123,
        "firstName": "<string>",
        "picture": "<string>"
      },
      "userId": 123,
      "createdBy": 123,
      "description": "<string>",
      "endResultCell": "<string>",
      "externalWorkbookId": "<string>",
      "folderId": 123,
      "jsonQuery": "<string>",
      "meta": {},
      "pivotItems": {
        "columns": [
          "<string>"
        ],
        "filters": [
          "<string>"
        ],
        "measures": [
          "<string>"
        ],
        "rows": [
          "<string>"
        ]
      },
      "refreshedBy": 123,
      "resultLocation": "<string>",
      "rolesWithAccess": [
        {
          "actions": [],
          "id": 123,
          "name": "<string>"
        }
      ],
      "sqlQuery": "<string>",
      "title": "<string>",
      "version": 123,
      "workbookId": 123
    }
  ],
  "items": [
    {
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "name": "<string>",
      "publicId": "<string>",
      "refreshedByUser": {
        "email": "<string>",
        "id": 123,
        "firstName": "<string>",
        "picture": "<string>"
      },
      "updatedAt": "2023-12-25",
      "user": {
        "email": "<string>",
        "id": 123,
        "firstName": "<string>",
        "picture": "<string>"
      },
      "userId": 123,
      "createdBy": 123,
      "description": "<string>",
      "endResultCell": "<string>",
      "externalWorkbookId": "<string>",
      "folderId": 123,
      "jsonQuery": "<string>",
      "meta": {},
      "pivotItems": {
        "columns": [
          "<string>"
        ],
        "filters": [
          "<string>"
        ],
        "measures": [
          "<string>"
        ],
        "rows": [
          "<string>"
        ]
      },
      "refreshedBy": 123,
      "resultLocation": "<string>",
      "rolesWithAccess": [
        {
          "actions": [],
          "id": 123,
          "name": "<string>"
        }
      ],
      "sqlQuery": "<string>",
      "title": "<string>",
      "version": 123,
      "workbookId": 123
    }
  ],
  "count": 1,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}
List the reports in a deployment, scoped to the reports the calling user can access. Results are returned in pages using cursor-based pagination: pass first to set the page size and after (the previous response’s pageInfo.endCursor) to fetch the next page. Cursor pagination is not supported when sorting by lastViewedAt (a per-viewer sort with no stable cursor column).

Authorizations

​
Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

​
deploymentId
number
required

Query Parameters

​
workbookId
integer | null
​
limit
integer | null
​
page
integer | null
​
sortBy
enum<string> | null
Available options:
name,
createdAt,
updatedAt,
lastViewedAt
​
sortDirection
enum<string> | null
Available options:
ASC,
DESC
​
after
string
​
first
integer
Required range: x >= 1

Response

200 - application/json
​
data
object[]
required
deprecated

Deprecated: use items instead. Kept for backward compatibility.

​
items
object[]
required
​
count
integer | null
deprecated

Deprecated: total number of accessible reports, ignoring pagination. Kept for backward compatibility.

Required range: x >= 0
​
pageInfo
object