Pular para o conteúdo

POST /v1/automations/panorama

POST
/v1/automations/panorama
curl --request POST \
--url https://seu-endereco-da-api/v1/automations/panorama \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "filter": {}, "dia": "example", "disparoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Permissão que a Chave de acesso precisa: Ler disparos automáticos (automations:read).

Media typeapplication/json
object
filter
object
key
additional properties
any
dia
string
disparoId
string format: uuid

Example generated

{
"filter": {},
"dia": "example",
"disparoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Media typeapplication/json
object
ligados
required

How many automations are switched on, cut or not

number
envios
required

Sends inside the cut. It counts sends, not heads: one person reached on two days, or by two automations, is counted twice

number
pessoas
required

How many different people the cut reaches, each counted once

number
custoMicros
required

What those sends cost, in micros, tariff plus markup, as the wallet would be charged

number
enviosSemTarifa
required

Sends no tariff covers, left out of the cost; it is our price list that is missing, not their balance

number
saldoMicros
required

The channel wallet balance in micros, so the screen can say how much of it the week eats

number
semanaAnterior
required

The same count over the seven days before today

number
dias
required

One entry per day ahead, seven of them; the chosen day does not empty the others

Array<object>
object
dia
required

The local day, as yyyy-MM-dd

string
total
required

How many sends the cut makes on that day

number
anterior
required

How many sends the same cut made on the matching day of the week before

number
porDisparo
required

Every switched-on automation, biggest first, even the ones the cut leaves out

Array<object>
object
id
required
string
nome
required
string
envios
required

Sends this automation makes inside the cut, so a row can be clicked to narrow the screen

number
eixos
required

Who receives, by tag and by gender, counted over the sends of the cut

Array<object>
object
chave
required

Etiqueta, sexo, signo, canal, mes_de_aniversario, consentimento, or campo:. The channel axis leaves out whoever has no identifier, so it does not add up to the total

string
rotulo
required
string
disponivel
required

False when the platform field behind it is off; then the screen teaches instead of showing zero

boolean
motivo
required

Why it is unavailable

string
nullable
campoKey
required

The contact field to turn on, when there is one

string
nullable
multivalor
required

True when one contact can land on several values, so the shares add up past the whole

boolean
valores
required
Array<object>
object
valor
required

What the screen sends back as a cut condition

string
rotulo
required

What the person reads

string
total
required
number
fatia
required

Share of the current total, from 0 to 1, so a number says size and not only amount

number
cor
required

The tag colour, when the value has one

string
nullable
recorte
required

The condition that isolates this row, so the screen cuts by exactly what was counted. Null when the axis has no equivalent in the contact filter, which today is only the channel axis

object
field
required

The contact filter field this row cuts by

string
op
required

The operator the contact filter dialect accepts for that field

string
value
required

The value the operator carries

object
apuradoEm
required

When this count was taken, so nobody trusts a dead number

string format: date-time

Example generated

{
"ligados": 1,
"envios": 1,
"pessoas": 1,
"custoMicros": 1,
"enviosSemTarifa": 1,
"saldoMicros": 1,
"semanaAnterior": 1,
"dias": [
{
"dia": "example",
"total": 1,
"anterior": 1
}
],
"porDisparo": [
{
"id": "example",
"nome": "example",
"envios": 1
}
],
"eixos": [
{
"chave": "example",
"rotulo": "example",
"disponivel": true,
"motivo": "example",
"campoKey": "example",
"multivalor": true,
"valores": [
{
"valor": "example",
"rotulo": "example",
"total": 1,
"fatia": 1,
"cor": "example",
"recorte": {
"field": "example",
"op": "example",
"value": {}
}
}
]
}
],
"apuradoEm": "2026-04-15T12:00:00Z"
}