Business Dashboard

Get Dashboard Data

Retrieves comprehensive analytics and metrics for the authenticated business. Supports multiple time periods.

Headers

Authorization

string

required

Bearer token from authentication

Query Parameters

periodo

string

default:"semana"

Time period for analytics. Options:

dia - Today’s data (24 hours)
semana - Last 7 days (default)
mes - Current month
anio - Current year

Response

empresa

object

Business information

Show properties

integer

Business ID

nombre

string

Business name

nit

string

Tax identification number

direccion

string

Business address

telefono

string

Phone number

descripcion

string

Business description

logo_url

string

Logo image URL

foto_local_url

string

Store photo URL

is_open

boolean

Whether business is currently open

periodo

string

The time period used for calculations (“dia”, “semana”, “mes”, “anio”)

stats_cards

object

Summary statistics cards

Show properties

ventas_hoy

float

Total sales for the selected period (despite the name, reflects the chosen periodo)

promedio_calificacion

float

Average rating (0-5 stars, rounded to 1 decimal)

total_calificaciones

integer

Total number of ratings received

charts

object

Chart data for visualizations

Show properties

ventas_semanales

array

Sales data points for the selected period

Show array items

label

string

Time label (format varies by period: “HH:mm” for day, “dd/mm” for week/month, “Month” for year)

total

float

Total sales for that time period

ventas_anuales

array

Same data as ventas_semanales (kept for frontend compatibility)

top_productos

array

Top 5 best-selling products

Show array items

nombre

string

Product name

ventas

integer

Total units sold

imagen

string

Product image URL

precio

float

Current product price

ultimos_pedidos

array

5 most recent orders

Show array items

integer

Order ID

cliente

string

Customer name or “Cliente Anónimo”

total

float

Order total

estado

string

Order status

hora

string

Human-readable time since order (e.g., “hace 2 horas”)

Error Responses

500 Internal Server Error

{
  "error": "Error en el servidor",
  "detalle": "[error message]"
}

401 Unauthorized - Authentication error if user has no associated business

Example Request

curl -X GET "https://api.beanquick.com/api/empresa/dashboard?periodo=mes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Example Response

{
  "empresa": {
    "id": 5,
    "nombre": "Café Aroma",
    "nit": "123456789",
    "direccion": "Calle 10 #20-30, Bogotá",
    "telefono": "+57 300 1234567",
    "descripcion": "Cafetería artesanal especializada en café colombiano",
    "logo_url": "https://api.beanquick.com/storage/empresas/logos/logo5.jpg",
    "foto_local_url": "https://api.beanquick.com/storage/empresas/locales/local5.jpg",
    "is_open": true
  },
  "periodo": "mes",
  "stats_cards": {
    "ventas_hoy": 4250.75,
    "promedio_calificacion": 4.7,
    "total_calificaciones": 142
  },
  "charts": {
    "ventas_semanales": [
      {"label": "01", "total": 125.50},
      {"label": "02", "total": 210.00},
      {"label": "03", "total": 180.25},
      {"label": "04", "total": 0},
      {"label": "05", "total": 305.00}
    ],
    "ventas_anuales": [
      {"label": "01", "total": 125.50},
      {"label": "02", "total": 210.00},
      {"label": "03", "total": 180.25},
      {"label": "04", "total": 0},
      {"label": "05", "total": 305.00}
    ]
  },
  "top_productos": [
    {
      "nombre": "Café Americano",
      "ventas": 245,
      "imagen": "https://api.beanquick.com/storage/productos/americano.jpg",
      "precio": 15.50
    },
    {
      "nombre": "Cappuccino",
      "ventas": 198,
      "imagen": "https://api.beanquick.com/storage/productos/cappuccino.jpg",
      "precio": 18.00
    }
  ],
  "ultimos_pedidos": [
    {
      "id": 156,
      "cliente": "Carlos Ruiz",
      "total": 42.50,
      "estado": "Listo",
      "hora": "hace 15 minutos"
    },
    {
      "id": 155,
      "cliente": "Ana Martínez",
      "total": 28.00,
      "estado": "Preparando",
      "hora": "hace 1 hora"
    }
  ]
}

Download PDF Report

Generates and downloads a PDF report with the same data structure as the dashboard endpoint.

Headers

Authorization

string

required

Bearer token from authentication

Query Parameters

periodo

string

default:"semana"

Time period for the report. Same options as dashboard endpoint:

dia - Today’s report
semana - Last 7 days (default)
mes - Current month
anio - Current year

Response

Returns a PDF file with:

Content-Type: application/pdf
Content-Disposition: attachment; filename="reporte-dashboard-empresa.pdf"

The PDF includes all dashboard data formatted for printing:

Business information header
Sales statistics
Charts and graphs
Top products table
Recent orders list

Error Responses

401 - “No autenticado” if user is not authenticated
500 - Server error during PDF generation

Example Request

curl -X GET "https://api.beanquick.com/api/empresa/dashboard/pdf?periodo=semana" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o dashboard-report.pdf

Example Request (JavaScript)

fetch('https://api.beanquick.com/api/empresa/dashboard/pdf?periodo=semana', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
})
.then(response => response.blob())
.then(blob => {
  const url = window.URL.createObjectURL(blob);
  const a = document.createElement('a');
  a.href = url;
  a.download = 'reporte-dashboard-empresa.pdf';
  a.click();
});

Get Business Ratings

Retrieves all ratings and reviews for products belonging to the authenticated business.

Headers

Authorization

string

required

Bearer token from authentication

Response

[].id

integer

Rating ID

[].producto_id

integer

Product ID that was rated

[].user_id

integer

User ID who left the rating

[].estrellas

integer

Star rating (1-5)

[].comentario

string

Review comment text

[].created_at

string

When the rating was created

[].updated_at

string

When the rating was last updated

[].usuario

object

User who left the rating

Show properties

integer

User ID

name

string

User name

[].producto

object

Product that was rated

Show properties

integer

Product ID

nombre

string

Product name

Error Responses

404 Not Found

{
  "error": "No se encontró una empresa vinculada a este usuario."
}

500 Internal Server Error

{
  "error": "Error interno al obtener calificaciones",
  "detalle": "[error message]"
}

Example Request

curl -X GET https://api.beanquick.com/api/empresa/calificaciones \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Example Response

[
  {
    "id": 89,
    "producto_id": 12,
    "user_id": 34,
    "estrellas": 5,
    "comentario": "Excelente café, el mejor de la zona",
    "created_at": "2024-03-01T14:30:00.000000Z",
    "updated_at": "2024-03-01T14:30:00.000000Z",
    "usuario": {
      "id": 34,
      "name": "Laura Pérez"
    },
    "producto": {
      "id": 12,
      "nombre": "Café Americano"
    }
  },
  {
    "id": 88,
    "producto_id": 15,
    "user_id": 22,
    "estrellas": 4,
    "comentario": "Muy bueno, pero me gustaría que tuvieran más variedad",
    "created_at": "2024-02-28T11:20:00.000000Z",
    "updated_at": "2024-02-28T11:20:00.000000Z",
    "usuario": {
      "id": 22,
      "name": "Roberto Silva"
    },
    "producto": {
      "id": 15,
      "nombre": "Croissant"
    }
  }
]

Dashboard Data by Period

Day (dia)

Chart shows 24 hourly data points (00h to 23h)
Sales counted from start to end of today
Useful for monitoring real-time daily performance

Week (semana) - Default

Chart shows last 7 days with labels like “01/03”, “02/03”
Sales from 6 days ago to today
Best for weekly performance tracking

Month (mes)

Chart shows all days of current month (01 to 28/29/30/31)
Sales from first to last day of current month
Useful for monthly reporting

Year (anio)

Chart shows monthly data points (January, February, etc.)
Sales from January 1st to December 31st of current year
Best for annual performance analysis

Important Notes

Only orders with estado in [“entregado”, “Entregado”, “ENTREGADO”] are counted in sales
Ratings data is not filtered by period (shows all-time ratings)
Top products ranking is based on total units sold (all-time)
Recent orders shows the 5 most recent regardless of period
Chart data points with no sales show 0 instead of being omitted

Authentication

Customer API

Business API

Admin API

Business Dashboard

Get Dashboard Data

Headers

Query Parameters

Response

Error Responses

Example Request

Example Response

Download PDF Report

Headers

Query Parameters

Response

Error Responses

Example Request

Example Request (JavaScript)

Get Business Ratings

Headers

Response

Error Responses

Example Request

Example Response

Dashboard Data by Period

Day (dia)

Week (semana) - Default

Month (mes)

Year (anio)

Important Notes

Build docs developers (and LLMs) love

Authentication

Customer API

Business API

Admin API

​Get Dashboard Data

​Headers

​Query Parameters

​Response

​Error Responses

​Example Request

​Example Response

​Download PDF Report

​Headers

​Query Parameters

​Response

​Error Responses

​Example Request

​Example Request (JavaScript)

​Get Business Ratings

​Headers

​Response

​Error Responses

​Example Request

​Example Response

​Dashboard Data by Period

​Day (dia)

​Week (semana) - Default

​Month (mes)

​Year (anio)

​Important Notes

Build docs developers (and LLMs) love

Get Dashboard Data

Headers

Query Parameters

Response

Error Responses

Example Request

Example Response

Download PDF Report

Headers

Query Parameters

Response

Error Responses

Example Request

Example Request (JavaScript)

Get Business Ratings

Headers

Response

Error Responses

Example Request

Example Response

Dashboard Data by Period

Day (dia)

Week (semana) - Default

Month (mes)

Year (anio)

Important Notes