Reportes API

Los reportes permiten consultar los totales de ventas sobre un rangos predefinidos de fechas:

  • Día actual
  • Día anterior
  • Semana actual
  • Mes actual

Los reportes por día segmenta los resultados por hora, mientras que los reportes por semana y mes son segmentados por día.


Estructura de reporte

Atributo Tipo Descripción
x arreglo Eje con la segmentación de tiempo.
y arreglo Eje con los totales por cada segmento de tiempo.

Consulta de reportes

Reporte deventas del día en curso

GET /v1/reports

Estructura de reporte por hora:

{
  "data": {
    "x": [
      "00:00",
      "01:00",
      "02:00",
      "03:00",
      "04:00",
      "05:00",
      "06:00",
      "07:00",
      "08:00",
      "09:00",
      "10:00",
      "11:00",
      "12:00",
      "13:00",
      "14:00",
      "15:00",
      "16:00",
      "17:00",
      "18:00",
      "19:00",
      "20:00",
      "21:00",
      "22:00",
      "23:00"
    ],
    "y": [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  }
}

Estructura de reporte por día:

{
  "data": {
    "x": [
      "2018-01-01",
      "2018-01-02",
      "2018-01-03",
      "2018-01-04",
      "2018-01-05",
      "2018-01-06",
      "2018-01-07",
      "2018-01-08",
      "2018-01-09",
      "2018-01-10",
      "2018-01-11",
      "2018-01-12",
      "2018-01-13",
      "2018-01-14",
      "2018-01-15",
      "2018-01-16",
      "2018-01-17",
      "2018-01-18",
      "2018-01-19",
      "2018-01-20",
      "2018-01-21",
      "2018-01-22",
      "2018-01-23",
      "2018-01-24",
      "2018-01-25",
      "2018-01-26",
      "2018-01-27",
      "2018-01-28",
      "2018-01-29",
      "2018-01-30",
      "2018-01-31"
    ],
    "y": [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  }
}

Parámetros

Nombre Tipo Default Requerido Descripción
kind cadena today false Tipo de reporte a consultar. Tipos válidos: today, yesterday, week, month.