Skip to main content
Loading...

API docs by

Get your generated reports

Request

Use this method to get a list of reports triggered for generation by the authenticated user.

Query
offsetinteger, >= 0

The start index from which the list is created.

Default:0
limitinteger, [ 0 .. 100 ]

Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response

Default:10
durationinteger, [ 1 .. 365 ]

Number of days since should reports be searched

Default:7
sortsArray of strings, unique

Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE' to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'

Default:"-GENERATED_DATE"
Items Enum:"REPORT_NAME""-REPORT_NAME""GENERATED_DATE""-GENERATED_DATE""REQUESTED_DATE""-REQUESTED_DATE"
statusesArray of strings, unique

List of statuses of reports to be searched.

Default:["IN_PROGRESS","SUCCESS","ERROR"]
Items Enum:"IN_PROGRESS""SUCCESS""ERROR"
Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
dataArray of objects, >= 0 items(DownloadableReport)required

List of records

Example:
[
  {
    "reportId": "0c1ba2a7-053c-4974-b4c1-ad22f5765f03",
    "status": "ERROR"
  },
  {
    "reportId": "c9f8029d-62b0-4a42-b1c9-cb924515f80e",
    "status": "IN_PROGRESS",
    "scheduledId": "69db9183-e9cc-4cd8-aaf8-d0aec8e64d07",
    "createdBy": "in est officia",
    "fileSize": 5997663,
    "requestedDate": "2389-02-21T23:38:54.744Z"
  },
  {
    "reportId": "0d63a95b-3649-49f3-9658-0cf637bf2e54",
    "status": "IN_PROGRESS",
    "requestedDate": "2386-09-09T17:54:06.104Z",
    "fileType": "XLS",
    "createdBy": "ullamco labor",
    "scheduledId": "b84a6bae-3b39-4aef-b6ea-dd3d30b78ef6"
  },
  {
    "reportId": "3190b044-8215-4fc7-a2cf-720bf7df7642",
    "status": "INACTIVE",
    "fileSize": 40635347,
    "createdBy": "eu minim",
    "reportName": "laborum sint aliqua occ",
    "fileType": "CSV"
  }
]
pageobject(Page)
Example:
{
  "total": 54690858,
  "limit": 21446016,
  "offset": 60463582,
  "sorts": [
    "cupidatat",
    "dolor occaecat"
  ]
}
Response
{
  "data": [
    { … },
    { … },
    { … }
  ],
  "page": {
    "total": 20393392,
    "limit": 12512897,
    "offset": 49505553,
    "sorts": [ … ]
  },
  "_links": {
    "self": { … },
    "next": { … }
  }
}
Was this page helpful?