Skip to content

customReports

Retrieves reports created by users with pagination support.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last Int Returns the last n elements from the list.
before String An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
filter CustomReportsFilter Filter criteria for custom reports.
sortBy CustomReportSortByField Field used to sort custom reports.
sortOrder SortOrder Sort order (ascending or descending).

Returns

CustomReportInfoConnection!

Sample

query {
  customReports(first: 10) {
    nodes {
      createdAt
      createdBy
      description
      id
      name
      reportCategory
      reportViewType
      room
      scheduledReportsCount
      updatedAt
      updatedBy
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{}

{
  "data": {
    "customReports": {
      "nodes": [
        [
          {
            "createdAt": "2024-01-01T00:00:00.000Z",
            "createdBy": "example-string",
            "description": "example-string",
            "id": 0,
            "name": "example-string",
            "reportCategory": "AUDIT_AND_COMPLIANCE"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}