Descripción

Este endpoint permite obtener las transiciones de estado de los deals de un flujo dentro de un periodo determinado.

Este endpoint acepta body en formato JSON

Ruta

databridge/consultation

por deprecar: primox/consultation

Método

POST

Autorización

Este endpoint requiere autorización mediante Bearer Token entregado por Keirón.

Parámetros de entrada (Query params y body JSON )

Query params

Nombre del dato Tipo Dato Descripción Requerido
page integer Identificador de la página que se está solicitando. Por defecto “1” para retornar solo pa primera página de resultados No
pageSize integer Define el tamaño de la paginación para recibir resultados. Por defecto “10000” No

Body JSON

Nombre del dato Tipo Dato Descripción Requerido
consultationId uuid Identificador de endpoint. Es único, se da por defecto. Si
exportCsv boolean Define el formato de la respuesta. Por defecto false (formato json). En caso de ser true se exporta como csv. No
flowId uuid El ID del flujo para el cual se quieren obtener las transiciones de los negocios asociados Si
flowName string El Nombre del flujo para el cual se quieren obtener las transiciones de los negocios asociados. Si
timezone string La zona horaria en que se quiere recibir las fechas en formato timezone (tz database) Si
startDate date Fecha de inicio de desde la cual se quiere obtener las transiciones. Si
endDate date Fecha de término hasta la cual se quieren obtener las transiciones. Si

Ejemplo Request URL

<https://api.keiron.cl/databridge/consultation?pageSize=1000&page=2>

“Se solicita recibir la segunda página de información, considerando 1000 registros por página”

Ejemplo Body JSON de entrada


{
  "consultationId": "5367bef9-9bdc-4485-a35b-398c22ff3d21",
  "exportCsv": false,
  "flowId": "9148d6e8-1714-xxxx-xxxx-xxxxxxxxxxxx",
  "flowName": "Clínica Keirón",
  "timezone": "America/Santiago",
  "startDate": "2024-04-01",
  "endDate": "2024-06-06"
}