Report Schedule
Report Schedule call is used to fetch the report schedules for a logged-in user from the Mojo Server or the Arista Cloud Services. The types of report schedules that can be fetched are onetimereportschedule and recurringreportschedule. Based on the parameters passed, this API call can be used to fetch -all the schedules available to the logged in user at the top-most location that the user has access to, a specified schedule, all the schedules for a specified report, all the schedules for a specified location, and all the schedules for a specified report and location.
/V5/reports/schedules
/V5/reports/schedules/location
/V5/reports/schedule/{scheduleid}
/V5/reports/schedules/{reportid}
/V5/reports/schedule/report/{reportid}
/V5/reports/schedule
<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}
/V5/reports/schedule
/V5/reports/schedule/{scheduleid}
Attribute | Data Type | Description |
---|---|---|
type | String | Report type. The applicable values are recurringreportschedule and onetimereportschedule. |
scheduleId | int | System-generated ID of this schedule that can be used to retrieve, modify, delete the schedule. |
recipients | application/json | Recipients who will receive the report via email. |
recipients/userId | int | System-generated ID of the user who will receive this report via email. |
recipients/emailAddress | String | Email address of a user not added to the system. |
deleteAfterDays | int | The days after which the archived report will be deleted. |
archivalStatus | boolean | True or false value indicating whether the report is to be archived. |
zipBeforeEmail | boolean | True or false value indicating whether the report must be zipped (compressed) before sending it via email. |
locationId | JSON for LocationId | LocationId at which the report is generated. For complete details about the JSON, click Location ID. |
userId | int | System-generated ID of the user who added the schedule. |
reportId | int | System-generated ID of the report. |
format | String | The format in which the report is generated. The applicable values are PDF, XML, and HTML. |
langId | int | System-generated ID of the language in which the report is to be generated. |
startScheduleDateTime | long | The schedule start time in milliseconds. Applicable only when the report schedule type is recurringreportschedule. |
endScheduleDateTime | long | The schedule stop time in milliseconds. Applicable only when the report schedule type is recurringreportschedule. |
scheduleFrequencyValue | int | Number of hours/days/months after which this report must be generated and delivered. Applicable only when the report schedule type is recurringreportschedule. |
scheduleFrequencyUnit | String | The schedule frequency unit. The applicable values are HOURS, DAYS, and MONTHS. Applicable only when the report schedule type is recurringreportschedule. |
reportTimePeriodValue | int | The number of hours/days/months of data that the report must contain. Applicable only when the report schedule type is recurringreportschedule. |
reportTimePeriodUnit | String | The time period unit in which the report will be generated. The applicable values are HOURS, DAYS, and MONTHS. Applicable only when the report schedule type is recurringreportschedule. |
deliveryTime | long | The time when the report is to be delivered. Applicable only when the report schedule type is onetimereportschedule. |
fromDateTime | long | Data starting from this time will be available in the report. The time unit is milliseconds. Applicable only when the report schedule type is onetimereportschedule. |
toDateTime | long | Data till this time will be available in the report. The time unit is milliseconds. Applicable only when the report schedule type is onetimereportschedule. |
oneTimeReportPeriodType | String | The reporting period type. The applicable values are FIXED and CUSTOM. If set to FIXED, then values for fromDateTime and toDateTime must be specified. If set to CUSTOM, then values for oneTimeReportPeriodValue and oneTimeReportPeriodUnit must be specified. Applicable only when the report schedule type is onetimereportschedule. |
oneTimeReportPeriodValue | int | The number of hours/days/months of data that the report must contain. Applicable only when the report schedule type is onetimereportschedule. |
oneTimeReportPeriodUnit | String | The time period unit in which the report will be generated. The applicable values are HOURS, DAYS, and MONTHS. Applicable only when the report schedule type is onetimereportschedule. |
[ { "type": "recurringreportschedule", "scheduleId": 3, "recipients": [ { "userId": 1, "emailAddress": "[email protected]" } ], "deleteAfterDays": -1, "archivalStatus": false, "zipBeforeEmail": false, "locationId": { "type": "locallocationid", "id": 0 }, "userId": 1, "reportId": 21, "format": "XML", "langId": 0, "startScheduleDateTime": 1518633000000, "endScheduleDateTime": 1519324200000, "scheduleFrequencyValue": 1, "scheduleFrequencyUnit": "HOURS", "reportTimePeriodValue": 1, "reportTimePeriodUnit": "HOURS" }, { "type": "onetimereportschedule", "scheduleId": 2, "recipients": [ { "userId": 1, "emailAddress": "[email protected]" } ], "deleteAfterDays": -1, "archivalStatus": false, "zipBeforeEmail": false, "locationId": { "type": "locallocationid", "id": 0 }, "userId": 1, "reportId": 22, "format": "PDF", "langId": -2, "deliveryTime": 1518723000000, "fromDateTime": 0, "toDateTime": 0, "oneTimeReportPeriodType": "FIXED", "oneTimeReportPeriodValue": 6, "oneTimeReportPeriodUnit": "HOURS" }, { "type": "onetimereportschedule", "scheduleId": 4, "recipients": [ { "userId": 1, "emailAddress": "[email protected]" } ], "deleteAfterDays": -1, "archivalStatus": false, "zipBeforeEmail": false, "locationId": { "type": "locallocationid", "id": 0 }, "userId": 1, "reportId": 38, "format": "PDF", "langId": 0, "deliveryTime": 1518742140000, "fromDateTime": 0, "toDateTime": 0, "oneTimeReportPeriodType": "FIXED", "oneTimeReportPeriodValue": 1, "oneTimeReportPeriodUnit": "HOURS" } ]