Skip to main content
GET
/
api
/
v1
/
ventas
/
breakdown
Sales Breakdown
curl --request GET \
  --url https://api.example.com/api/v1/ventas/breakdown
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "sales": 123,
      "tickets": 123,
      "payouts": 123,
      "netRevenue": 123,
      "rank": 123
    }
  ],
  "totals": {}
}

​
Overview

Returns top-N breakdown of sales by specified dimension. Useful for identifying top performers or popular numbers.

​
Authentication

Requires JWT authentication. RBAC filtering applies.

​
Query Parameters

​
dimension
enum
required
Breakdown dimension: vendedor, ventana, loteria, sorteo, numero
​
top
number
default:"10"
Number of top results (max 50)
​
date
enum
default:"today"
Date range: today, yesterday, week, month, year, range
​
fromDate
string
Start date YYYY-MM-DD (required if date=range)
​
toDate
string
End date YYYY-MM-DD (required if date=range)
​
ventanaId
string
Filter by ventana
​
loteriaId
string
Filter by lottery

​
Response

​
items
array
Breakdown items (top N)
​
totals
object
Aggregate totals

​
Example Request

GET /api/v1/ventas/breakdown?dimension=vendedor&top=10&date=month

​
Example Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "abc-123",
        "name": "Juan Pérez",
        "sales": 500000,
        "tickets": 450,
        "payouts": 250000,
        "netRevenue": 250000,
        "rank": 1
      },
      {
        "id": "def-456",
        "name": "María López",
        "sales": 450000,
        "tickets": 380,
        "payouts": 220000,
        "netRevenue": 230000,
        "rank": 2
      }
    ],
    "totals": {
      "sales": 1500000,
      "tickets": 1234,
      "payouts": 800000,
      "netRevenue": 700000
    }
  },
  "meta": {
    "range": {
      "fromAt": "2024-03-01T06:00:00.000Z",
      "toAt": "2024-04-01T05:59:59.999Z",
      "tz": "America/Costa_Rica"
    },
    "dimension": "vendedor",
    "topCount": 10
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us