The GET Events endpoint allows you to retrieve all events within a specified time frame, defined by startTime and endTime, using ISO-8601 Coordinated Universal Time (UTC) format (e.g. 2024-09-25T15:00:00.000Z). Additionally, this endpoint enables you to narrow down the set of events by specifying a reportId. When reportId is included, the response will return only the events associated with that particular report, provided the user has access to it. This functionality is especially useful for clients who want to retrieve a focused set of events related to specific reports, such as "All Drive-Thru Events"
Usage
To retrieve all events within a defined time range, only startTime and endTime are required.
To retrieve the events under a specific report, pass in the reportId you obtained from the GET Reports response.
[
{
"id": "19d889b0-5148-11ed-8f0c-bdae3dfd1ab5",
"name": {
"en-CA": "All Drive-Thru Events"
},
"description": {
"en-CA": "Contains all Drive-Thru Bookmark events created by the Solink dwell time feature."
}
}
]
Sample Request
curl --request GET \
--url 'https://api-prod-us-west-2.solinkcloud.com/v2/events?reportId=19d889b0-5148-11ed-8f0c-bdae3dfd1ab5&startTime=2024-09-25T15%3A00%3A00.000Z&endTime=2024-09-30T15%3A00%3A00.000Z' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'accept: application/json' \
--header 'x-api-key: {API_KEY}'
Sample Response
[
{
"id": "6552e6d0-3f0f-11e6-931d-3dab02287ss4-pwCaSYUOWLpGvUXtmZKSq",
"startTime": "2024-09-30T14:59:59.020+00:00",
"endTime": "2024-09-30T15:00:01.035+00:00",
"type": "bookmark",
"subtype": "ai-dwellTime",
"title": "Drive Thru Window",
"subtitle": "Window Time @ Store 1000",
"deviceId": "6552e6d0-3f0f-11e6-931d-3dab02289gg2",
"locationTags": [
"Brand:Solink",
"City:Kanata"
],
"createTime": "2024-09-30T15:00:11.285+00:00",
"details": {
"duration_sec": 2,
"Order duration": 2,
"confirmed": false,
"origin": "connect-ai/dwell_time",
"localTime": 1059,
"Vehicle service window time": 2,
"Vehicle dwell time type": "service-window",
"generatedByEventStandard": true,
"marker": "ai-dwellTime"
},
"cameras": [
{
"id": "d123e0e0-804f-11e6-aa6e-77b212fea43f",
"name": "Drive Thru Window"
}
]
}
]