Pular para o conteúdo

POST /v1/analytics/automacao/search

POST
/v1/analytics/automacao/search
curl --request POST \
--url https://seu-endereco-da-api/v1/analytics/automacao/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "window": "current", "period": "7", "filter": {}, "origin": "all" }'

Permissão que a Chave de acesso precisa: Relatórios de marketing (analytics:marketing).

Media typeapplication/json
object
window
string
Allowed values: current previous
period
string
Allowed values: 7 30 90
filter
object
key
additional properties
any
origin
string
Allowed values: all self goal
Media typeapplication/json
object
origin
required

Self: a IA pegou sozinha (sem objetivo); goal: o atendente passou para a IA

string
Allowed values: all self goal
kpis
required
object
automated
required
number
containmentPct
required
number
handoffPct
required
number
minutesSaved
required
number
intents
required
number
goals
required
object
given
required

Objetivos dados no periodo (criados na janela)

number
completed
required
number
completedPct
required
number
returned
required
number
returnedPct
required
number
inProgress
required

Conduzindo ou pausados agora

number
cancelled
required

Encerrados pelo atendente (assumiu ou cancelou)

number
minutesSaved
required

Minutos economizados pelas conversas com objetivo cumprido, ja somados em kpis.minutesSaved

number
series
required
Array<object>
object
label
required
string
value
required
number
split
required

Ia/hu/ab: execucoes sem objetivo; oc/dv: objetivos cumpridos e devolvidos

Array<object>
object
key
required
string
label
required
string
value
required
number
color
required
string
topIntents
required
Array<object>
object
name
required
string
agent
required
string
count
required
number
resolvedPct
required
number
byAgent
required
Array<object>
object
agentId
required
string format: uuid
name
required
string
conversations
required
number
containmentPct
required
number
handoffs
required
number
goals
required

Objetivos dados a este agente no periodo

number
goalsCompletedPct
required

Percentual desses objetivos cumpridos

number
unansweredQuestions
required

Perguntas sem resposta ainda abertas que este agente registrou durante os objetivos do periodo

number
goalsByKind
required
Array<object>
object
kind
required
string
Allowed values: agendar fechar_venda cobrar recuperar_carrinho coletar_dados livre
label
required
string
given
required
number
completed
required
number
completedPct
required
number
avgMinutesToComplete
required

Media de minutos do inicio ao fim dos objetivos cumpridos

number
nullable
valueCents
required

Centavos gerados durante o objetivo (do inicio ao fim, ou ate agora se ativo), contato do objetivo: negocios ganhos (Deal.wonAt) para fechar_venda e recuperar_carrinho, cobrancas pagas e nao estornadas (Charge.paidAt) para cobrar; 0 nos demais

number
valueSources
required
Array<string>
Allowed values: won_deals paid_charges
goalReturns
required
object
reasons
required
Array<object>
object
reason
required
string
Allowed values: fora_do_limite pediu_pessoa nao_soube sumiu limite_mensagens_prazo reclamacao
label
required
string
count
required
number
unansweredQuestions
required

Perguntas sem resposta ainda abertas que o agente registrou na conversa durante os objetivos do periodo

number

Example

{
"origin": "all",
"goalsByKind": [
{
"kind": "agendar",
"valueSources": [
"won_deals"
]
}
],
"goalReturns": {
"reasons": [
{
"reason": "fora_do_limite"
}
]
}
}