Obtener el resumen del pipeline

Contadores por etapa y totales de importe abierto para las columnas del tablero, además de los totales de ganados y perdidos.

GET https://api.getincloud.ai/v1/pipelines/{pipelineId}/summary

Contadores por etapa y totales de importe abierto para las columnas del tablero, además de los totales de ganados y perdidos.

Cada fila de etapa incluye también closed ({count, amount, mixedCurrency, currency}): los negocios que terminaron en esa etapa durante toda la vida del pipeline. Una etapa de ganado o perdido no contiene negocios abiertos por construcción, por lo que su par count/amount siempre es cero y closed es la única cifra que la describe.

closedOffStage incluye la misma estructura para los negocios cerrados cuya etapa ya no forma parte del pipeline, algo que deja una etapa eliminada después de que se decidieran negocios en ella. Las cifras closed por etapa más closedOffStage siempre suman won más lost; sin el segundo término dejarían de hacerlo sin avisar.

Esos totales se expresan en dos ventanas: won y lost abarcan toda la vida del pipeline, y won30d y lost30d los últimos 30 días, medidos desde la fecha since de la respuesta. Un pipeline archivado se lee con el par de toda la vida: un embudo retirado hace más de un mes tiene una ventana de 30 días vacía, y su historial es justamente lo que conserva el archivado.

wonPrev30d y lostPrev30d incluyen el mismo par para la ventana inmediatamente ANTERIOR a esa, [previousSince, since), que es la referencia con la que se mide una variación. Las dos ventanas son semiabiertas y se encuentran en since, así que ningún negocio se cuenta en ambas. Un periodo en el que no se cerró nada se devuelve como cero en lugar de omitirse, porque "no se cerró nada entonces" y "esto no se midió" son respuestas distintas: no existe un porcentaje entre ningún negocio y cinco, así que quien lea un cero aquí debe omitir la variación en lugar de dividir por él.

También devuelve lostReasonStats: los motivos por los que se perdieron los negocios perdidos, una entrada por motivo con su count y amount de toda la vida, más count30d / amount30d de los que se cerraron dentro de la ventana, ordenados por cantidad y luego por importe. Los negocios cerrados sin motivo se agrupan en una única entrada cuyo reason es null, y esa entrada siempre se devuelve. Un motivo es texto libre, por lo que se ordenan y devuelven como máximo 20 motivos con nombre, y todo lo restante se suma en lostReasonStatsOther ({reasons, count, amount, count30d, amount30d, mixedCurrency, currency, mixedCurrency30d, currency30d}, o null cuando no sobró nada). El resto se calcula restando las entradas listadas de los totales de perdidos en lugar de leer la cola, de modo que ambos siempre suman exactamente lost, y sus mitades de 30 días lost30d.

mixedCurrency incluye un indicador por cada cifra (open, won, lost, won30d, lost30d, wonPrev30d, lostPrev30d), y cada fila de etapa y cada motivo de pérdida incluye el suyo (un motivo de pérdida incluye mixedCurrency30d para su mitad con ventana). Un indicador en true significa que los negocios detrás de ese importe no comparten todos una misma moneda: deal.currency se inicializa con la moneda del pipeline pero puede definirse por negocio, y no se aplica ningún tipo de cambio en ningún punto, por lo que el importe es una suma de unidades distintas y no debe mostrarse como una sola cifra. Un negocio que no declara moneda propia no cuenta como una segunda moneda. La entrada del resto responde esta pregunta de forma conservadora: se obtiene por resta en lugar de leerse, así que informa una sola unidad únicamente cuando todos los negocios perdidos del embudo la comparten.

currencies lo refleja con la unidad en la que ESTÁ cada cifra, y cada fila de etapa y cada motivo de pérdida incluye también su propio currency (y currency30d). Es null exactamente cuando el indicador correspondiente es true. Esto no es lo mismo que currency, la unidad propia del pipeline: un pipeline con precios en EUR cuyos negocios se guardaron todos en USD no mezcla nada, y expresar sus totales en la moneda del pipeline mostraría dólares con un símbolo de euro.

Los agentes restringidos solo ven las cifras de sus propios negocios, y scope indica cuál de los dos casos es la respuesta: account para todo el embudo, agent cuando todas las cifras se han acotado al lector.

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y prueba el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Respuestas

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Get the pipeline board summary
curl --request GET \
  --url https://api.getincloud.ai/v1/pipelines/{pipelineId}/summary \
  --header 'Token: <api token goes here>'