MarketingAnalytics
/api/v1/marketing/analyticsA marketing analytics metric tied to a campaign.
listgetcreateupdatedeleteSchema
| 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. |
| campaign_id* | string | Associated campaign ID. |
| metric_type* | enum | impressions | clicks | conversions | revenue | cost_per_lead | cost_per_acquisition | roi | otherType of marketing metric. |
| value* | number | Metric value. |
| period | string | Reporting period (e.g. '2026-06'). |
| dimensions | json | Metric breakdown dimensions. |
| source | string | Source system (e.g. google_analytics). |
API
Loading manifest…