Upnify Documentación API
CRM · /analitica/secuencias

Analítica

Evidencias de campañas y secuencias

GET/analitica/secuencias

Distingue elegibilidad por etiqueta, participación/control y comunicación. Requiere lote, campaña o intervalo de hasta 366 días. Usa campañas CRM de la cuenta y comunicaciones del buzón propio; no ejecuta inscripciones ni envíos.

Parámetros

NombreTipoValidaciónDescripción
paramsvarchar
paginavarcharRequeridoEntero entre 1 y 2147483647. Página de resultados; no admite descarga ilimitada.
cantidadRegistrosvarcharRequeridoEntero de 1 a 200. Cantidad máxima de filas de la página.
tkContactosvarcharHasta 100 tokens separados por coma, máximo 128 caracteres cada uno y 8192 en total. Los duplicados no multiplican resultados.
fechaIniciovarcharInicio incluido, ISO 8601 con offset; requiere fechaFin. Se requiere un intervalo de hasta 366 días o tkContactos.
fechaFinvarcharFin excluido, ISO 8601 con offset, posterior al inicio y hasta 366 días después. Requiere fechaInicio.
fechaBasevarcharRequeridoevidencia. Conserva la base particular de cada fuente; no inventa una fecha de inscripción.
ordenvarcharRequeridoascendente o descendente por creación, con desempate estable por identidad.
tkCampaniavarcharToken de campaña o secuencia de la cuenta. Inexistente o ajeno devuelve 404.
tipoEvidenciavarcharRequeridotodas, elegibilidad, inscripcion o comunicacion. inscripcion identifica participación/control, sin afirmar ejecución activa.

Respuesta

NombreTipoDescripción
idEvidenciaStringIdentidad estable de etiqueta, membresía, control de pieza o comunicación.
fuenteStringetiqueta, membresiaCampania, controlSecuencia, correo o mensaje.
idRegistroFuenteStringIdentidad opaca del registro fuente.
tipoEvidenciaStringtodas, elegibilidad, inscripcion o comunicacion. inscripcion identifica participación/control, sin afirmar ejecución activa.
criterioStringcoincidenciaEtiquetaYTipoContacto, registroParticipacion, registroControlPieza o registroComunicacion.
tkProspectoStringContacto asociado cuando sólo existe uno en el conjunto consultado; null si hay varios.
tkCampaniaStringToken público de la campaña o secuencia.
tipoCampaniaStringcampania o secuencia.
nombreCampaniaStringTítulo de la campaña o secuencia de la cuenta.
tkPiezaStringToken de pieza relacionado y comprobado dentro de su secuencia; null si no aplica.
tkPiezaSiguienteRegistradaStringToken siguiente explícitamente guardado en el control y perteneciente a la misma secuencia; null si falta. No afirma próxima ejecución.
ordenPiezaFuenteIntegerOrden actual guardado en el catálogo de piezas; no es el paso actual del contacto.
tkEtiquetaStringToken público de la etiqueta.
canalStringcorreo, telefono, visita, WhatsApp, interno o desconocido. En COM se conserva el nombre y código del canal fuente; la clasificación no comprobada queda desconocida.
estadoFuenteObjectIndicadores originales permitidos de la fuente; no se reinterpretan como un estado distinto.
estadoInscripcionStringdesconocido: los registros consultados no demuestran una inscripción durable activa.
pasoActualIntegernull: no se deduce del orden de una pieza pasada.
proximaEjecucionStringnull: no se calcula a partir de intervalos de la configuración.
envioRegistradoBooleantrue si existe fecha de envío guardada, false si sólo hay registro sin fecha de envío; null para otras evidencias.
abiertoBooleanIndicador guardado de apertura; null si no existe. No prueba respuesta humana.
entregadoBooleannull: estas fuentes no acreditan por sí solas entrega.
respuestaHumanaBooleannull: ni apertura ni respuesta técnica del proveedor acreditan respuesta humana.
fechaEvidenciaStringFecha propia de etiquetado, último envío de control o comunicación con zona. Membresía sin fecha queda null.
fechaOriginalStringFecha original del evento, incluso cuando no se puede convertir; puede ser null.
baseTemporalStringHecho de la fecha original: etiquetado, sinFechaInscripcion, ultimoEnvioControl, envio, registroComunicacion o desconocido.
fechaEnvioStringFecha de envío guardada con zona; null si no existe.
coberturaObjectEstado, fuentes consultadas, capacidadesFaltantes e integridadHistorica.
advertenciasArray<Object>Lista de objetos con codigo, mensaje y fuente que explican límites de cobertura.
consistenciaStringSiempre sinInstantanea; los cambios concurrentes pueden alterar la navegación.
fechaGeneracionStringInstante de generación de la respuesta, con zona explícita.
Row-CountIntegerTotal del conjunto autorizado y filtrado, antes de paginar.

Solicitud

Evidencias de campañas y secuencias de un contacto

curl --request GET --url 'https://api.upnify.com/v4/analitica/secuencias?tkContactos=P-EJEMPLO&cantidadRegistros=3' --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

HTTP 200; Row-Count: 4

JSON
[
  [
    {
      "idEvidencia": "registro:28",
      "fuente": "correo",
      "idRegistroFuente": "registro:28",
      "tipoEvidencia": "comunicacion",
      "criterio": "registroComunicacion",
      "tkProspecto": "TK-EJEMPLO-2",
      "tkCampania": "TK-EJEMPLO-29",
      "tipoCampania": "secuencia",
      "nombreCampania": "Secuencia sintetica deshabilitada",
      "tkPieza": "TK-EJEMPLO-30",
      "tkPiezaSiguienteRegistrada": null,
      "ordenPiezaFuente": 1,
      "tkEtiqueta": null,
      "canal": "correo",
      "estadoFuente": {
        "estadoCampania": 0,
        "estado": 2,
        "abierto": 0,
        "clic": 0
      },
      "estadoInscripcion": "desconocido",
      "pasoActual": null,
      "proximaEjecucion": null,
      "envioRegistrado": true,
      "abierto": false,
      "entregado": null,
      "respuestaHumana": null,
      "fechaEvidencia": "2026-09-10T16:00:00Z",
      "fechaOriginal": "2026-09-10T10:00:00",
      "baseTemporal": "envio",
      "fechaEnvio": "2026-09-10T16:00:00Z"
    },
    {
      "idEvidencia": "registro:31",
      "fuente": "controlSecuencia",
      "idRegistroFuente": "registro:31",
      "tipoEvidencia": "inscripcion",
      "criterio": "registroControlPieza",
      "tkProspecto": "TK-EJEMPLO-2",
      "tkCampania": "TK-EJEMPLO-29",
      "tipoCampania": "secuencia",
      "nombreCampania": "Secuencia sintetica deshabilitada",
      "tkPieza": "TK-EJEMPLO-30",
      "tkPiezaSiguienteRegistrada": null,
      "ordenPiezaFuente": 1,
      "tkEtiqueta": "TK-EJEMPLO-32",
      "canal": null,
      "estadoFuente": {
        "estadoCampania": 0,
        "estadoPieza": 0,
        "abierto": 1,
        "sinPiezaSiguienteFuente": true
      },
      "estadoInscripcion": "desconocido",
      "pasoActual": null,
      "proximaEjecucion": null,
      "envioRegistrado": null,
      "abierto": null,
      "entregado": null,
      "respuestaHumana": null,
      "fechaEvidencia": "2026-09-10T15:00:00Z",
      "fechaOriginal": "2026-09-10T09:00:00",
      "baseTemporal": "ultimoEnvioControl",
      "fechaEnvio": null
    },
    {
      "idEvidencia": "registro:33",
      "fuente": "etiqueta",
      "idRegistroFuente": "registro:33",
      "tipoEvidencia": "elegibilidad",
      "criterio": "coincidenciaEtiquetaYTipoContacto",
      "tkProspecto": "TK-EJEMPLO-2",
      "tkCampania": "TK-EJEMPLO-29",
      "tipoCampania": "secuencia",
      "nombreCampania": "Secuencia sintetica deshabilitada",
      "tkPieza": null,
      "tkPiezaSiguienteRegistrada": null,
      "ordenPiezaFuente": null,
      "tkEtiqueta": "TK-EJEMPLO-32",
      "canal": null,
      "estadoFuente": {
        "estadoCampania": 0,
        "pausado": 1,
        "recibirCorreos": 0
      },
      "estadoInscripcion": "desconocido",
      "pasoActual": null,
      "proximaEjecucion": null,
      "envioRegistrado": null,
      "abierto": null,
      "entregado": null,
      "respuestaHumana": null,
      "fechaEvidencia": "2026-09-10T14:00:00Z",
      "fechaOriginal": "2026-09-10T08:00:00",
      "baseTemporal": "etiquetado",
      "fechaEnvio": null
    }
  ],
  [
    {
      "cobertura": {
        "estado": "parcial",
        "fuentes": [
          "etiqueta",
          "membresiaCampania",
          "controlSecuencia",
          "correo",
          "mensaje"
        ],
        "capacidadesFaltantes": [
          "consentimientoVerificable",
          "estadoInscripcionDurable",
          "pasoActual",
          "proximaEjecucion",
          "fechaInscripcionCampania",
          "comunicacionesOtrosBuzones",
          "historialEliminaciones"
        ],
        "integridadHistorica": "desconocida"
      },
      "advertencias": [
        {
          "codigo": "EVIDENCIAS_DISTINTAS",
          "mensaje": "Coincidir con reglas de etiqueta no acredita permiso de envio. La participacion y el control de piezas no prueban una inscripcion activa. Las comunicaciones cubren el buzon propio.",
          "fuente": "secuencias"
        },
        {
          "codigo": "FECHAS_PARCIALES",
          "mensaje": "Etiquetado y ultimo envio de control son fechas de esas evidencias, no de inscripcion. La membresia sin fecha queda fuera de filtros temporales.",
          "fuente": "secuencias"
        }
      ],
      "consistencia": "sinInstantanea",
      "fechaGeneracion": "2026-09-21T18:00:00Z"
    }
  ]
]