Справочник 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:
ApiKeyAuth
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:
ApiKeyAuth
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 |