Skip to main content
GET
Consultar campanha

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Path Parameters

id
string<uuid>
required

ID da campanha.

Response

Detalhe

id
string<uuid>
required
name
string
required
status
string
required
templateName
string
required
totalMessages
integer
required
sentCount
integer
required
deliveredCount
integer
required
readCount
integer
required
failedCount
integer
required
clickedCount
integer
required

Cliques em smart links da campanha.

convertedCount
integer
required

Conversões atribuídas por smart links.

convertedValue
number
required
totalCost
number
required
templateBody
string | null
replyCount
integer

Conversas originadas pela campanha.

holdoutCount
integer

Contatos aguardando a vencedora do A/B.

blockedCount
integer

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

blockReasons
object[]
refundCount
integer
refundValue
number

Total estornado para a carteira, em reais.

scheduledAt
string<date-time> | null
startedAt
string<date-time> | null
finishedAt
string<date-time> | null
createdAt
string<date-time> | null