GET/desk/api/v2/reportexports.json

Get a paginated list of reportexports.

The following values are allowed in the filter query parameter:

  • id
  • key
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state

The following values are allowed in the orderBy query parameter:

  • id
  • key
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ReportExportsAPIBody handles the listing response for reportexport.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

ReportExportsAPIBody
{
  "included": {
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2024-04-23T10:49:44.900Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-04-23T10:49:44.900Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "editMethod": "string",
        "email": "string",
        "filter_args": {
          "aggregate": {
            "Distinct": true,
            "Field": "string",
            "Operation": "string"
          },
          "bulkDryExecute": true,
          "fields": [
            "string"
          ],
          "filter": [
            "string"
          ],
          "id": 0,
          "ids": [
            0
          ],
          "includes": [
            "string"
          ],
          "orderBy": "string",
          "orderMode": "asc",
          "page": 0,
          "pageOffset": 0,
          "pageSize": 0,
          "skipAggregation": true
        },
        "firstName": "string",
        "id": 0,
        "isAppOwner": true,
        "isPartTime": true,
        "lastName": "string",
        "ldKey": "string",
        "onboarding": {
          "addedFirstInbox": true,
          "bookmarkPage": true,
          "checkDeskHelpSite": true,
          "checkSampleInbox": true,
          "dismissedWelcome": true,
          "exploreHelpsites": true,
          "exploreReports": true,
          "inviteTeam": true,
          "repliedToFirstTicket": true,
          "reviewedCompanySettings": true,
          "reviewedProfile": true
        },
        "projectsCompanyId": 0,
        "reviewer": true,
        "role": "string",
        "sendPushNotifications": true,
        "sendWebNotifications": true,
        "state": "string",
        "ticketReplyRedirect": "string",
        "timeFormatId": 0,
        "timezoneId": 0,
        "trainingWheelsEnrollment": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "updatedAt": "2024-04-23T10:49:44.900Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      }
    ]
  },
  "meta": {
    "page": {
      "count": 0,
      "hasMore": true,
      "hasMorePages": true,
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "pages": 0,
      "records": 0
    }
  },
  "pagination": {
    "count": 0,
    "hasMore": true,
    "hasMorePages": true,
    "page": 0,
    "pageOffset": 0,
    "pageSize": 0,
    "pages": 0,
    "records": 0
  },
  "reportexports": [
    {
      "createdAt": "2024-04-23T10:49:44.900Z",
      "createdBy": {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      },
      "deletedAt": "2024-04-23T10:49:44.900Z",
      "deletedBy": {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      },
      "filter_args": {
        "aggregate": {
          "Distinct": true,
          "Field": "string",
          "Operation": "string"
        },
        "bulkDryExecute": true,
        "fields": [
          "string"
        ],
        "filter": [
          "string"
        ],
        "id": 0,
        "ids": [
          0
        ],
        "includes": [
          "string"
        ],
        "orderBy": "string",
        "orderMode": "asc",
        "page": 0,
        "pageOffset": 0,
        "pageSize": 0,
        "skipAggregation": true
      },
      "filters": {
        "agents": [
          0
        ],
        "companies": [
          0
        ],
        "customfields": [
          {
            "ID": 0,
            "Kind": "string",
            "Operation": "string",
            "Value": "string",
            "Values": [
              0
            ]
          }
        ],
        "excludeInboxes": [
          0
        ],
        "excludeTags": [
          0
        ],
        "export": {
          "fields": [
            "string"
          ],
          "perSecond": 0,
          "processed": 0,
          "total": 0
        },
        "inboxes": [
          0
        ],
        "includeArchivedAgents": true,
        "onlyUntagged": true,
        "orderBy": "string",
        "orderMode": "asc",
        "priorities": [
          0
        ],
        "sources": [
          0
        ],
        "statuses": [
          0
        ],
        "subjectKeywords": [
          "string"
        ],
        "tags": [
          0
        ],
        "types": [
          0
        ]
      },
      "id": 0,
      "key": "string",
      "state": "string",
      "updatedAt": "2024-04-23T10:49:44.900Z",
      "updatedBy": {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      }
    }
  ]
}