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 general metrics

GET
/v1/metrics
metrics
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/metrics'
Response Response Example
200 - Success
{
    "totalClients": 1,
    "totalSales": 1,
    "averageTicket": 5,
    "revenue": 5
}

Request

Query Params
days
string 
optional
Example:
30

Responses

🟢200OK
application/json
Body
totalClients
integer 
required
totalSales
integer 
required
averageTicket
number 
required
revenue
number 
required
🟠401Unauthorized
🟠403Forbidden
Previous
get top buyers by raffle
Next
get last orders
Built with