Obtener previsión (forecast)

Este endpoint permite consultar la previsión de medidas (forecast) para un periodo de tiempo no superior a 31 días.

GET /api/v1/business/{businessId}/product/{productId}/forecast/from/{yyyy-MM-dd}/to/{yyyy-MM-dd}

Si los datos incluidos en la petición son correctos, la respuesta contendrá el listado de medidas (previsión) del producto en el intervalo de tiempo definido.

Ejemplo de respuesta

[
    {
        "value": 0.75,
        "from": "2026-08-10T20:30:00.000Z",
        "to": "2026-08-10T20:45:00.000Z",
        "measure": "SALES"
    },
    {
        "value": 0.75,
        "from": "2026-08-10T20:45:00.000Z",
        "to": "2026-08-10T21:00:00.000Z",
        "measure": "SALES"
    },
    {
        "value": 1.25,
        "from": "2026-08-09T22:00:00.000Z",
        "to": "2026-08-09T22:15:00.000Z",
        "measure": "TICKETS"
    },
    {
        "value": 1.25,
        "from": "2026-08-09T22:15:00.000Z",
        "to": "2026-08-09T22:30:00.000Z",
        "measure": "TICKETS"
    }
]
Detalles

  • value: valor numérico de la medida para el intervalo indicado.

  • from: inicio del intervalo al que corresponde el valor, en UTC.

  • to: fin del intervalo al que corresponde el valor, en UTC.

  • measure: nombre configurado en Orquest para el tipo de medida.

Consideraciones

Esta petición devuelve los datos de la previsión de todas las medidas del producto, sin ordenar.

Los datos siempre se devuelven en UTC y en intervalos de 15 minutos, independientemente de cómo se hayan registrado.

Si no hay previsión de medidas para ese intervalo, la petición devolverá un array vacío [].

Filtrar resultados

Debido a que algunos negocios tienen numerosas medidas configuradas, este endpoint posibilita acotar la respuesta y filtrar por tipo. Para ello, será necesario añadir el parámetro demandTypeNames a la URL:

GET /api/v1/business/{businessId}/product/{productId}/forecast/from/{from}/to/{to}?demandTypeNames={demandTypeNames}

Para consultar múltiples tipos de medidas, se pueden incluir varios valores separados por comas.

Ver ejemplo 
GET /api/v1/business/BUSINESSID/product/PRODUCTID/forecast/from/2026-08-15/to/2026-08-31?demandTypeNames=SALES,TICKETS

Fragmento de respuesta:

[
    {
        "value": 0.2334837627981813,
        "from": "2026-08-15T17:30:00.000Z",
        "to": "2026-08-15T17:45:00.000Z",
        "measure": "TICKETS"
    },
    {
        "value": 0.20875953672878728,
        "from": "2026-08-15T17:45:00.000Z",
        "to": "2026-08-15T18:00:00.000Z",
        "measure": "TICKETS"
    },
    {
        "value": 35.21413612846175,
        "from": "2026-08-15T08:00:00.000Z",
        "to": "2026-08-15T08:15:00.000Z",
        "measure": "SALES"
    },
    {
        "value": 32.92768867815087,
        "from": "2026-08-15T08:15:00.000Z",
        "to": "2026-08-15T08:30:00.000Z",
        "measure": "SALES"
    }
]

Si no se especifica el parámetro demandTypeNames, la petición devolverá todas las medidas del producto en el rango de fechas indicado.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

406 Not Acceptable

-

El período indicado entre from y to supera los 30 días permitidos. Se recomienda ajustar el rango de fechas de la consulta.

Enlaces de interés

¿Qué es una medida?

¿Qué es el forecast?

¿Cómo integrar medidas?