Retrieve surface events restricted to the predefined area of the user
GET {{baseUrl}}/surfaceevents?page=<integer>&size=<integer>&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&eventType=<string>&minConfidence=<float>&minIntensity=<float>&maxIntensity=<float>&minDetectionCount=<number>&maxDetectionCount=<number>
This endpoint returns a set of surface events restricted to the predefined area of the user. The surface events are returned in a paged response. If there is no surface event data in the defined area, an empty list is returned. Note that missing fields in individual surface events are returned as null values. To additionally limit the returned data, a bounding box can be defined as geolocation filter. The bounding box is defined by two points, each represented by a longitude and a latitude coordinate. The first point is defined by the longitudePoint1 and latitudePoint1 query parameters. The second point is defined by the longitudePoint2 and latitudePoint2 query parameters. All four query parameters are optional, but if one of them is provided, all four must be provided to define a bounding box as geolocation filter.
Besides the bounding box, the surface events can also be filtered by the recent intensity, event type and minimum confidence, and the detection count. If more than one filter is provided, all filters are combined with a logical AND.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The page number used for the pagination | |
size | string | The size of the response page used for the pagination. The size is given in number of events. If the requested page size exceeds the maximum allowed page size, a validation error is returned. | |
longitudePoint1 | string | The longitude coordinate (x-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -180 and 180. | |
latitudePoint1 | string | The latitude coordinate (y-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -90 and 90. | |
longitudePoint2 | string | The longitude coordinate (x-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -180 and 180. | |
latitudePoint2 | string | The latitude coordinate (y-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -90 and 90. | |
eventType | string | Filters the surface events by the event type. The event type can contain up tp two values from the following list: TRANSVERSE_CRACK, ALLIGATOR_CRACK, POTHOLE, DAMAGED_CROSSWALK, DAMAGED_PAINT, MANHOLE_COVER, CONSTRUCTION_JOINT_LONGITUDINAL, CONSTRUCTION_JOINT_TRANSVERSE, SPEED_BUMPS. Only surface events with the provided event type are returned. Note that surface events are classified with multiple event types, each type with a corresponding confidence value. Surface events match this filter if the provided event type matches any of the event types of the event, regardless of the confidence value. | |
minConfidence | string | Filters the surface events by the confidence value. The value can be between 0 and 1. Only surface events with a confidence value greater than or equal to the provided value for one of the two highest event types are returned. | |
minIntensity | string | Filters the surface events by the recent intensity value. Only surface events with a recent intensity value less than or equal to the provided value are returned. | |
maxIntensity | string | Filters the surface events by the recent intensity value. Only surface events with a recent intensity value less than or equal to the provided value are returned. | |
minDetectionCount | string | Filters the surface events by the detection count during the last 30 days before the data was updated. Only surface events with a detection count greater than or equal to the provided value are returned. | |
maxDetectionCount | string | Filters the surface events by the detection count during the last 30 days before the data was updated. Only surface events with a detection count less than or equal to the provided value are returned. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Accept | string |
RESPONSES
status: OK
{"surfaceEvents":[{"id":"\u003cuuid\u003e","latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e","heading":"\u003cinteger\u003e","recentDetection":"\u003cdate\u003e","recentIntensity":"\u003cfloat\u003e","firstDetection":"\u003cdate\u003e","firstIntensity":"\u003cfloat\u003e","tendency":"\u003cinteger\u003e","detectionCount":"\u003cinteger\u003e","eventTypes":[{"type":"\u003cstring\u003e","confidence":"\u003cfloat\u003e"},{"type":"\u003cstring\u003e","confidence":"\u003cfloat\u003e"}],"laneNumber":"\u003cinteger\u003e"},{"id":"\u003cuuid\u003e","latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e","heading":"\u003cinteger\u003e","recentDetection":"\u003cdate\u003e","recentIntensity":"\u003cfloat\u003e","firstDetection":"\u003cdate\u003e","firstIntensity":"\u003cfloat\u003e","tendency":"\u003cinteger\u003e","detectionCount":"\u003cinteger\u003e","eventTypes":[{"type":"\u003cstring\u003e","confidence":"\u003cfloat\u003e"},{"type":"\u003cstring\u003e","confidence":"\u003cfloat\u003e"}],"laneNumber":"\u003cinteger\u003e"}],"page":{"size":"\u003cinteger\u003e","number":"\u003cinteger\u003e","totalPages":"\u003cinteger\u003e","totalElements":"\u003clong\u003e"}}