Raffle System
  1. metrics
Raffle System
  • Raffles
    • authentication
      • admin login
      • user login
    • awarded-boxes
      • getAll
      • open awarded box
      • create
      • getAll by raffleId
      • delete
    • awarded-boxes-combo
      • create
      • getAll by raffleId
      • update
      • delete
    • tracking
      • get tracking info
    • pay2m-api
      • access token generation
      • generate billing qr code
      • consult qr code
      • list webhook
      • register/update webhook
      • delete webhook
    • provider-api
      • auth login
      • create pix static
      • get webhooks
      • create webhook
      • get balance
      • get extracts
      • edit webhook
      • delete webhook
      • get webhook details
      • restore webhook
    • winner
      • get quota prize winners
    • general
      • update settings
      • get settings
      • create notifications
      • get notifications
      • get notification by id
      • update notification
      • delete notification
      • create faq
      • get faqs
      • get faq by id
      • update faq
      • delete faq
    • metrics
      • get sales by day for raffle
        GET
      • get top buyers by raffle
        GET
      • get general metrics
        GET
      • get last orders
        GET
      • get raffle percentage of sales
        GET
      • get orders summary
        GET
      • get badges
        GET
      • get sell bar
        GET
      • get fake sold quotas percentage
        GET
      • create fake sold quotas percentage
        POST
      • update fake sold quotas percentage
        PATCH
    • payments
      • get payment providers
      • create/update payment provider
      • get payment provider by name
      • get pix payments
      • get my pix payments
      • get pix payment details
    • order
      • create order withou payment method
      • create order
      • get orders
      • get orders by raffle id
      • get my orders
      • get order details
      • pay order
      • cancel order
    • lucky-numbers
      • get lucky numbers by raffleId
      • get lucky numbers by orderId
    • raffle
      • toggle awarded boxes visualization
      • toggle awarded boxes winners visualization
      • toggle acumulative combo
      • update category
      • delete category
      • create raffle category
      • get categories
      • create raffle
      • get raffles
      • get raffle details
      • delete raffle
      • update raffle
      • get winners
      • get winner details
      • get winner info
      • create winner
      • upload file
    • user
      • create user
      • get users
      • update user
      • get user details
      • delete user
      • get user by phone
      • get profile
      • create customer
      • update customer
  1. metrics

get top buyers by raffle

GET
/v1/metrics/{raffleId}/top-buyers
metrics
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/metrics/{{raffleId}}/top-buyers'
Response Response Example
200 - Success
{
    "topBuyers": [
        {
            "userId": 2,
            "totalQuantity": 600,
            "totalValue": 5968,
            "userName": "User 1",
            "userPhone": "00000000001"
        },
        {
            "userId": 1,
            "totalQuantity": 150,
            "totalValue": 5,
            "userName": "Admin User",
            "userPhone": "11111111111"
        }
    ]
}

Request

Path Params
raffleId
string 
required
Example:
{{raffleId}}
Query Params
todayOnly
boolean 
optional
Example:
true

Responses

🟢200OK
application/json
Body
topBuyers
array [object {5}] 
required
userId
integer 
required
totalQuantity
integer 
required
totalValue
integer 
required
userName
string 
required
userPhone
string 
required
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Previous
get sales by day for raffle
Next
get general metrics
Built with