This endpoint provides detailed information about driver events that match the search criteria, enabling efficient tracking and management of driver-related activities.
Request Parameters
The following parameter is required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The API version to use. |
Request Body Parameters
The following parameters are required in the request body:
| Parameter | Type | Required | Description |
|---|---|---|---|
| startDate | String (DateTime) | Yes | The start date-time for the event search range. |
| endDate | String (DateTime) | Yes | The end date-time for the event search range. |
| trailerIds | Array of Strings | Yes | The list of trailer IDs to filter driver events. |
Example CURL request
Use the current API version number and ensure you replace the Authorization header value with your actual Bearer token for the request:
curl --location 'https://integrations.alvys.com/api/p/v1/drivers/events/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \
--header 'Content-Type: application/json' \
--data '{
"startDate": "2025-02-06T06:50:20.471Z",
"endDate": "2025-02-06T06:50:20.471Z",
"trailerIds": [
"string"
]
}'
Response Parameters
The following table lists the parameters included in the response for driver events requests.
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | Yes | The unique identifier of the driver event. |
| title | String | Yes | The title or reference code of the event. |
| eventType | String | Yes | The type of event (e.g., Vacation, Restart, Other). |
| description | String | No | A detailed description of the event. |
| startDate | String (DateTime) | Yes | The start date-time of the event. |
| endDate | String (DateTime) | Yes | The end date-time of the event. |
| address | Object | No | The location details associated with the event. |
| address.street | String | No | The street address where the event occurred. |
| address.city | String | No | The city where the event took place. |
| address.state | String | No | The state where the event took place. |
| address.zipCode | String | No | The ZIP code of the event location. |
| createdBy | String | Yes | The user who created the event record. |
| createdAt | String (DateTime) | Yes | The timestamp for when the event was created. |
Versioning
The version parameter in the URL path specifies which version of the API you are using. Including the version number ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.
Example Response
On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code.
Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section.
This page is interactive, allowing you to try a request by specifying the API version in the URL path and providing the necessary request body. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can fork our Public API Postman Collection directly. Make sure to authorize yourself before trying a request.