Reporting#

Access calculated performance metrics and historical trends for organizations, campaigns, creators, and activities.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/reporting/organization/metrics#

Fetch organization-level metrics including total costs, reach, engagement, conversions, and calculated CPM, CPE, CPA.

bash

GET /v1/reporting/organization/metrics?organization_id=org_123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.

Response#

Returns { data } with the result.

Underlying SDK method: bw.organizations.metrics.get(params)

GET /v1/reporting/organization/metrics/history#

Fetch organization metrics over time with a configurable lookback window.

bash

GET /v1/reporting/organization/metrics/history?organization_id=org_123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
daysBack	`integer`	—	Number of days of history to return (1-365).

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.organizations.metrics.history(params)

GET /v1/reporting/campaign/metrics#

Fetch metrics for a single campaign including budget, cost, reach, engagement, conversions, and calculated CPM, CPE, CPA.

bash

GET /v1/reporting/campaign/metrics?organization_id=org_123&campaign_id=camp_abc123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
campaignId	`string (UUID)`	Required	Campaign identifier to get metrics for.

Response#

Returns { data } with the result.

Underlying SDK method: bw.campaigns.metrics.get(params)

GET /v1/reporting/campaign/metrics/history#

Fetch campaign metrics over time with a configurable lookback window.

bash

GET /v1/reporting/campaign/metrics/history?organization_id=org_123&campaign_id=camp_abc123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
campaignId	`string (UUID)`	Required	Campaign identifier.
daysBack	`integer`	—	Number of days of history to return (1-365).

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.campaigns.metrics.history(params)

GET /v1/reporting/creator/metrics#

Fetch metrics for a single creator including activity counts, follower totals, reach, engagement, conversions, and calculated CPM, CPE, CPA.

bash

GET /v1/reporting/creator/metrics?organization_id=org_123&creator_id=con_abc123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
creatorId	`string (UUID)`	Required	Creator identifier to get metrics for.

Response#

Returns { data } with the result.

Underlying SDK method: bw.creators.metrics.get(params)

GET /v1/reporting/creator/metrics/history#

Fetch a creator's metrics over time with a configurable lookback window.

bash

GET /v1/reporting/creator/metrics/history?organization_id=org_123&creator_id=con_abc123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
creatorId	`string (UUID)`	Required	Creator identifier.
daysBack	`integer`	—	Number of days of history to return (1-365).

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.creators.metrics.history(params)

GET /v1/reporting/activity/metrics#

Fetch metrics for a single activity including reach, engagement, cost, conversions, and calculated CPM, CPE, CPA.

bash

GET /v1/reporting/activity/metrics?organization_id=org_123&activity_id=act_abc123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
activityId	`string (UUID)`	Required	Activity identifier to get metrics for.

Response#

Returns { data } with the result.

Underlying SDK method: bw.activities.metrics.get(params)

GET /v1/reporting/activity/metrics/history#

Fetch an activity's metrics over time with a configurable lookback window.

bash

GET /v1/reporting/activity/metrics/history?organization_id=org_123&activity_id=act_abc123
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
activityId	`string (UUID)`	Required	Activity identifier.
daysBack	`integer`	—	Number of days of history to return (1-365).

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.activities.metrics.history(params)