Analítica

Captaciones por periodo y contacto

GET/analitica/captaciones

Consulta solicitudes de integración y activaciones de widgets con identidad, fechas y atribución propias. Requiere un periodo de hasta 366 días o un lote de contactos. Devuelve [filas, [metadatos]] y Row-Count del conjunto consultado.

Parámetros

Nombre	Tipo	Validación	Descripción
`params`	varchar
`pagina`	varchar	Requerido	Entero entre 1 y 2147483647. Página de resultados; no admite descarga ilimitada.
`cantidadRegistros`	varchar	Requerido	Entero de 1 a 200. Cantidad máxima de filas de la página.
`tkContactos`	varchar		Hasta 100 tokens separados por coma, máximo 128 caracteres cada uno y 8192 en total. Los duplicados no multiplican resultados.
`fechaInicio`	varchar		Inicio incluido, ISO 8601 con offset; requiere fechaFin. Se requiere un intervalo de hasta 366 días o tkContactos.
`fechaFin`	varchar		Fin excluido, ISO 8601 con offset, posterior al inicio y hasta 366 días después. Requiere fechaInicio.
`fechaBase`	varchar	Requerido	Valor habilitado: recepcion. Aplica a la solicitud de integración o a la activación del widget.
`orden`	varchar	Requerido	ascendente o descendente por creación, con desempate estable por identidad.
`fuente`	varchar	Requerido	integracion, widget o todas. Widgets requiere Engage habilitado en la cuenta y acceso del usuario. La falta de permiso devuelve 403.
`idFuente`	varchar		Identidad pública de la fuente: integracion: seguido de su identificador opaco, o token del widget. No se acepta un token autenticador de integración.
`existente`	varchar		true, false o desconocido; omitir para todos. Widgets sólo conserva desconocido. Preexistencia no demuestra actualización.
`paginaEntrada`	varchar		Ruta de entrada exacta de la activación, máximo 2048 caracteres. Sólo compatible con fuente=widget; independiente de pagina.
`permitirParciales`	varchar	Requerido	true o false. Con fuente=todas permite omitir widgets cuando Engage no está habilitado en la cuenta, con advertencia. No omite una denegación de permiso ni un fallo inesperado.

Respuesta

Nombre	Tipo	Descripción
`idCaptacion`	String	Identidad estable de cada captación; varias pueden pertenecer al mismo contacto.
`fuente`	String	integracion o widget.
`idRegistroFuente`	String	Identidad opaca del registro en su fuente.
`idFuente`	String	Identidad pública de la integración o token del widget; null si ya no se puede resolver.
`tkProspecto`	String	Contacto autorizado relacionado; null para registros sin contacto vinculado.
`fechaRecepcion`	String	Instante registrado de recepción o activación, con zona explícita; puede ser null.
`fechaProcesamiento`	String	Fin de procesamiento registrado; null si no existe, incluido widget.
`fechaOriginal`	String	Fecha fuente sin normalizar; puede ser null.
`baseTemporal`	String	recepcion, activacion o desconocido si no hay fecha registrada.
`existente`	Boolean	Preexistencia registrada, o null si se desconoce. Widgets devuelve null.
`resultado`	String	nuevo, existente o desconocido según evidencia. No se deduce actualizado de la preexistencia.
`paginaEntrada`	String	Ruta de la activación; null si no está registrada o no corresponde a la fuente.
`atribucion`	Object	UTMs e IDs de clic registrados en esta captación; sus campos ausentes son null. No se copian los del contacto.
`cobertura`	Object	Estado parcial, fuente, capacidadesFaltantes e integridadHistorica de este registro.
`cobertura`	Object	Estado, fuentes consultadas, capacidadesFaltantes e integridadHistorica.
`advertencias`	Array<Object>	Lista de objetos con codigo, mensaje y fuente que explican límites de cobertura.
`consistencia`	String	Siempre sinInstantanea; los cambios concurrentes pueden alterar la navegación.
`fechaGeneracion`	String	Instante de generación de la respuesta, con zona explícita.
`Row-Count`	Integer	Total del conjunto autorizado y filtrado, antes de paginar.
`atribucion.alcanceAtribucion`	String	captacion: atribución propia del registro consultado.
`atribucion.utmFuente`	String	Valor de utmFuente guardado en esta captación; null si no está registrado.
`atribucion.utmMedio`	String	Valor de utmMedio guardado en esta captación; null si no está registrado.
`atribucion.utmCampania`	String	Valor de utmCampania guardado en esta captación; null si no está registrado.
`atribucion.utmTermino`	String	Valor de utmTermino guardado en esta captación; null si no está registrado.
`atribucion.utmContenido`	String	Valor de utmContenido guardado en esta captación; null si no está registrado.
`atribucion.utmGclid`	String	Valor de utmGclid guardado en esta captación; null si no está registrado.
`atribucion.utmGbraid`	String	Valor de utmGbraid guardado en esta captación; null si no está registrado.
`atribucion.utmWbraid`	String	Valor de utmWbraid guardado en esta captación; null si no está registrado.
`atribucion.utmFbclid`	String	Valor de utmFbclid guardado en esta captación; null si no está registrado.
`atribucion.utmReferente`	String	Valor de utmReferente guardado en esta captación; null si no está registrado.

Solicitud

curl --request GET --url 'https://api.upnify.com/v4/analitica/captaciones?tkContactos=P-EJEMPLO&fuente=todas' --header 'token: 00000000-0000-4000-8000-000000000001'const respuesta = await fetch("https://api.upnify.com/v4/analitica/captaciones?tkContactos=P-EJEMPLO&fuente=todas", { headers: { token: "00000000-0000-4000-8000-000000000001" } });
console.log(await respuesta.json());const respuesta = await fetch("https://api.upnify.com/v4/analitica/captaciones?tkContactos=P-EJEMPLO&fuente=todas", { headers: { token: "00000000-0000-4000-8000-000000000001" } });
console.log(await respuesta.json());import requests

respuesta = requests.get("https://api.upnify.com/v4/analitica/captaciones?tkContactos=P-EJEMPLO&fuente=todas", headers={"token": "00000000-0000-4000-8000-000000000001"})
respuesta.raise_for_status()
print(respuesta.json())package main

import (
 "net/http"
 "io"
 "os"
)

func main() {
 solicitud, err := http.NewRequest(http.MethodGet, "https://api.upnify.com/v4/analitica/captaciones?tkContactos=P-EJEMPLO&fuente=todas", nil)
 if err != nil { panic(err) }
 solicitud.Header.Set("token", "00000000-0000-4000-8000-000000000001")
 respuesta, err := http.DefaultClient.Do(solicitud)
 if err != nil { panic(err) }
 defer respuesta.Body.Close()
 io.Copy(os.Stdout, respuesta.Body)
}using System;
using System.Net.Http;

using var cliente = new HttpClient();
using var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://api.upnify.com/v4/analitica/captaciones?tkContactos=P-EJEMPLO&fuente=todas");
solicitud.Headers.Add("token", "00000000-0000-4000-8000-000000000001");
using var respuesta = await cliente.SendAsync(solicitud);
respuesta.EnsureSuccessStatusCode();
Console.WriteLine(await respuesta.Content.ReadAsStringAsync());

Respuesta

[
  [
    {
      "idCaptacion": "integracion:1",
      "fuente": "integracion",
      "idRegistroFuente": "integracion:1",
      "idFuente": "integracion:1",
      "tkProspecto": "P-EJEMPLO",
      "fechaRecepcion": "2026-09-10T18:00:00Z",
      "fechaProcesamiento": null,
      "fechaOriginal": "2026-09-10T12:00:00",
      "baseTemporal": "recepcion",
      "existente": null,
      "resultado": "desconocido",
      "paginaEntrada": null,
      "atribucion": {
        "alcanceAtribucion": "captacion",
        "utmFuente": null,
        "utmMedio": null,
        "utmCampania": null,
        "utmTermino": null,
        "utmContenido": null,
        "utmGclid": null,
        "utmGbraid": null,
        "utmWbraid": null,
        "utmFbclid": null,
        "utmReferente": null
      },
      "cobertura": {
        "estado": "parcial",
        "capacidadesFaltantes": [
          "rechazosNoPersistidos",
          "contactosSinAccesoOEliminados"
        ],
        "fuentes": [
          "integracion"
        ],
        "integridadHistorica": "desconocida"
      }
    },
    {
      "idCaptacion": "integracion:2",
      "fuente": "integracion",
      "idRegistroFuente": "integracion:2",
      "idFuente": "integracion:1",
      "tkProspecto": "P-EJEMPLO",
      "fechaRecepcion": "2026-09-10T17:00:00Z",
      "fechaProcesamiento": "2026-09-10T17:00:01Z",
      "fechaOriginal": "2026-09-10T11:00:00",
      "baseTemporal": "recepcion",
      "existente": true,
      "resultado": "existente",
      "paginaEntrada": null,
      "atribucion": {
        "alcanceAtribucion": "captacion",
        "utmFuente": null,
        "utmMedio": null,
        "utmCampania": null,
        "utmTermino": null,
        "utmContenido": null,
        "utmGclid": null,
        "utmGbraid": null,
        "utmWbraid": null,
        "utmFbclid": null,
        "utmReferente": null
      },
      "cobertura": {
        "estado": "parcial",
        "capacidadesFaltantes": [
          "rechazosNoPersistidos",
          "contactosSinAccesoOEliminados"
        ],
        "fuentes": [
          "integracion"
        ],
        "integridadHistorica": "desconocida"
      }
    },
    {
      "idCaptacion": "widget:3",
      "fuente": "widget",
      "idRegistroFuente": "widget:3",
      "idFuente": "W-EJEMPLO",
      "tkProspecto": "P-EJEMPLO",
      "fechaRecepcion": "2026-09-10T17:00:00Z",
      "fechaProcesamiento": null,
      "fechaOriginal": "2026-09-10T11:00:00",
      "baseTemporal": "activacion",
      "existente": null,
      "resultado": "desconocido",
      "paginaEntrada": "/demo",
      "atribucion": {
        "alcanceAtribucion": "captacion",
        "utmFuente": null,
        "utmMedio": null,
        "utmCampania": null,
        "utmTermino": null,
        "utmContenido": null,
        "utmGclid": null,
        "utmGbraid": null,
        "utmWbraid": null,
        "utmFbclid": null,
        "utmReferente": null
      },
      "cobertura": {
        "estado": "parcial",
        "capacidadesFaltantes": [
          "rechazosNoPersistidos",
          "contactosSinAccesoOEliminados"
        ],
        "fuentes": [
          "widget"
        ],
        "integridadHistorica": "desconocida"
      }
    },
    {
      "idCaptacion": "integracion:4",
      "fuente": "integracion",
      "idRegistroFuente": "integracion:4",
      "idFuente": "integracion:1",
      "tkProspecto": "P-EJEMPLO",
      "fechaRecepcion": "2026-09-10T16:00:00Z",
      "fechaProcesamiento": "2026-09-10T16:00:01Z",
      "fechaOriginal": "2026-09-10T10:00:00",
      "baseTemporal": "recepcion",
      "existente": false,
      "resultado": "nuevo",
      "paginaEntrada": null,
      "atribucion": {
        "alcanceAtribucion": "captacion",
        "utmFuente": "integracion-sintetica",
        "utmMedio": null,
        "utmCampania": null,
        "utmTermino": null,
        "utmContenido": null,
        "utmGclid": null,
        "utmGbraid": "GBRAID-CAPTACION",
        "utmWbraid": null,
        "utmFbclid": null,
        "utmReferente": null
      },
      "cobertura": {
        "estado": "parcial",
        "capacidadesFaltantes": [
          "rechazosNoPersistidos",
          "contactosSinAccesoOEliminados"
        ],
        "fuentes": [
          "integracion"
        ],
        "integridadHistorica": "desconocida"
      }
    },
    {
      "idCaptacion": "widget:5",
      "fuente": "widget",
      "idRegistroFuente": "widget:5",
      "idFuente": "W-EJEMPLO",
      "tkProspecto": "P-EJEMPLO",
      "fechaRecepcion": "2026-09-10T16:00:00Z",
      "fechaProcesamiento": null,
      "fechaOriginal": "2026-09-10T10:00:00",
      "baseTemporal": "activacion",
      "existente": null,
      "resultado": "desconocido",
      "paginaEntrada": "/demo",
      "atribucion": {
        "alcanceAtribucion": "captacion",
        "utmFuente": "widget-sintetico",
        "utmMedio": null,
        "utmCampania": null,
        "utmTermino": null,
        "utmContenido": null,
        "utmGclid": null,
        "utmGbraid": null,
        "utmWbraid": null,
        "utmFbclid": null,
        "utmReferente": null
      },
      "cobertura": {
        "estado": "parcial",
        "capacidadesFaltantes": [
          "rechazosNoPersistidos",
          "contactosSinAccesoOEliminados"
        ],
        "fuentes": [
          "widget"
        ],
        "integridadHistorica": "desconocida"
      }
    }
  ],
  [
    {
      "cobertura": {
        "estado": "parcial",
        "fuentes": [
          "integracion",
          "widget"
        ],
        "capacidadesFaltantes": [
          "rechazosNoPersistidos",
          "contactosSinAccesoOEliminados"
        ],
        "integridadHistorica": "desconocida"
      },
      "advertencias": [
        {
          "codigo": "HISTORICO_PARCIAL",
          "mensaje": "Se consultan registros persistidos y contactos autorizados; no se reconstruyen rechazos, contactos eliminados ni fechas ausentes.",
          "fuente": "integracion"
        },
        {
          "codigo": "FECHA_ACTIVACION_OBSERVADA",
          "mensaje": "La fecha almacenada de activacion puede haberse actualizado al vincular el contacto; no acredita un historico de cambios.",
          "fuente": "widget"
        }
      ],
      "consistencia": "sinInstantanea",
      "fechaGeneracion": "2026-09-21T18:00:00Z"
    }
  ]
]

Captaciones por periodo y contacto

Parámetros

Respuesta

Solicitud

Captaciones del contacto en ambas fuentes

Respuesta

HTTP 200; Row-Count: 5