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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
daysBackintegerNumber 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&campaign_id=3a8d1f56-9e42-4b7c-a1d8-6f0e2b9c4a03
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
campaignIdstring (UUID)RequiredCampaign 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&campaign_id=3a8d1f56-9e42-4b7c-a1d8-6f0e2b9c4a03
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
campaignIdstring (UUID)RequiredCampaign identifier.
daysBackintegerNumber 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&creator_id=9b4c2e78-1a53-4f6d-b8e9-0c7a5d3f1e04
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
creatorIdstring (UUID)RequiredCreator 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&creator_id=9b4c2e78-1a53-4f6d-b8e9-0c7a5d3f1e04
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
creatorIdstring (UUID)RequiredCreator identifier.
daysBackintegerNumber 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&activity_id=7f2e9b34-5c81-4d6a-8e07-9a3b1c5d2f02
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
activityIdstring (UUID)RequiredActivity 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=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&activity_id=7f2e9b34-5c81-4d6a-8e07-9a3b1c5d2f02
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
activityIdstring (UUID)RequiredActivity identifier.
daysBackintegerNumber of days of history to return (1-365).

Response#

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

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