Revenue Analytics

Track revenue overview and attributed revenue for campaigns, widgets, and recommendation widgets.

Audience: Revenue and growth teams measuring contribution by activation channel.

Critical: Revenue endpoints are under /api/v1/analytics/revenue/* and require analytics permissions.

Attribution Product Analytics Recommendation Breakdown

Who This Page Is For

Use this page when you need attributable revenue metrics by entity (campaign, widget, recommendation widget) and overall order-level revenue overview.

Quick Start (2-5 Minutes)

Get revenue overview

Retrieve organization/site-level revenue summary.

GET /api/v1/analytics/revenue/overview?days=30&siteId=SITE_ID

Get campaign revenue

Inspect attributed revenue for one campaign entity.

GET /api/v1/analytics/revenue/campaigns/:id?days=30

Get widget revenue

Inspect attributed revenue for one widget entity.

GET /api/v1/analytics/revenue/widgets/:id?days=30

Get recommendation widget revenue

Inspect attributed revenue for one recommendation placement.

GET /api/v1/analytics/revenue/recommendations/:id?days=30

Cross-check attribution model

Validate that attribution assumptions align with event-level attribution analysis.

Use /analytics/events/:eventId/attribution for event-level model checks.

Revenue endpoints

GET /api/v1/analytics/revenue/overview
GET /api/v1/analytics/revenue/campaigns/:id
GET /api/v1/analytics/revenue/widgets/:id
GET /api/v1/analytics/revenue/recommendations/:id

Required Fields / Minimum Payload

Field	Required	Type	Used by events	Description
`id`	Conditional	`uuid`	campaigns/widgets/recommendations endpoints	Entity identifier for attributed revenue lookup.
`days`	Optional	`number`	all revenue endpoints	Lookback window for revenue aggregation.
`siteId`	Optional	`uuid`	overview	Site-level filter in overview endpoint.

Event or Endpoint Decision Matrix

Scenario	Use This	Why
Need overall revenue trend	/analytics/revenue/overview	High-level order revenue baseline.
Need campaign contribution	/analytics/revenue/campaigns/:id	Campaign-specific attributable revenue.
Need widget contribution	/analytics/revenue/widgets/:id	Widget-level attributable revenue.
Need recommendation placement contribution	/analytics/revenue/recommendations/:id	Recommendation widget revenue view.
Need model-level touchpoint analysis	/analytics/events/:eventId/attribution	Event-level attribution model detail.

Common Errors and Fixes

Entity revenue endpoint returns empty

Cause: Wrong entity ID or no attributed revenue in chosen window.

Fix: Validate entity ID and expand days window.

Overview and entity totals do not align exactly

Cause: Different attribution scopes and filters across endpoints.

Fix: Compare with aligned filters and documented attribution assumptions.

Revenue appears delayed

Cause: Order ingestion timing or delayed downstream processing.

Fix: Verify order tracking pipeline and check recent ingestion status.

Permission errors for finance stakeholders

Cause: Analytics permission missing in role configuration.

Fix: Grant analytics view permission to reporting roles.

Production Checklist

Revenue endpoints use consistent days/site filters in dashboards.Required
Entity IDs are sourced from canonical module records.Required
Attribution assumptions are documented next to revenue KPIs.Required
Order ingestion reliability is monitored alongside revenue dashboards.Required
Revenue anomaly triage includes entity-level drilldowns.Required