Dashboard

Utilize este endpoint para consultar os indicadores do dashboard.

Ambientes Disponíveis

Produção

https://api.unoip.com.br

Endpoint

• Método: GET
• Endpoint: /dashboard/user
• Autenticação: Bearer token

Query Params

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

• 2026-03-06T12:00:00.000Z

Nome	Tipo	Obrigatório	Descrição	Validações
startDate	string	Não	Data inicial do filtro	Deve ser ISO date string com horário
endDate	string	Não	Data final do filtro	Deve ser ISO date string com horário

Exemplo de Requisição

cURL

curl --request GET \
--url https://api.unoip.com.br/dashboard/user?startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z \
--header 'Authorization: Bearer seu-token-jwt'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-06T00:00:00.000Z',
  endDate: '2026-03-06T23:59:59.999Z'
});

const response = await fetch(`https://api.unoip.com.br/dashboard/user?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});
const data = await response.json();

Resposta de Sucesso

ℹ️ Varia por tipo de conta

O retorno depende do AccountTypeEnum do usuário extraído do token.

• SELLER: Conta Vendedor
• GATEWAY: Conta Gateway
• IGAMING: Conta iGaming

⚠️ Importante: Valores em Centavos

Todos os valores monetários retornam em centavos como números inteiros.

Conta Vendedor

Campo	Tipo	Obrigatório	Descrição
salesValue	number	Sim	Valor total de vendas
balance	number	Sim	Saldo disponível
reserve	number	Sim	Valor em reserva
toReceive	number	Sim	Valor a receber
paidVolume	number	Sim	Volume pago
salesVolume	number	Sim	Volume de vendas
middleTicketValue	number	Sim	Ticket médio
refundedVolume	number	Sim	Volume estornado
refundedPercentage	number	Sim	Percentual estornado
frozenValue	number	Não	Valor congelado
pendingDebits	number	Sim	Débitos pendentes
paymentMethods	object	Sim	Valores por método de pagamento (ver Sub-Objeto PaymentMethods)
indexes	object	Sim	Índices do período (ver Sub-Objeto Indexes)
orders	array	Sim	Totais por data (ver Sub-Objeto TotalsByDate)

Conta Gateway

Campo	Tipo	Obrigatório	Descrição
salesValue	number	Sim	Valor total de vendas
balance	number	Sim	Saldo disponível
reserve	number	Sim	Valor em reserva
paidVolume	number	Sim	Volume pago
salesVolume	number	Sim	Volume de vendas
middleTicketValue	number	Sim	Ticket médio
pendingDebits	number	Sim	Débitos pendentes
frozenValue	number	Não	Valor congelado
orders	array	Sim	Totais por data (ver Sub-Objeto TotalsByDate)

Conta iGaming

Campo	Tipo	Obrigatório	Descrição
revenue	array	Sim	Receitas por data (ver Sub-Objeto TotalsByDate)
expense	array	Sim	Despesas por data (ver Sub-Objeto TotalsByDate)
deposit	number	Sim	Valor total de depósitos
withdrawals	number	Sim	Valor total de saques
balance	number	Sim	Saldo disponível
averageDeposit	number	Sim	Depósito médio
frozenValue	number	Sim	Valor congelado
pendingDebits	number	Sim	Débitos pendentes

Sub-Objetos

PaymentMethods

Campo	Tipo	Obrigatório	Descrição
pixValue	number	Sim	Valor total em PIX
pixValueGenerated	number	Sim	Valor gerado em PIX
pixPercentage	number	Sim	Percentual em PIX
cardsValue	number	Sim	Valor total em cartões
cardsValueGenerated	number	Sim	Valor gerado em cartões
cardsPercentage	number	Sim	Percentual em cartões
billetValue	number	Sim	Valor total em boletos
billetValueGenerated	number	Sim	Valor gerado em boletos
billetPercentage	number	Sim	Percentual em boletos

Indexes

Campo	Tipo	Obrigatório	Descrição
pixConversion	number	Sim	Conversão do PIX
billetConversion	number	Sim	Conversão do boleto
creditCardConversion	number	Sim	Conversão do cartão de crédito
preChargebackVolume	number	Sim	Volume pré-chargeback
preChargebackPercentage	number	Sim	Percentual pré-chargeback
chargebackVolume	number	Sim	Volume de chargeback
chargebackPercentage	number	Sim	Percentual de chargeback
creditCardsRefusedVolume	number	Sim	Volume de cartões recusados
creditCardsRefusedPercentage	number	Sim	Percentual de cartões recusados
medVolume	number	Não	Volume de MED
medPercentage	number	Não	Percentual de MED

TotalsByDate

Campo	Tipo	Obrigatório	Descrição
date	string (ISO)	Sim	Data de referência
total	number	Sim	Total no dia

Exemplo de Resposta (Seller)

{
  "salesValue": 150000,
  "balance": 50000,
  "reserve": 10000,
  "toReceive": 90000,
  "paidVolume": 120000,
  "salesVolume": 150000,
  "middleTicketValue": 7500,
  "refundedVolume": 5000,
  "refundedPercentage": 3.3,
  "frozenValue": 2000,
  "pendingDebits": 1000,
  "paymentMethods": {
    "pixValue": 60000,
    "pixValueGenerated": 65000,
    "pixPercentage": 40,
    "cardsValue": 70000,
    "cardsValueGenerated": 75000,
    "cardsPercentage": 47,
    "billetValue": 20000,
    "billetValueGenerated": 25000,
    "billetPercentage": 13
  },
  "indexes": {
    "pixConversion": 92,
    "billetConversion": 65,
    "creditCardConversion": 78,
    "preChargebackVolume": 1200,
    "preChargebackPercentage": 0.8,
    "chargebackVolume": 500,
    "chargebackPercentage": 0.3,
    "creditCardsRefusedVolume": 3000,
    "creditCardsRefusedPercentage": 2.0,
    "medVolume": 200,
    "medPercentage": 0.1
  },
  "orders": [
    {
      "date": "2026-03-06",
      "total": 50000
    },
    {
      "date": "2026-03-07",
      "total": 100000
    }
  ]
}

Exemplo de Resposta (Gateway)

{
  "salesValue": 120000,
  "balance": 40000,
  "reserve": 8000,
  "paidVolume": 95000,
  "salesVolume": 120000,
  "middleTicketValue": 6000,
  "pendingDebits": 900,
  "frozenValue": 1500,
  "orders": [
    {
      "date": "2026-03-06",
      "total": 45000
    },
    {
      "date": "2026-03-07",
      "total": 75000
    }
  ]
}

Exemplo de Resposta (iGaming)

{
  "revenue": [
    {
      "date": "2026-03-06",
      "total": 90000
    },
    {
      "date": "2026-03-07",
      "total": 110000
    }
  ],
  "expense": [
    {
      "date": "2026-03-06",
      "total": 30000
    },
    {
      "date": "2026-03-07",
      "total": 35000
    }
  ],
  "deposit": 200000,
  "withdrawals": 80000,
  "balance": 120000,
  "averageDeposit": 10000,
  "frozenValue": 5000,
  "pendingDebits": 2500
}

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
422	Dados inválidos ou faltando	Verifique o formato dos dados
422	Validações	Contate o suporte
500	Erro interno	Contate o suporte