Skip to content

Shared Reports

Shared reports let you generate public links to video analysis results. Anyone with the share hash can view the report without authentication.


Create a shared report for a video.

Auth: Required

Body FieldTypeRequiredDescription
video_idstringYesVideo ID or job ID
expires_atstringNoExpiration 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"
}
Terminal window
curl -X POST https://api.lynxvizion.com/api/shared-reports \
-H "Authorization: $LVZ_KEY" \
-H "Content-Type: application/json" \
-d '{"video_id": "a1b2c3d4-..."}'

View a shared report. No authentication required.

Path ParamTypeRequiredDescription
share_hashstringYesThe 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"
}
Terminal window
curl https://api.lynxvizion.com/api/shared-reports/xK9mP2qR7wLnY4vB

Delete a shared report, revoking access.

Auth: Required

Path ParamTypeRequiredDescription
report_idstringYesReport ID (not the share hash)

Response:

{ "ok": true }
Terminal window
curl -X DELETE https://api.lynxvizion.com/api/shared-reports/1 \
-H "Authorization: $LVZ_KEY"

List all shared reports for a specific video.

Auth: Required

Path ParamTypeRequiredDescription
job_idstringYesThe 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"
}
]
Terminal window
curl https://api.lynxvizion.com/api/videos/a1b2c3d4-.../shared-reports \
-H "Authorization: $LVZ_KEY"