Skip to main content
Loading...

API docs by

Get your Scheduled Reports

Request

Use this method to get a list of reports that the authenticated user has scheduled to be generated on a recurring basis.

Query
offsetinteger, >= 0

Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record

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
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:"-CREATED_DATE"
Items Enum:"REPORT_NAME""-REPORT_NAME""CREATED_DATE""-CREATED_DATE"
Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

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

List of records

Example:
[
  {
    "scheduledId": "fb85e943-39da-4d62-afcf-46ed1077ce60",
    "reportName": "voluptate",
    "scheduleType": "DAILY",
    "createdBy": "cupidatat dolore adipisicing quis",
    "createdDate": "3269-06-06T22:03:28.837Z",
    "lastAttemptedDate": "3699-07-10T06:45:56.312Z",
    "customerOrganizationId": 48422050,
    "status": "INACTIVE",
    "parameters": [],
    "reports": [],
    "period": "1_DAY",
    "forOrg": 43909627,
    "forUser": 12354,
    "lastModifiedBy": "john.doe",
    "lastModifiedDate": "2017-07-02T21:59:15.045Z",
    "numberOfFailedAttempts": 1
  },
  {
    "scheduledId": "37f5fa8f-5fe8-40b3-91db-627bc053432c",
    "reportName": "eiusmod ullamco ipsum pariatur laborum",
    "scheduleType": "QUARTERLY",
    "createdBy": "occaecat dolor consectetur",
    "createdDate": "3109-05-27T03:32:30.773Z",
    "lastAttemptedDate": "3115-06-07T03:13:50.038Z",
    "customerOrganizationId": 77997941,
    "status": "INACTIVE",
    "parameters": [ … ],
    "reports": [],
    "period": "7_DAYS"
  },
  {
    "scheduledId": "ca32d0c1-4eee-4dd6-8d29-1401d91ce2af",
    "reportName": "fugiat magna cupidatat",
    "scheduleType": "DAILY",
    "createdBy": "esse tempor sunt mollit aute",
    "createdDate": "4740-12-25T16:47:30.142Z",
    "lastAttemptedDate": "2223-10-26T12:30:20.003Z",
    "customerOrganizationId": 25319222,
    "status": "ACTIVE",
    "parameters": [ … ],
    "reports": [],
    "forOrg": 37814662,
    "forUser": 12354,
    "lastModifiedBy": "john.doe",
    "lastModifiedDate": "2017-07-02T21:59:15.045Z",
    "numberOfFailedAttempts": 0
  },
  {
    "scheduledId": "384ebadf-6cac-4258-9432-254d97a43edc",
    "reportName": "culpa qui enim quis ipsum",
    "scheduleType": "DAILY",
    "createdBy": "sint",
    "createdDate": "2054-06-06T17:58:19.383Z",
    "lastAttemptedDate": "2777-08-05T04:43:04.000Z",
    "customerOrganizationId": 3386629,
    "status": "ACTIVE",
    "parameters": [ … ],
    "reports": []
  }
]
pageobject(Page)
Example:
{
  "total": 54690858,
  "limit": 21446016,
  "offset": 60463582,
  "sorts": [
    "cupidatat",
    "dolor occaecat"
  ]
}
Response
{
  "data": [
    { … },
    { … },
    { … },
    { … }
  ],
  "page": {
    "total": 4,
    "limit": 5,
    "offset": 0,
    "sorts": [ … ]
  },
  "_links": {
    "self": { … },
    "next": { … },
    "prev": { … }
  }
}
Was this page helpful?