OrderDashboard

Estadísticas de órdenes precalculadas para una compañía o un comercio, por periodo. Es de sólo lectura (endpoints order-dashboards/*); cada fila guarda el bloque de métricas en payload.

Periodos y propagación

type es day, week, month o year. Al crearse un dashboard diario se crean/actualizan también el mensual y el anual correspondientes. Los endpoints today, days, months y years devuelven, respectivamente, el del día en curso y los listados por periodo.

Versionado

version permite invalidar el payload cacheado: al leer un dashboard se compara con la versión vigente (que para semana/mes/año depende de cuántos sub-periodos existen) y, si quedó obsoleto, se regenera. available indica si el payload ya está calculado.

Estructura de Datos

Atributo Tipo Descripción
id int
type string Periodo del dashboard: day, week, month o year.
date string Fecha de referencia del periodo.
time_zone string Zona horaria con la que se calcularon las métricas.
version int Versión del payload; se usa para detectar y regenerar datos obsoletos.
payload array Bloque de métricas del periodo.
available bool true si el payload ya está calculado y disponible.
created_at datetime\|null Fecha de creación.
updated_at datetime\|null Fecha de última modificación.
company_id int Compañía del dashboard (oculto en la respuesta).
branch_id int\|null Comercio del dashboard; null si es de toda la compañía.
allLogs ApiLog> Registros de auditoría de la API, incluidos los internos.
logs ApiLog> Registros de auditoría de la API visibles.

Ver Json

Endpoints

Listar OrderDashboard

Dashboards de órdenes por día

{info} Soporta: Paginación

Devuelve los OrderDashboard diarios de la compañía.

Método URI Cabeceras
GET /companies/{companyId}/order-dashboards/days Authorization 
{
    "month": "required|integer|min:1|max:12",
    "year": "required|integer|min:2017"
}

Dashboards de órdenes por mes

{info} Soporta: Paginación

Devuelve los OrderDashboard mensuales de la compañía.

Método URI Cabeceras
GET /companies/{companyId}/order-dashboards/months Authorization 
{
    "year": "required|integer|min:2017"
}

Dashboards de órdenes por año

{info} Soporta: Paginación

Devuelve los OrderDashboard anuales de la compañía.

Método URI Cabeceras
GET /companies/{companyId}/order-dashboards/years Authorization

Dashboards de órdenes por día

{info} Soporta: Paginación Filters Carga dinámica

Devuelve los OrderDashboard diarios del comercio.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/order-dashboards/days Authorization 
{
    "month": "required|integer|min:1|max:12",
    "year": "required|integer|min:2017"
}

Dashboards de órdenes por mes

{info} Soporta: Paginación Filters Carga dinámica

Devuelve los OrderDashboard mensuales del comercio.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/order-dashboards/months Authorization 
{
    "year": "required|integer|min:2017"
}

Dashboards de órdenes por año

{info} Soporta: Paginación Filters Carga dinámica

Devuelve los OrderDashboard anuales del comercio.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/order-dashboards/years Authorization

Mostrar OrderDashboard

Dashboard de órdenes de hoy

{info} Soporta: Carga dinámica

Devuelve el OrderDashboard del día en curso de la compañía.

Método URI Cabeceras
GET /companies/{companyId}/order-dashboards/today Authorization

Mostrar OrderDashboard de Company

{info} Soporta: Carga dinámica

Ver un dashboard de órdenes

Devuelve el OrderDashboard indicado con su payload de métricas.

Método URI Cabeceras
GET /companies/{companyId}/order-dashboards/{orderDashboardId} Authorization

Dashboard de órdenes de hoy

{info} Soporta: Carga dinámica

Devuelve el OrderDashboard del día en curso del comercio.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/order-dashboards/today Authorization

Relaciones