Report API Integration Steps

This guide explains how to integrate and manage reports using the Conxai Report API.

Prerequisites

Before using the Report API, make sure your cameras and projects are properly configured.
Follow the SiteLens Integration Steps to complete the initial setup.

---

1. Choose Your Report Generation Method

You have two options for generating reports:

Option 1: Manual (Custom) Report Generation

Generate reports manually whenever needed:

• Create a Report (Custom)

Option 2: Automated Report Generation

Automate recurring reports by configuring project-level report settings:

• Set Up Automated Report Settings

---

2. Retrieve Reports

List Reports Within a Time Range

Fetch all reports for a specific project based on a time filter:

• List Reports

Get Full Report Details

Access the full content of a specific report using its ID:

• Get Report by ID

---

3. Update Existing Reports

Update specific details inside an existing report:

• Update Report

---

4. Delete Reports or Report Settings

Delete a Specific Report

Remove a report by its ID:

• Delete Report

Delete Automated Report Settings

Clear automated report settings for a project:

• Delete Report Settings