Pular para o conteúdo

POST /v1/analytics/overview/search

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

Permissão que a Chave de acesso precisa: Relatórios de atendimento (analytics:service), ou Relatórios de vendas (analytics:sales), ou Relatórios de marketing (analytics:marketing).

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

Null without analytics:service

object
total
required
number
delta
required
number
open
required

Null without analytics:service

number
nullable
volume
required

Null without analytics:service

Array<object>
nullable
object
label
required
string
value
required
number
byChannel
required

Null without analytics:service

Array<object>
nullable
object
key
required
string
count
required
number
agents
required

Null without analytics:service

Array<object>
nullable
object
userId
required
string
name
required
string
conversations
required
number
resolved
required
number
won
required

Null without analytics:sales

number
nullable
revenue
required

Null without analytics:sales

number
nullable
sales
required

Null without analytics:sales

object
wonValue
required
number
conversion
required
number
funnel
required
Array<object>
object
stageId
required
string
label
required
string
count
required
number
value
required
number

Example

{
"period": "7"
}