Reporting#

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

Get organization metrics#

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

typescript

const { data } = await bw.organizations.metrics.get({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
});

Parameters#

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

Response#

Returns { data } with the result.

Get organization metrics history#

Fetch organization metrics over time with a configurable lookback window.

typescript

const { items, totalCount, facets } = await bw.organizations.metrics.history({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
});

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.

Get campaign metrics#

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

typescript

const { data } = await bw.campaigns.metrics.get({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  campaignId: '3a8d1f56-9e42-4b7c-a1d8-6f0e2b9c4a03',
});

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.

Get campaign metrics history#

Fetch campaign metrics over time with a configurable lookback window.

typescript

const { items, totalCount, facets } = await bw.campaigns.metrics.history({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  campaignId: '3a8d1f56-9e42-4b7c-a1d8-6f0e2b9c4a03',
});

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.

Get creator metrics#

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

typescript

const { data } = await bw.creators.metrics.get({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  creatorId: '9b4c2e78-1a53-4f6d-b8e9-0c7a5d3f1e04',
});

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.

Get creator metrics history#

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

typescript

const { items, totalCount, facets } = await bw.creators.metrics.history({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  creatorId: '9b4c2e78-1a53-4f6d-b8e9-0c7a5d3f1e04',
});

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.

Get activity metrics#

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

typescript

const { data } = await bw.activities.metrics.get({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  activityId: '7f2e9b34-5c81-4d6a-8e07-9a3b1c5d2f02',
});

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.

Get activity metrics history#

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

typescript

const { items, totalCount, facets } = await bw.activities.metrics.history({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  activityId: '7f2e9b34-5c81-4d6a-8e07-9a3b1c5d2f02',
});

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.