Pular para o conteúdo

POST /v1/automations/base

POST
/v1/automations/base
curl --request POST \
--url https://seu-endereco-da-api/v1/automations/base \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "filter": {} }'

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

Media typeapplication/json
object
filter
object
key
additional properties
any

Example generated

{
"filter": {}
}
Media typeapplication/json
object
total
required

How many contacts the cut holds; the whole base when there is no cut

number
eixos
required
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
daFoto
required

True when the answer came from the daily picture, because the base is above the ceiling

boolean
eixosOmitidos
required

How many list-field axes were left out of the answer

number
motivo
required

Foto_ainda_nao_tirada while the daily picture of a base above the ceiling has not been taken yet

string
nullable

Example generated

{
"total": 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",
"daFoto": true,
"eixosOmitidos": 1,
"motivo": "example"
}