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

Rel. clientes

get
https://{subdominio}.cxm.pipe.run/api/v2/reports/customers
Query Params
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:

  • created_at: Inclusão do cliente
  • first_talk: Primeiro atendimento

Allowed:
string

Nome do cliente

string

ID externo do cliente

string

Número de documento do cliente

string

Telefone do cliente

string

E-mail do cliente

agent_id[]
array of int32s

ID's de agentes fidelizados dos clientes. Use 0 para "Sem fidelização"

agent_id[]
queue_id[]
array of int32s

ID's das filas fidelizadas dos clientes. Use 0 para "Sem fidelização"

queue_id[]
customer_organization_id[]
array of int32s

ID's das organizações

customer_organization_id[]
label_id[]
array of int32s

ID's das etiquetas de cliente

label_id[]
string
enum

Ativar filtro para retornar apenas atendimentos de clientes que possuem um telefone com WhatsApp.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos de clientes que possuem um telefone com SMS.

  • 0: Não
  • 1: Sim

Allowed:
string
enum

Ativar filtro para retornar apenas atendimentos de clientes que possuem um endereço de e-mail.

  • 0: Não
  • 1: Sim

Allowed:
custom_fields[]
array of objects

Objeto com ID e valor dos campos customizados a serem pesquisados

custom_fields[]
Responses

Updated 8 months ago

Language
Credentials
Header
URL
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago