v2

latestOpenAPI 3.0.3AGPL-3.0 license2026-07-2613501.9 MB

campaigns

Get aggregate campaign statistics

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

get/campaigns/{campaignSlug}/stats

campaignSlugstring required

Campaign identifier

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

Total credits consumed by this campaign (sum of action counts). Also serves as the per-call creditsUsed (always 0 for this endpoint).

retryAfterinteger required

Seconds to wait before next call of the same type (always 0 for campaign queries).