Qodex.ai

Triggers the export of the surface events data into files

GET {{baseUrl}}/surfaceevents/export?fileFormat=csv&compression=none&fileSize=50&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&eventType=<string>&minConfidence=<float>&minIntensity=<float>&maxIntensity=<float>&minDetectionCount=<number>&maxDetectionCount=<number>

This endpoint triggers the export of the surface events data limited to the area defined by the GeoJSON referenced in the header. The returned jobId can be used to get the status of the export process and once the export is completed, the list of files that can be downloaded. If there is already an export process running or is completed, no new export process is started, but the ID of the existing export process is returned. The same filters that are available for the data retrieval endpoint for street segments can be used for this endpoint.

Request Params

KeyDatatypeRequiredDescription
fileFormatstringThe format of the exported files
compressionstringThis parameter can be set if the exported files should be compressed. The only supported value is gzip.
fileSizenumberThe size of the file that are generated (before compression). The size is in megabytes. The default value is 50 MB if the query parameter is not provided. Allowed values are between 5 MB and 200 MB.
longitudePoint1stringThe longitude coordinate (x-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -180 and 180.
latitudePoint1stringThe latitude coordinate (y-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -90 and 90.
longitudePoint2stringThe longitude coordinate (x-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -180 and 180.
latitudePoint2stringThe latitude coordinate (y-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -90 and 90.
eventTypestringFilters 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.
minConfidencestringFilters 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.
minIntensitystringFilters 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.
maxIntensitystringFilters 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.
minDetectionCountstringFilters 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.
maxDetectionCountstringFilters 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

KeyDatatypeRequiredDescription
x-tracking-idstringthe request tracking ID
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;jobId&quot;:&quot;\u003cstring\u003e&quot;,&quot;validUntil&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;fileNames&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}