Skip to main content
GET
/
api
/
v1
/
admin
/
dashboard
/
vendedores
Sellers Ranking
curl --request GET \
  --url https://api.example.com/api/v1/admin/dashboard/vendedores
{
  "data": [
    {
      "vendedorId": "<string>",
      "vendedorName": "<string>",
      "ventanaId": "<string>",
      "ventanaName": "<string>",
      "sales": 123,
      "payouts": 123,
      "tickets": 123,
      "netProfit": 123,
      "margin": 123,
      "rank": 123
    }
  ],
  "pagination": {
    "page": 123,
    "pageSize": 123,
    "totalPages": 123,
    "totalItems": 123
  }
}

​
Overview

Returns seller performance data ranked by sales, tickets, or other metrics. Supports pagination and filtering.

​
Authentication

Requires JWT authentication. VENDEDOR role is not authorized.

​
Query Parameters

​
date
enum
default:"today"
Date range preset: today, yesterday, week, month, year, range
​
fromDate
string
Start date in YYYY-MM-DD (required if date=range)
​
toDate
string
End date in YYYY-MM-DD (required if date=range)
​
ventanaId
string
Filter by ventana
​
loteriaId
string
Filter by lottery
​
betType
string
Filter by bet type
​
orderBy
enum
default:"sales"
Sort by: sales, payouts, tickets, netProfit
​
order
enum
default:"desc"
Sort order: asc, desc
​
top
number
Limit results to top N sellers
​
page
number
default:"1"
Page number for pagination
​
pageSize
number
default:"20"
Items per page (max 100)

​
Response

​
data
array
Seller performance data
​
pagination
object
Pagination metadata

​
Example Request

GET /api/v1/admin/dashboard/vendedores?date=month&orderBy=sales&order=desc&page=1&pageSize=20

​
Example Response

{
  "success": true,
  "data": [
    {
      "vendedorId": "abc-123",
      "vendedorName": "Juan Pérez",
      "ventanaId": "ventana-001",
      "ventanaName": "Ventana Centro",
      "sales": 500000,
      "payouts": 250000,
      "tickets": 450,
      "netProfit": 250000,
      "margin": 50.0,
      "rank": 1
    },
    {
      "vendedorId": "def-456",
      "vendedorName": "María López",
      "ventanaId": "ventana-001",
      "ventanaName": "Ventana Centro",
      "sales": 450000,
      "payouts": 220000,
      "tickets": 380,
      "netProfit": 230000,
      "margin": 51.1,
      "rank": 2
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalPages": 3,
    "totalItems": 55
  },
  "meta": {
    "range": {
      "fromAt": "2024-03-01T06:00:00.000Z",
      "toAt": "2024-04-01T05:59:59.999Z"
    },
    "generatedAt": "2024-03-15T12:00:00.000Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us