VictoriaAI
View as Markdown

Compare A/B cohorts

GET/v1/campaigns/{campaign_id}/ab-cohorts
Scope: campaigns:read

Per-arm counts for leads first contacted at or after since. Each lead counts once, in the arm it was assigned, with its first reply, first positive reply and first negative reply: arms.a and arms.b each carry contacted, replied, positive and negative.

Unlike Get campaign analytics, every number is over the same set of leads, those who could have seen either arm, so the arms can be compared directly. Pass the time the test was turned on as since.

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

  • sincestringRequired

    ISO 8601 timestamp the test started. Only leads first contacted at or after it count. Answers 400 INVALID_DATE_FILTER if it can't be parsed.

Response

200

  • campaign_idstringRequired
  • sincestringRequired
  • armsobject

    a / b -> {contacted, replied, positive, negative}

  • successboolean
    Default true

Errors

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

StatusCodeMeaning
400VALIDATION_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.

400INVALID_DATE_FILTER

date_filter must be a number of days such as 30d, or an ISO 8601 timestamp.

401UNAUTHORIZED

The Authorization header is missing or malformed, or the API key is unknown or has been deactivated.

401API_KEY_EXPIRED

The API key is past its expiry date. Create a new key in the Victoria AI app.

403INSUFFICIENT_SCOPE

The API key doesn't have the scope this endpoint requires, such as leads:write.

403ORGANIZATION_DEACTIVATED

The organization that owns this API key has been deactivated.

404CAMPAIGN_NOT_FOUND

No campaign with this ID exists in your organization.

404NOT_FOUND

No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers NOT_FOUND.

429RATE_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.

500INTERNAL_ERROR

Something failed on our side. The response never includes internal details; quote its request_id when you contact support.

503UPSTREAM_TIMEOUT

A service the API depends on timed out. The request is safe to retry.

503AUTH_UNAVAILABLE

The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

HeaderDescription
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.