Referência da API (V1.0)
  1. Relatórios

Rel. pesquisas por canal

get
https://{subdominio}.cxm.pipe.run/api/v2/reports/surveys/channel
Query Params
string
enum
required

Tipo de relatório.
Valores permitidos:

  • analytical: Relatório analítico

Allowed:
date-time
required

Data e hora inicial do período.
Formato: AAAA-MM-DD HH:MM

date-time
required

Data e hora final do período.
Formato: AAAA-MM-DD HH:MM

string
enum
required

Tipo de período.
Valores permitidos:

  • talk_start: Início do atendimento
  • talk_end: Final do atendimento

Allowed:
int32
required

ID da pesquisa

channel_id[]
array of int32s

ID's dos canais de atendimento

channel_id[]
int32

ID da conta específica

int32

ID da filial

agent_id[]
array of int32s

ID's dos agentes

agent_id[]
int32

ID do cliente

int32

ID do produto

int32

ID da carteira

queue_id[]
array of int32s

ID's das filas de atendimento

queue_id[]
string

Número do protocolo

event_id[]
array of int32s

ID's das tabulações

event_id[]
hashtag_id[]
array of int32s

ID's das hashtags

hashtag_id[]
string
enum

Ativar filtro para retornar apenas atendimentos encerrados.
Valores permitidos:

  • 0: Somente encerrados sem sucesso
  • 1: Somente encerrados com sucesso
  • 2: Todos os encerrados

Allowed:
string
enum

Tipo de abertura.
Valores permitidos:

  • all: Todos
  • out: Somente ativos
  • in: Somente receptivos

Allowed:
int32

ID da organização do cliente

string

Telefone ou e-mail do cliente

string

ID's dos catálogos de serviço (Separe os ID's com vírgulas)

category_id[]
array of int32s

ID's das categorias

category_id[]
classification[]
array of strings

Classificações CSAT.
Valores permitidos:

  • z: Sem avaliações
  • d: Insatisfeitos (1-2)
  • n: Neutros (3)
  • s: Satisfeitos (4-5)

classification[]
label_id[]
array of int32s

ID'd das etiquetas de clientes

label_id[]
priority_id[]
array of int32s

ID's das prioridades de atendimento

priority_id[]
string
enum

Ativar filtro para retornar apenas atendimentos expirados.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos críticos.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos com anúncios.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos agendados.

  • 0: Não
  • 1: Sim

Allowed:
Responses

Updated 23 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago