Analítica

Oportunidades por fecha del hecho

GET/analitica/oportunidades

Lista oportunidades autorizadas abiertas, ganadas y perdidas. fechaBase selecciona creación, ganancia o pérdida; la inclusión de productos mantiene una sola fila e importe por oportunidad.

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.
`tkUsuario`	varchar		Identificador del responsable; no amplía permisos.
`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	creacion (default), ganada o perdida; aplica el intervalo a ese hecho.
`orden`	varchar	Requerido	ascendente o descendente por creación, con desempate estable por identidad.
`incluir`	varchar		productos o vacío. La colección se pagina por separado y no multiplica las filas del padre.
`tkOportunidad`	varchar		Token de oportunidad concreta autorizada; inexistente o sin permiso devuelve 404.
`paginaRelacion`	varchar	Requerido	Página de productos desde 1, default 1. Una página posterior exige tkVenta o tkOportunidad de un único padre y el include productos.
`cantidadRegistrosRelacion`	varchar	Requerido	Entre 1 y 100, default 20. Requiere incluir=productos.
`estado`	varchar	Requerido	todos, abierta, ganada o perdida. Se conservan flags contradictorios como desconocido al consultar todos.
`tkFase`	varchar		Token de la fase actual del contacto.

Respuesta

Nombre	Tipo	Descripción
`tkOportunidad`	String	Oportunidad relacionada y perteneciente al contacto, o null.
`tkProspecto`	String	Contacto asociado cuando sólo existe uno en el conjunto consultado; null si hay varios.
`fuente`	String	oportunidad.
`idRegistroFuente`	String	Identidad opaca del registro fuente.
`tkEmpresa`	String	Token de la empresa comercial; null si falta o no existe permiso sobre ella.
`tkUsuario`	String	Token del responsable principal almacenado; puede ser null.
`tkFase`	String	Token de fase actual; puede ser null.
`fase`	String	Nombre de la fase guardada; puede ser null.
`concepto`	String	Concepto comercial guardado.
`estado`	String	abierta, ganada, perdida o desconocido si los flags originales son contradictorios.
`estadoFuente`	Object	Indicadores originales permitidos de la fuente; no se reinterpretan como un estado distinto.
`importe`	Number	Monto propio del padre, una sola vez por fila. No se suma por producto o enlace financiero.
`subtotal`	Number	Subtotal propio guardado, sin reconstrucción.
`descuento`	Number	Descuento guardado en la entidad.
`impuestos`	Number	Impuestos trasladados guardados.
`impuestosRetenidos`	Number	Impuestos retenidos guardados; null si no existen.
`moneda`	String	Código de moneda de la entidad; null si no se puede resolver dentro de la cuenta.
`tkMoneda`	String	Token público de la moneda de la cuenta.
`tipoCambio`	Number	Tipo de cambio persistido; no equivale a una conversión histórica reconstruida.
`motivoPerdida`	String	Motivo guardado de pérdida; null si no existe.
`fechaCreacion`	String	Instante de creación con zona explícita; puede ser null.
`fechaCierrePrevisto`	String	Fecha prevista guardada, con zona; no demuestra un cierre real.
`fechaGanada`	String	Fecha guardada de ganancia con zona.
`fechaPerdida`	String	Fecha guardada de pérdida con zona.
`fechaActualizacion`	String	Fecha de modificación de esta fuente cuando existe; de otro modo null.
`fechaOriginal`	String	Fecha original del evento, incluso cuando no se puede convertir; puede ser null.
`baseTemporal`	String	Hecho de la fecha original: creacion, ganada, perdida o desconocido.
`productos`	Object	null salvo incluir=productos. Contiene datos, pagina, cantidadRegistros, totalRegistros y hayMas. datos incluye idRelacion, tkRelacion, tkProducto, descripcion, cantidad, precioUnitario, subtotal, descuento, importe, moneda y tipoCambio; son valores de las líneas guardadas. La continuación requiere un único padre. Un catálogo eliminado conserva la línea y puede dejar tkProducto=null.
`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.

Solicitud

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

respuesta = requests.get("https://api.upnify.com/v4/analitica/oportunidades?tkContactos=P-EJEMPLO&cantidadRegistros=3", 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/oportunidades?tkContactos=P-EJEMPLO&cantidadRegistros=3", 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/oportunidades?tkContactos=P-EJEMPLO&cantidadRegistros=3");
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

[
  [
    {
      "tkOportunidad": "TK-EJEMPLO-1",
      "tkProspecto": "TK-EJEMPLO-2",
      "fuente": "oportunidad",
      "idRegistroFuente": "registro:3",
      "tkEmpresa": "TK-EJEMPLO-4",
      "tkUsuario": "TK-EJEMPLO-5",
      "tkFase": "TK-EJEMPLO-6",
      "fase": "Fase de ejemplo",
      "concepto": "Abierta sintetica",
      "estado": "abierta",
      "estadoFuente": {
        "ganada": 0,
        "perdida": 0
      },
      "importe": 300,
      "subtotal": 300,
      "descuento": 0,
      "impuestos": 0,
      "impuestosRetenidos": null,
      "moneda": "MXN",
      "tkMoneda": "TK-EJEMPLO-7",
      "tipoCambio": 1,
      "motivoPerdida": null,
      "fechaCreacion": "2026-01-01T06:00:00Z",
      "fechaCierrePrevisto": null,
      "fechaGanada": null,
      "fechaPerdida": null,
      "fechaActualizacion": "2026-09-21T18:00:00Z",
      "fechaOriginal": "2026-01-01T00:00:00",
      "baseTemporal": "creacion",
      "productos": null
    },
    {
      "tkOportunidad": "TK-EJEMPLO-8",
      "tkProspecto": "TK-EJEMPLO-2",
      "fuente": "oportunidad",
      "idRegistroFuente": "registro:9",
      "tkEmpresa": "TK-EJEMPLO-4",
      "tkUsuario": "TK-EJEMPLO-5",
      "tkFase": "TK-EJEMPLO-6",
      "fase": "Fase de ejemplo",
      "concepto": "Ganada sintetica",
      "estado": "ganada",
      "estadoFuente": {
        "ganada": 1,
        "perdida": 0
      },
      "importe": 300,
      "subtotal": 300,
      "descuento": 0,
      "impuestos": 0,
      "impuestosRetenidos": null,
      "moneda": "MXN",
      "tkMoneda": "TK-EJEMPLO-7",
      "tipoCambio": 1,
      "motivoPerdida": null,
      "fechaCreacion": "2026-01-01T06:00:00Z",
      "fechaCierrePrevisto": null,
      "fechaGanada": "2026-09-12T06:00:00Z",
      "fechaPerdida": null,
      "fechaActualizacion": "2026-09-21T18:00:00Z",
      "fechaOriginal": "2026-01-01T00:00:00",
      "baseTemporal": "creacion",
      "productos": null
    },
    {
      "tkOportunidad": "TK-EJEMPLO-10",
      "tkProspecto": "TK-EJEMPLO-2",
      "fuente": "oportunidad",
      "idRegistroFuente": "registro:11",
      "tkEmpresa": "TK-EJEMPLO-4",
      "tkUsuario": "TK-EJEMPLO-5",
      "tkFase": "TK-EJEMPLO-6",
      "fase": "Fase de ejemplo",
      "concepto": "Perdida sintetica",
      "estado": "perdida",
      "estadoFuente": {
        "ganada": 0,
        "perdida": 1
      },
      "importe": 300,
      "subtotal": 300,
      "descuento": 0,
      "impuestos": 0,
      "impuestosRetenidos": null,
      "moneda": "MXN",
      "tkMoneda": "TK-EJEMPLO-7",
      "tipoCambio": 1,
      "motivoPerdida": null,
      "fechaCreacion": "2026-01-01T06:00:00Z",
      "fechaCierrePrevisto": null,
      "fechaGanada": null,
      "fechaPerdida": "2026-09-12T06:00:00Z",
      "fechaActualizacion": "2026-09-21T18:00:00Z",
      "fechaOriginal": "2026-01-01T00:00:00",
      "baseTemporal": "creacion",
      "productos": null
    }
  ],
  [
    {
      "cobertura": {
        "estado": "parcial",
        "fuentes": [
          "oportunidad"
        ],
        "capacidadesFaltantes": [
          "historialCompletoEstados",
          "conversionMonedaHistorica"
        ],
        "integridadHistorica": "desconocida"
      },
      "advertencias": [
        {
          "codigo": "IMPORTES_POR_OPORTUNIDAD",
          "mensaje": "Cada oportunidad conserva su importe; productos se paginan por separado. No se convierte moneda ni se suman oportunidades y ventas como ingresos independientes.",
          "fuente": "oportunidad"
        }
      ],
      "consistencia": "sinInstantanea",
      "fechaGeneracion": "2026-09-21T18:00:00Z"
    }
  ]
]

Oportunidades por fecha del hecho

Parámetros

Respuesta

Solicitud

Oportunidades por fecha del hecho de un contacto

Respuesta

HTTP 200; Row-Count: 3