listCollisionAndStats API Endpoint
listCollisionAndStats API Endpoint
listCollisionAndStats API EndpointThe listCollisionsAndStats API endpoint returns two collections of information after a collision has taken place.
API Details
List Collisions and Stats
GET https://api.zendrive.com/v3/collision_stats?start_date=&end_date=&include_mock=
Use a time period with start date and end date to retrieve a list of collisions.
Query Parameters
start_date
String
The first date (inclusive) for which you want data. Date format is YYYY-MM-DD. Timezone is in UTC.
end_date
String
The last date (inclusive) for which you want data. Date format is YYYY-MM-DD. Timezone is in UTC.
include_mock
Boolean
Used to retrieve the mock collision data uploaded via the mockCollision API, if include_mock=true.
Headers
Authorization*
String
API KEY <APIKEY>
{
"daywise_collision_stats": [
{
"2023-09-30": 4
},
{
"2023-10-01": 4
}
],
"collision_info_list": [
{
"user_id": "09b316d0-474c-4ca9-baa0-827d84452543",
"collision_id": 1111111111111,
"location": "Testville1",
"collision_time": "2023-12-01T12:30:00-05:00",
"final_callback_confidence": 92,
"platform": "ios",
"intermediate_callback_confidence": 92
},
{
"user_id": "3d69347a-2187-4640-93ff-531fc3ab82b6",
"collision_id": 2222222222222,
"location": "Testville2",
"collision_time": "2023-12-01T12:30:00-06:00",
"final_callback_confidence": 86,
"platform": "ios",
"intermediate_callback_confidence": 82
},
{
"user_id": "AOJ49RAFH2",
"collision_id": 3333333333333,
"location": "Testville3",
"collision_time": "2023-12-01T12:30:00-04:00",
"final_callback_confidence": 92,
"platform": "ios",
"intermediate_callback_confidence": 92
},
{
"user_id": "91e92b36-b7cf-4c99-ba2a-65aa86e7ff6b",
"collision_id": 4444444444444,
"location": "Testville4",
"collision_time": "2023-12-01T12:30:00-03:00",
"final_callback_confidence": 92,
"platform": "ios",
"intermediate_callback_confidence": 92
},
{
"user_id": "a9e30b49-3ccb-40f8-be50-9a4ef7369231",
"collision_id": 5555555555555,
"location": "Testville5",
"collision_time": "2023-12-01T12:30:00-01:00",
"final_callback_confidence": 84,
"platform": "ios",
"intermediate_callback_confidence": 80
},
{
"user_id": "C5A8TNA2",
"collision_id": 6666666666666,
"location": "Testville6",
"collision_time": "2023-12-01T12:30:00-02:00",
"final_callback_confidence": 89,
"platform": "android",
"intermediate_callback_confidence": 85
},
{
"user_id": "YHH8G4B4",
"collision_id": 7777777777777,
"location": "Testville7",
"collision_time": "2023-12-01T12:30:00-07:00",
"final_callback_confidence": 91,
"platform": "ios",
"intermediate_callback_confidence": 88
},
{
"user_id": "34294b27-2d3c-42ed-b955-f160124a463d",
"collision_id": 8888888888888,
"location": "Testville8",
"collision_time": "2023-12-01T12:30:00-08:00",
"final_callback_confidence": 0,
"platform": "ios",
"intermediate_callback_confidence": 79
}
]
}Response Fields
The listCollisionAndStats API returns two collections in the response:
daywise_collision_stats, which contain the number of collisions for every date in the specified range.collision_info_list, which contains basic information to identify a collision.
daywise_collision_stats.DATE
Lists the number of collisions recorded on that day. Does not return dates with no collisions recorded.
collision_info_list[i]
Contains some data points to identify a collision.
collision_info_list[i].user_id
The unique ID associated with the end user who was involved in the collision.
collision_info_list[i].collision_id
The unique collision ID generated by Zendrive. This can be used in other API calls.
collision_info_list[i].location
Provides a string which contains the name of the city where the collision occurred.
collision_info_list[i].collision_time
Provides the timestamp of the collision. This time is local to the collision location.
collision_info_list[i].final_callback_confidence
The confidence number for collision as given in the final callback
collision_info_list[i].intermediate_callback_confidence
The confidence number for collision as given in the intermediate callback.
collision_info_list[i].platform
The supported platforms are Android and iOS.
Response Body
{
"daywise_collision_stats": [
{
"2023-09-30": 4
},
{
"2023-10-01": 4
}
],
"collision_info_list": [
{
"user_id": "09b316d0-474c-4ca9-baa0-827d84452543",
"collision_id": 1111111111111,
"location": "Testville1",
"collision_time": "2023-12-01T12:30:00-05:00",
"final_callback_confidence": 92,
"platform": "ios",
"intermediate_callback_confidence": 92
},
{
"user_id": "3d69347a-2187-4640-93ff-531fc3ab82b6",
"collision_id": 2222222222222,
"location": "Testville2",
"collision_time": "2023-12-01T12:30:00-06:00",
"final_callback_confidence": 86,
"platform": "ios",
"intermediate_callback_confidence": 82
},
{
"user_id": "AOJ49RAFH2",
"collision_id": 3333333333333,
"location": "Testville3",
"collision_time": "2023-12-01T12:30:00-04:00",
"final_callback_confidence": 92,
"platform": "ios",
"intermediate_callback_confidence": 92
},
{
"user_id": "91e92b36-b7cf-4c99-ba2a-65aa86e7ff6b",
"collision_id": 4444444444444,
"location": "Testville4",
"collision_time": "2023-12-01T12:30:00-03:00",
"final_callback_confidence": 92,
"platform": "ios",
"intermediate_callback_confidence": 92
},
{
"user_id": "a9e30b49-3ccb-40f8-be50-9a4ef7369231",
"collision_id": 5555555555555,
"location": "Testville5",
"collision_time": "2023-12-01T12:30:00-01:00",
"final_callback_confidence": 84,
"platform": "ios",
"intermediate_callback_confidence": 80
},
{
"user_id": "C5A8TNA2",
"collision_id": 6666666666666,
"location": "Testville6",
"collision_time": "2023-12-01T12:30:00-02:00",
"final_callback_confidence": 89,
"platform": "android",
"intermediate_callback_confidence": 85
},
{
"user_id": "YHH8G4B4",
"collision_id": 7777777777777,
"location": "Testville7",
"collision_time": "2023-12-01T12:30:00-07:00",
"final_callback_confidence": 91,
"platform": "ios",
"intermediate_callback_confidence": 88
},
{
"user_id": "34294b27-2d3c-42ed-b955-f160124a463d",
"collision_id": 8888888888888,
"location": "Testville8",
"collision_time": "2023-12-01T12:30:00-08:00",
"final_callback_confidence": 0,
"platform": "ios",
"intermediate_callback_confidence": 79
}
]
}Was this helpful?