reports
Add a new report
Use this method to add a new report.
post/reports/
Request body
namestring
Short name, up to 256 characters
type'face-events' | 'face-events-in-out' | 'body-events' | 'car-events' | 'human-episodes' | 'car-episodes' | 'face-clusters' | 'body-clusters' | 'car-clusters' | 'face-cluster-events' | 'face-cluster-events-in-out' | 'body-cluster-events' | 'car-cluster-events' | 'human-cards' | 'car-cards' | 'kyc' | 'cameras' | 'counter-records' | 'areas' | 'area-activations' | 'area-activations-in-out' | 'area-activation-records-in-out' | 'area-records' | 'audit-logs' | 'lines' | 'alerts' required
pictures'fullframe' | 'thumbnail' | 'link' required
report_formatReportFormatEnum[] required
Report formats
filtersobject required
Filters available for the passed entity type can be used. Filters list can be found in the list endpoint of entity type
Response
idinteger required
created_datestring date-time required
Cluster event creation date
namestring
Short name, up to 256 characters
modified_datestring date-time required
Cluster event modification date
status'scheduled' | 'processing' | 'error' | 'completed' required
type'face-events' | 'face-events-in-out' | 'body-events' | 'car-events' | 'human-episodes' | 'car-episodes' | 'face-clusters' | 'body-clusters' | 'car-clusters' | 'face-cluster-events' | 'face-cluster-events-in-out' | 'body-cluster-events' | 'car-cluster-events' | 'human-cards' | 'car-cards' | 'kyc' | 'cameras' | 'counter-records' | 'areas' | 'area-activations' | 'area-activations-in-out' | 'area-activation-records-in-out' | 'area-records' | 'audit-logs' | 'lines' | 'alerts' required
pictures'fullframe' | 'thumbnail' | 'link' required
records_numberinteger required
Number of records in report
report_formatReportFormatEnum[] required
Report formats
sizeinteger required
Report size in bytes
report_file_xlsstring nullable required
report_file_jsonstring nullable required
report_file_csvstring nullable required
report_file_pdfstring nullable required
report_file_docxstring nullable required
report_file_customstring nullable required
filtersobject required
Filters available for the passed entity type can be used. Filters list can be found in the list endpoint of entity type
originstring required
User request origin
ownerinteger required
User id