Reporting#
Access calculated performance metrics and historical trends for organizations, campaigns, creators, and activities.
Provider required
BrandwaveProvider ancestor in your component tree. See the React Hooks overview for setup instructions.useOrganizationMetrics#
Fetch organization-level metrics including total costs, reach, engagement, conversions, and calculated CPM, CPE, CPA.
import { useOrganizationMetrics } from '@brandwave/react';
const { data, isLoading } = useOrganizationMetrics({
organizationId: 'org_123',
});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)
useOrganizationMetricsHistory#
Fetch organization metrics over time with a configurable lookback window.
import { useOrganizationMetricsHistory } from '@brandwave/react';
const { data, isLoading } = useOrganizationMetricsHistory({
organizationId: 'org_123',
});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)
useCampaignMetrics#
Fetch metrics for a single campaign including budget, cost, reach, engagement, conversions, and calculated CPM, CPE, CPA.
import { useCampaignMetrics } from '@brandwave/react';
const { data, isLoading } = useCampaignMetrics({
organizationId: 'org_123',
campaignId: 'camp_abc123',
});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)
useCampaignMetricsHistory#
Fetch campaign metrics over time with a configurable lookback window.
import { useCampaignMetricsHistory } from '@brandwave/react';
const { data, isLoading } = useCampaignMetricsHistory({
organizationId: 'org_123',
campaignId: 'camp_abc123',
});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)
useCreatorMetrics#
Fetch metrics for a single creator including activity counts, follower totals, reach, engagement, conversions, and calculated CPM, CPE, CPA.
import { useCreatorMetrics } from '@brandwave/react';
const { data, isLoading } = useCreatorMetrics({
organizationId: 'org_123',
creatorId: 'con_abc123',
});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)
useCreatorMetricsHistory#
Fetch a creator's metrics over time with a configurable lookback window.
import { useCreatorMetricsHistory } from '@brandwave/react';
const { data, isLoading } = useCreatorMetricsHistory({
organizationId: 'org_123',
creatorId: 'con_abc123',
});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)
useActivityMetrics#
Fetch metrics for a single activity including reach, engagement, cost, conversions, and calculated CPM, CPE, CPA.
import { useActivityMetrics } from '@brandwave/react';
const { data, isLoading } = useActivityMetrics({
organizationId: 'org_123',
activityId: 'act_abc123',
});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)
useActivityMetricsHistory#
Fetch an activity's metrics over time with a configurable lookback window.
import { useActivityMetricsHistory } from '@brandwave/react';
const { data, isLoading } = useActivityMetricsHistory({
organizationId: 'org_123',
activityId: 'act_abc123',
});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)