ARararahq
Campanhas

Consultar campanha

Changed on

Campanha com as métricas agregadas. clickedCount e convertedCount dependem de Smart Links. Para acompanhar mensagem a mensagem, use o webhook message.status_updated; o fim da campanha gera o evento campaign.completed. Permissão: READ.

get/v1/campaigns/{id}

Request

Path parameters

idstring uuid required

ID da campanha.

Response

Detalhe

idstring uuid required
namestring required
statusstring required
templateNamestring required
templateBodystring nullable
totalMessagesinteger required
sentCountinteger required
deliveredCountinteger required
readCountinteger required
failedCountinteger required
clickedCountinteger required

Cliques em smart links da campanha.

convertedCountinteger required

Conversões atribuídas por smart links.

convertedValuenumber required
replyCountinteger

Conversas originadas pela campanha.

holdoutCountinteger

Contatos aguardando a vencedora do A/B.

blockedCountinteger

Contatos bloqueados no envio (opt-out, número inválido, limite de frequência).

refundCountinteger
refundValuenumber

Total estornado para a carteira, em reais.

totalCostnumber required
scheduledAtstring date-time nullable
startedAtstring date-time nullable
finishedAtstring date-time nullable
createdAtstring date-time nullable

Example response

{
  "id": "7b3789fb-4c5d-6789-abcd-ef0123456789",
  "name": "Black Friday 2026",
  "status": "COMPLETED_WITH_ERRORS",
  "templateName": "bf_oferta_geral",
  "templateBody": "Oi {{1}}, oferta de {{2}}% só hoje!",
  "totalMessages": 50000,
  "sentCount": 48500,
  "deliveredCount": 47200,
  "readCount": 38900,
  "failedCount": 900,
  "clickedCount": 4120,
  "convertedCount": 312,
  "convertedValue": 87650,
  "replyCount": 1840,
  "holdoutCount": 0,
  "blockedCount": 600,
  "blockReasons": [
    {
      "motivo": "Contato pediu para não receber",
      "quantidade": 600
    }
  ],
  "refundCount": 1500,
  "refundValue": 575.25,
  "totalCost": 19175,
  "scheduledAt": null,
  "startedAt": "2026-11-27T18:00:12Z",
  "finishedAt": "2026-11-27T18:23:14Z",
  "createdAt": "2026-11-27T18:00:00Z"
}

Changes

  • d576cd28afc0Revision changes
    • info

      api tag Campanhas added

    • info

      api tag campaigns removed

    • info

      added the non-success response with the status

  • 372d8c2e735dRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property format changed from float to no format for 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

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

    • 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

    • 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

    • info

      added the required property to the response with the status