Sign in
latestOpenAPI 3.0.3AGPL-3.0 license2026-08-2211401.8 MB

32391e7c6322

campaigns

Get aggregate campaign statistics

Returns per-action counts, unique profile count, and total credits used for a campaign.

get/campaigns/{campaignSlug}/stats

Path parameters

campaignSlugstring required

Campaign identifier

Response

Aggregate campaign statistics

successtrue required
statsobject required

Per-action-type counts (e.g. message: 45, reply: 120)

totalProfilesinteger required

Unique profiles processed in this campaign

creditsUsedinteger required

Credits this CAMPAIGN has consumed over its life, not the cost of this call. This endpoint is free. The field is named for the shared envelope and does not mean what it means elsewhere.

retryAfterinteger required

Seconds to wait before another call of the same type. Always 0 here.