Report
/api/v1/analytics/reportsA generated report; supports a custom generate operation.
listgetcreateupdatedeletegenerateSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name* | string | Human-readable report name. |
| type* | string | Report type identifier. |
| status | enum | draft | generating | completed | failedReport generation status. |
| parameters | json | Report generation parameters. |
| generated_at | date-time | ISO 8601 timestamp when report was generated. |
| file_url | string | URL to the generated report file. |
| owner_id | string | User ID of the report owner. |
| tags | json | Free-form tags for filtering. |
API
Loading manifest…