---
title: "List reports"
method: GET
path: "/reports/"
tags: ["reports"]
---

# List reports

`GET /reports/`

Use this method to list reports.

## Query parameters

- `created_date_gt` string, date-time
- `created_date_gte` string, date-time
- `created_date_last_n_days` number
- `created_date_lt` string, date-time
- `created_date_lte` string, date-time
- `created_date_nth_full_week` number
- `created_date_nth_work_week` number
- `id_in` integer[]
- `limit` string
- `name_contains` string
- `ordering` string
- `page` string

## Response `200`

- PaginatedReportList
  - `next_page` string, nullable
  - `prev_page` string, nullable
  - `results` Report[]
    - `id` integer, required
    - `created_date` string, date-time, required — Cluster event creation date
    - `name` string — Short name, up to 256 characters
    - `modified_date` string, 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_number` integer, required — Number of records in report
    - `report_format` ReportFormatEnum[], required — Report formats
    - `size` integer, required — Report size in bytes
    - `report_file_xls` string, nullable, required
    - `report_file_json` string, nullable, required
    - `report_file_csv` string, nullable, required
    - `report_file_pdf` string, nullable, required
    - `report_file_docx` string, nullable, required
    - `report_file_custom` string, nullable, required
    - `filters` object, required — Filters available for the passed entity `type` can be used. Filters list can be found in the list endpoint of entity type
    - `origin` string, required — User request origin
    - `owner` integer, required — User id
    - `meta` ReportMeta
      - `cameras_in` integer[] — In-cameras for `face-events-in-out` and `face-cluster-events-in-out` reports
      - `cameras_out` integer[] — Out-cameras for `face-events-in-out` and `face-cluster-events-in-out` reports

---

[API](https://skmtc.dev/ntechlab/apis/internal-api-documentation.md) · [All operations](https://skmtc.dev/ntechlab/apis/internal-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ntechlab/internal-api-documentation/revisions/fe217a895bc7/schema)
