Retrieve surface events restricted to the predefined area of the user
POST {{baseUrl}}/surfaceevents?page=<integer>&size=<integer>
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 GeoJSON polygon or multi-polygon can be defined as geolocation filter. The GeoJSON filter geometry is defined in the request body. The provided geometry is validated, e.g., it must be a valid GeoJSON polygon or multi-polygon with valid coordinate values. Also, requests containing too complex geometries are rejected for performance reasons.
Besides the GeoJSON filter, 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. |
Request Body
{"geoJson"=>{"type"=>"Polygon", "coordinates"=>[[["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"]], [["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"]]], "bbox"=>["<number>", "<number>", "<number>", "<number>"]}, "eventType"=>"<string>", "minConfidence"=>"<float>", "minIntensity"=>"<float>", "maxIntensity"=>"<float>", "minDetectionCount"=>"<number>", "maxDetectionCount"=>"<number>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Content-Type | string | ||
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"}}