get https://api.repsly.com/v3/export/visitrealizations?modified=&skip=
Endpoint is used to export your visits from Repsly. System limit is 50 rows.
More Info
The endpoint is used to export visit schedule realizations from Repsly. Visit schedule realizations contain data on the realized schedule (unless it was missed). It gives the viewer insight into the actual duration of the visit and the actions taken while at the scheduled place. Please define the modified and skip values to query the wanted period. The response is limited to the first 50 visit schedule realizations for that period.
Limitations:
- Skip value is limited to 9,500. Any value above that will return an error. To prevent this issue from occurring please update the modified parameter to a newer date to fetch the same data.
- Example: instead of using modified=2023-01-01 and skip 9651, set the modified date to 2023-03-01 and set the skip value to 0.
Response definition
| Name | Type | Description |
|---|---|---|
| MetaCollectionResult\TotalCount | Integer | Total count of client visits schedule realizations in the response |
| ScheduleId | Guid | Unique Id of the schedule |
| ProjectId | Guid | Unique Id of the project |
| EmployeeId | Guid | Unique Id of the employee (Representative that was scheduled to complete the visit) |
| EmployeeCode | String (20) | Unique code of the employee (Representative that was scheduled to complete the visit) |
| PlaceId | Guid | Unique Id of the place |
| PlaceCode | String (20) | Unique Code of the place |
| ModifiedUTC | String | Date and time when the visit record was last updated in UTC. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z |
| TimeZone | String | Timezone of the visit realization. For example: Europe/Zagreb |
| ScheduleNote | String | Unique Note on the visit |
| Status | String | Visit schedule status. Possible values are: Planned - visit was planned and done Unplanned - visit was not planned but done Missing - visit was planned but missed Inactive - visit was planned but missed because Representative became inactive |
| DateTimeStart | String | Start date and time in local timezone of the actual visit. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| DateTimeStartUTC | String | Start Date and time in UTC of the actual visit. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| DateTimeEnd | String | End date and time in local timezone of the actual visit. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| DateTimeEndUTC | String | End date and time in UTC of the actual visit. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| PlanDateTimeStart | String | Scheduled start date and time in local timezone. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| PlanDateTimeStartUTC | String | Scheduled start date and time in UTC. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| PlanDateTimeEnd | String | Scheduled end date and time in local timezone. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| PlanDateTimeEndUTC | String | Scheduled end date and time in UTC. The format is yyyy-MM-ddTHH:mm:ss.fffZ. For example 2022-03-31T00:00:00.000Z. |
| Tasks/TaskType | String | Type of task. possible values: Photo, Note, Form , Audit or Order |
| Tasks/TaskNote | String | Note of the task |
| Tasks/EntityId | Guid | Unique Id of the task |
| Tasks/Completed | Boolean | Is task completed or not |