Rel. campanhas com retorno

get

https://{subdominio}.cxm.pipe.run/api/v2/reports/campaigns?report_type=replied

Query Params

report_type

string

enum

required

Tipo de relatório.
Valores permitidos:

replied: Relatório de campanhas com retorno
waitingReply: Relatório de campanhas sem retorno

Allowed:

start_date

date-time

required

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

end_date

date-time

required

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

date_range_type

string

enum

required

Tipo de período.
Valores permitidos:

campaign_reply: Retorno do cliente
campaign_sent: Envio da campanha

Allowed:

campaign_id[]

array of int32s

ID's das campanhas

campaign_id[]

channel_id[]

array of int32s

ID's dos canais de retorno

channel_id[]

initial_sender_channel

int32

ID da conta específica de retorno

customer_id

int32

ID do cliente

branch_id

int32

ID da filial

agent_id[]

array of int32s

ID's dos agentes

agent_id[]

product_id

int32

ID do produto

card_id

int32

ID da carteira

queue_id[]

array of int32s

ID's das filas de atendimento

queue_id[]

tracking_number

string

Número do protocolo

event_id[]

array of int32s

ID's das tabulações

event_id[]

priority_id[]

array of int32s

ID's das prioridades de atendimento

priority_id[]

hashtag_id[]

array of int32s

ID's das hashtags

hashtag_id[]

is_finished

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:

customer_organization_id

int32

ID da organização do cliente

string

Telefone ou e-mail do cliente

service_catalog_id

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[]

label_id[]

array of int32s

ID's das etiquetas de cliente

label_id[]

is_critical

string

enum

Ativar filtro para retornar apenas atendimentos críticos.

0: Não
1: Sim

Allowed:

has_schedule

string

enum

Ativar filtro para retornar apenas atendimentos agendados.

0: Não
1: Sim

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401

422422