Get the sender breakdown

GET/v1/campaigns/{campaign_id}/senders/breakdown

Scope: campaigns:read

Senders that have since been disconnected still appear, with is_active: false and no account_id, so a campaign's history stays complete after a sender is removed.

date_filter takes a relative window such as 7d or 30d; variation restricts the counts to a or b.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Query parameters

date_filterstring or null
Relative window ('7d', '30d', '90d') or an ISO-8601 timestamp to count from
at most 64 charactersExample "30d"
variationstring or null
A/B arm to report on: 'a', 'b', 'unassigned' or 'all' (default)
at most 32 charactersExample "a"One of"a""b""unassigned""all"

Response

200

campaign_idstringRequired
countinteger
Default 0
sendersarray of objects
Show 14 child attributesHide child attributes
- acceptance_rate_pctnumber or null
  accepted / requests; null when none were sent
- acceptedinteger or null
  LinkedIn connection requests accepted
- account_idstring or null
  The connected account's id, when it is still connected
- contacted_leadsinteger or null
- is_activeboolean or null
  Whether the account is connected now
- labelstring or null
  The sender's display name or address
- messages_sentinteger or null
- platformstring or null
  'email' or 'linkedin'
- positive_leadsinteger or null
- positive_rate_pctnumber or null
  positive_leads / contacted_leads; null when nobody was contacted
- replied_leadsinteger or null
- reply_rate_pctnumber or null
  replied_leads / contacted_leads; null when nobody was contacted
- requestsinteger or null
  LinkedIn connection requests sent
- sender_keystring or null
  Stable key for the sender: the provider account id
successboolean
Default true
variationstring
The A/B arm the report covers
Default "all"
window_fromstring or null
Start of the window (ISO-8601); null = all time

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
400	VALIDATION_ERROR	The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. `details.errors` lists each failing field with its `field`, `message` and `type`.
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	CAMPAIGN_NOT_FOUND	No campaign with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.