Shared Reports
Shared reports let you generate public links to video analysis results. Anyone with the share hash can view the report without authentication.
POST /shared-reports
Section titled “POST /shared-reports”Create a shared report for a video.
Auth: Required
| Body Field | Type | Required | Description |
|---|---|---|---|
video_id | string | Yes | Video ID or job ID |
expires_at | string | No | Expiration date (ISO 8601). null for no expiry. |
Response: SharedReportResponse (201 Created)
{ "id": "1", "user_id": "550e8400-...", "video_id": "1", "share_hash": "xK9mP2qR7wLnY4vB", "expires_at": null, "is_active": 1, "created_at": "2025-01-15T10:00:00"}curl -X POST https://api.lynxvizion.com/api/shared-reports \ -H "Authorization: $LVZ_KEY" \ -H "Content-Type: application/json" \ -d '{"video_id": "a1b2c3d4-..."}'GET /shared-reports/{share_hash}
Section titled “GET /shared-reports/{share_hash}”View a shared report. No authentication required.
| Path Param | Type | Required | Description |
|---|---|---|---|
share_hash | string | Yes | The share hash from report creation |
Response:
{ "share_hash": "xK9mP2qR7wLnY4vB", "video": { "id": "1", "job_id": "a1b2c3d4-...", "name": "Product Demo", "status": "completed", "duration": 120.5, "..." }, "created_at": "2025-01-15T10:00:00"}curl https://api.lynxvizion.com/api/shared-reports/xK9mP2qR7wLnY4vBDELETE /shared-reports/{report_id}
Section titled “DELETE /shared-reports/{report_id}”Delete a shared report, revoking access.
Auth: Required
| Path Param | Type | Required | Description |
|---|---|---|---|
report_id | string | Yes | Report ID (not the share hash) |
Response:
{ "ok": true }curl -X DELETE https://api.lynxvizion.com/api/shared-reports/1 \ -H "Authorization: $LVZ_KEY"GET /videos/{job_id}/shared-reports
Section titled “GET /videos/{job_id}/shared-reports”List all shared reports for a specific video.
Auth: Required
| Path Param | Type | Required | Description |
|---|---|---|---|
job_id | string | Yes | The video’s job ID |
Response: SharedReportResponse[]
[ { "id": "1", "user_id": "550e8400-...", "video_id": "1", "share_hash": "xK9mP2qR7wLnY4vB", "expires_at": null, "is_active": 1, "created_at": "2025-01-15T10:00:00" }]curl https://api.lynxvizion.com/api/videos/a1b2c3d4-.../shared-reports \ -H "Authorization: $LVZ_KEY"