Campanhas

Adicionar teste A/B

Changed on

Prefira o campo abTest no POST /v1/campaigns: lá o teste nasce junto com a campanha. Criado depois, parte dos contatos pode já ter sido enviada sem o teste. Nesta rota variantATemplateName é obrigatório e o padrão de autopilot é false. Permissão: CAMPAIGNS_SEND.

post/v1/campaigns/{campaignId}/ab-test

Request

Path parameters

campaignIdstring uuid required

ID da campanha.

Request body

variantATemplateNamestring required
variantBTemplateNamestring required
metric'DELIVERED' | 'READ' | 'CLICKED' | 'CONVERTED' required
samplePctinteger
splitPctinteger
decisionWindowMinutesinteger
autopilotboolean

Nesta rota o padrão é false.

Response

Teste criado

idstring uuid nullable
campaignIdstring uuid nullable
variantATemplateNamestring required
variantBTemplateNamestring required
metricstring required
samplePctinteger required
splitPctinteger required
decisionWindowMinutesinteger required
autopilotboolean required
winner'A' | 'B' nullable
decidedAtstring date-time nullable
decidedReasonstring nullable
pValuenumber nullable
relativeLiftPctnumber nullable
variantAMetricsJsonstring nullable

JSON serializado em string.

variantBMetricsJsonstring nullable
createdAtstring date-time nullable

Changes

    • info

      api tag Campanhas added

    • info

      api tag campaigns removed

    • info

      added the non-success response with the status

    • breaking

      removed the enum value CLICK_RATE of the request property

    • breaking

      removed the enum value CONVERSION_RATE of the request property

    • breaking

      removed the enum value DELIVERY_RATE of the request property

    • breaking

      removed the enum value READ_RATE of the request property

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to string for status

    • breaking

      the response's property format changed from float to no format for status

    • breaking

      the response's property format changed from float to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new CLICKED enum value to the request property

    • info

      added the new CONVERTED enum value to the request property

    • info

      added the new DELIVERED enum value to the request property

    • info

      added the new READ enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status