> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Consultar resumo do dashboard > Devolve os indicadores do período para a empresa autenticada: faturamento bruto e líquido, vendas aprovadas, ticket médio, taxa de aprovação e de reembolso, e como as vendas se dividiram entre Pix, cartão e boleto. É a leitura que abre o painel e a barra de métricas de Vendas. Sem período, considera o mês corrente. ## OpenAPI ````yaml /openapi.yaml get /v1/dashboard/summary openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/dashboard/summary: get: tags: - Crescimento summary: Consultar resumo do dashboard description: >- Devolve os indicadores do período para a empresa autenticada: faturamento bruto e líquido, vendas aprovadas, ticket médio, taxa de aprovação e de reembolso, e como as vendas se dividiram entre Pix, cartão e boleto. É a leitura que abre o painel e a barra de métricas de Vendas. Sem período, considera o mês corrente. operationId: getDashboardSummary parameters: - schema: type: string format: date-time in: query name: from required: false description: >- Início do período, em ISO 8601. Sem `from` e `to`, o painel considera o mês corrente. - schema: type: string format: date-time in: query name: to required: false description: Fim do período, em ISO 8601. responses: '200': description: Indicadores do período. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: grossAmount: type: integer description: Faturamento bruto do período, em centavos. netAmount: type: integer description: >- Faturamento líquido do período, já sem as taxas, em centavos. transactionsCount: type: integer description: Transações criadas no período, pagas ou não. paidTransactions: type: integer description: Vendas aprovadas no período. paidToday: type: integer description: Vendas aprovadas hoje. averageTicket: type: number description: >- Faturamento líquido dividido pelas vendas aprovadas, em centavos. refundsCount: type: integer description: Reembolsos no período. refundedAmount: type: integer description: Valor reembolsado no período, em centavos. approvalRate: type: number description: >- Percentual das transações criadas no período que foram aprovadas. refundRate: type: number description: >- Percentual das vendas aprovadas que acabaram reembolsadas. lastHourNetAmount: type: integer description: Faturamento líquido da última hora, em centavos. approvalRateByMethod: type: object properties: pix: type: number description: Taxa em percentual para Pix. creditCard: type: number description: Taxa em percentual para cartão de crédito. boleto: type: number description: Taxa em percentual para boleto. required: - pix - creditCard - boleto additionalProperties: false description: Taxa de aprovação por meio de pagamento. salesShareByMethod: type: object properties: pix: type: object properties: percentage: type: number description: >- Fatia das vendas do período neste meio, em percentual. count: type: integer description: Quantidade de vendas no meio. required: - percentage - count additionalProperties: false creditCard: type: object properties: percentage: type: number description: >- Fatia das vendas do período neste meio, em percentual. count: type: integer description: Quantidade de vendas no meio. required: - percentage - count additionalProperties: false boleto: type: object properties: percentage: type: number description: >- Fatia das vendas do período neste meio, em percentual. count: type: integer description: Quantidade de vendas no meio. required: - percentage - count additionalProperties: false required: - pix - creditCard - boleto additionalProperties: false description: >- Como as vendas do período se dividem entre os meios de pagamento. required: - grossAmount - netAmount - transactionsCount - paidTransactions - paidToday - averageTicket - refundsCount - refundedAmount - approvalRate - refundRate - lastHourNetAmount - approvalRateByMethod - salesShareByMethod additionalProperties: false required: - success - data additionalProperties: false description: Indicadores do período. example: success: true data: grossAmount: 4871200 netAmount: 4602140 transactionsCount: 214 paidTransactions: 97 paidToday: 6 averageTicket: 47444.74 refundsCount: 3 refundedAmount: 149700 approvalRate: 45.33 refundRate: 3.09 lastHourNetAmount: 94810 approvalRateByMethod: pix: 61.2 creditCard: 38.7 boleto: 22.5 salesShareByMethod: pix: percentage: 58.8 count: 57 creditCard: percentage: 37.1 count: 36 boleto: percentage: 4.1 count: 4 '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````