RoadScout
For developers · Read-only REST

The Network Diagnostics API

Everything RoadScout knows about your network, available to your own systems: events, trips, work orders, analytics, segments and GIS exports. Read-only by design, so your PMS or GIS stays the system of record.

BASE URL https://api.roadscoutai.com/v1AUTH: BEARER JWT · PER ORGANIZATIONJSON · READ-ONLY

Access model

One token per organization. Read-only, always.

Requests authenticate with a Bearer JWT issued per organization, and every response is scoped to that organization's data. The API cannot write, so integrations can never corrupt the survey record.

SEC. 01 / AUTH

BEARER JWT

Send Authorization: Bearer <token> on every request. Tokens are issued per organization: your data, nobody else's.

READ-ONLY

Every endpoint is GET. The review workflow, work orders and audit trail are managed in the dashboard; the API reports them.

JSON + FILES

Responses are JSON. Export endpoints return GIS-ready files: Shapefile, GeoJSON, KML and CSV in WGS84.

Reference

Endpoints, grouped the way you will use them.

All paths are relative to https://api.roadscoutai.com/v1.

SEC. 02 / ENDPOINTS

Events

Clustered detections with evidence frames, confidence and severity
GET/eventsList events, filterable by status, type, min_conf, from/to, bbox
GET/events/{id}Single event with evidence frames, GPS fix and review state
GET/events/summaryCounts by type, severity and status for the filtered set
GET/events/exportBulk export of the filtered event set

Trips

Capture sessions with route, scores and telemetry findings
GET/tripsList trips with date, distance and Trip Score
GET/trips/{id}Trip detail: route, per-segment scores, event references

Work Orders

Maintenance jobs raised from accepted events
GET/work-ordersList work orders with priority, status, assignee and estimated cost
GET/work-orders/{id}Single work order with linked events and history

Analytics

Network-level condition, standards scores and forecasts
GET/analytics/summaryNetwork headline figures for the period
GET/analytics/pciPCI to ASTM D6433 across the network, per segment
GET/analytics/iriIRI estimates banded to World Bank / ARRB thresholds
GET/analytics/condition-distributionShare of network per condition band
GET/analytics/deterioration-forecastProjected condition for budget planning
GET/analytics/benchmarkNetwork scores against good-practice benchmarks (PCI 85, IRI 2.7)

Segments

The ~100 m scoring units behind every map and score
GET/segmentsList segments with PCI, IRI and surface type
GET/segments/{id}Segment detail with score history and events

Inspections

Virtual inspections run from the captured record
GET/inspectionsList virtual inspections
GET/inspections/{id}Inspection detail with findings

Export

GIS-ready files, WGS84
GET/export/eventsEvents as Shapefile, GeoJSON, KML or CSV
GET/export/segmentsScored segments as Shapefile, GeoJSON, KML or CSV

Shapes on the wire

Event types, filters and a real response.

SEC. 03 / SCHEMA

EVENT TYPE ENUM
POTHOLECRACKPATCHCORRUGATIONINCLINATIONMISSING_LANE_LINESOTHER

Vision-detected surface events plus the telemetry-derived types: CORRUGATION from the accelerometer, INCLINATION for grades of 6% or more, MISSING_LANE_LINES over 100 m or more.

QUERY FILTERS · /EVENTS
statusReview state of the event: UNREVIEWED, ACCEPTED or DECLINED
typeOne of the event type enum values below
min_confMinimum model confidence, 0 to 1
from / toDetection time window, ISO 8601
bboxBounding box in WGS84: sw_lat,sw_lon,ne_lat,ne_lon
SAMPLE · GET /EVENTS200 OK · APPLICATION/JSON
GET /v1/events?type=POTHOLE&min_conf=0.6&status=ACCEPTED
Authorization: Bearer <token>

{
  "data": [
    {
      "id": "evt_01hq3k8v9",
      "type": "POTHOLE",
      "severity": "HIGH",
      "confidence": 0.87,
      "status": "ACCEPTED",
      "location": { "lat": -29.8579, "lon": 30.9822 },
      "detected_at": "2026-06-14T08:41:07Z",
      "trip_id": "trp_01hq3jz2m",
      "segment_id": "seg_00482",
      "evidence_frames": [
        "https://.../frames/evt_01hq3k8v9_1.jpg",
        "https://.../frames/evt_01hq3k8v9_2.jpg",
        "https://.../frames/evt_01hq3k8v9_3.jpg"
      ]
    }
  ],
  "meta": { "count": 1, "total": 214 }
}
GIS EXPORT FORMATS
ShapefileGeoJSONKMLCSV

All exports in WGS84, ready for ArcGIS, QGIS or any standard GIS pipeline.

WEBHOOKS

Prefer push over polling? Webhooks notify your systems as new data lands, so trip results and events flow into your stack the moment they exist.

API KEYS

API access ships with the Integration Plus module. Contact us to get keys for your organization.

Build on your own road data.

Get organization API keys with the Integration Plus module and wire RoadScout into your PMS, GIS or data warehouse.