Справочник API
Citylens Export API (1.0.0)
API for accessing detected objects and frames data
Get detected objects filtered by company and date range
Authorizations:
query Parameters
| from_dt required | string <date-time> Example: from_dt=2024-01-01T00:00:00 Start datetime in ISO format (e.g., 2024-01-01T00:00:00) |
| to_dt required | string <date-time> Example: to_dt=2024-12-31T23:59:59 End datetime in ISO format (e.g., 2024-12-31T23:59:59) |
| detector_name | string Example: detector_name=signs Name of the detector to filter by |
| locale | string Default: "ru_RU" Example: locale=ru_RU Locale for translating detected object names |
| limit | integer Default: 1000 Example: limit=100 Maximum number of objects to return |
| offset | integer Default: 0 Number of objects to skip for pagination |
Responses
Response Schema: */*
Array of objects | |
| limit | integer |
| offset | integer |
| processed | boolean All detections done |
| total_count | integer |
Get frames filtered by company and date range
Authorizations:
query Parameters
| from_dt required | string <date-time> Example: from_dt=2024-01-01T00:00:00 Start datetime in ISO format (e.g., 2024-01-01T00:00:00) |
| to_dt required | string <date-time> Example: to_dt=2024-12-31T23:59:59 End datetime in ISO format (e.g., 2024-12-31T23:59:59) |
| limit | integer Default: 1000 Example: limit=100 Maximum number of frames to return |
| offset | integer Default: 0 Number of frames to skip for pagination |
Responses
Response Schema: */*
Array of objects | |
| limit | integer |
| offset | integer |
| total_count | integer |
Get detection totals statistics for company
Authorizations:
query Parameters
| from_dt required | string <date-time> Example: from_dt=2024-01-01T00:00:00 Start datetime in ISO format (inclusive) |
| to_dt required | string <date-time> Example: to_dt=2024-01-02T00:00:00 End datetime in ISO format (must be greater than from_dt) |
| user_email | string Example: user_email=driver@example.com Filter by user email |
Responses
Response Schema: */*
Array of objects Detection count per detector | |
| total_objects | integer Total number of detections across all active detectors |
| user_email | string or null |
Get detection statistics grouped by class for a specific detector
Authorizations:
query Parameters
| from_dt required | string <date-time> Example: from_dt=2024-01-01T00:00:00 Start datetime in ISO format (inclusive) |
| to_dt required | string <date-time> Example: to_dt=2024-01-02T00:00:00 End datetime in ISO format (must be greater than from_dt) |
| detector_name required | string Example: detector_name=signs Name of the detector to filter by |
| user_email | string Example: user_email=driver@example.com Filter by user email |
| locale | string Default: "en_EN" Example: locale=en_EN Locale for translating detection class names |
Responses
Response Schema: */*
Array of objects | |
| detector_name | string |
| total_count | integer Total number of detections across all classes |
| user_email | string or null |
Get distance statistics for company tracks
Authorizations:
query Parameters
| from_dt required | string <date-time> Example: from_dt=2024-01-01T00:00:00 Start datetime in ISO format (inclusive) |
| to_dt required | string <date-time> Example: to_dt=2024-01-02T00:00:00 End datetime in ISO format (must be greater than from_dt) |
| user_email | string Example: user_email=driver@example.com Filter by user email |
Responses
Response Schema: */*
| total_count | integer Total number of tracks after outlier removal |
| total_distance_km | number <float> Total distance in kilometers, rounded to 2 decimal places |
| total_duration_hours | number <float> Total duration in hours, rounded to 2 decimal places |
Get routes statistics for company tracks
Authorizations:
query Parameters
| from_dt required | string <date-time> Example: from_dt=2024-01-01T00:00:00 Start datetime in ISO format (inclusive) |
| to_dt required | string <date-time> Example: to_dt=2024-01-02T00:00:00 End datetime in ISO format (must be greater than from_dt) |
| user_email | string Example: user_email=driver@example.com Filter by user email |
| limit | integer Default: 50 Example: limit=100 Maximum number of routes to return per page |
| offset | integer Default: 0 Number of routes to skip for pagination |
Responses
Response Schema: */*
| limit | integer |
| offset | integer |
Array of objects List of routes for the current page | |
| total_count | integer Total number of matching tracks (without pagination) |