> ## 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 relatório de escala > Devolve como a base de clientes da empresa autenticada cresce no período: LTV estimado, retenção em 6 meses, taxa de recompra, receita recorrente mensal e a divisão entre receita nova e recorrente. Use para saber se o crescimento vem de cliente novo ou de cliente que volta. ## OpenAPI ````yaml /openapi.yaml get /v1/reports/scale 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/reports/scale: get: tags: - Crescimento summary: Consultar relatório de escala description: >- Devolve como a base de clientes da empresa autenticada cresce no período: LTV estimado, retenção em 6 meses, taxa de recompra, receita recorrente mensal e a divisão entre receita nova e recorrente. Use para saber se o crescimento vem de cliente novo ou de cliente que volta. operationId: getScaleReport parameters: - schema: type: string format: date-time in: query name: from required: false description: Início do período, em ISO 8601. Sem período, vale a janela padrão. - schema: type: string format: date-time in: query name: to required: false description: Fim do período, em ISO 8601. responses: '200': description: Relatório de escala 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: estimatedLtv: type: object properties: value: type: number description: LTV estimado por cliente, em centavos. trend: type: string description: Direção da tendência do LTV. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - value - trend - changeVsPreviousPeriod additionalProperties: false description: Valor estimado de um cliente ao longo da vida. retention6Months: type: object properties: rate: type: number description: Percentual de clientes ainda ativos após 6 meses. activeCustomers: type: number description: Clientes ativos considerados. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - rate - activeCustomers - changeVsPreviousPeriod additionalProperties: false description: Retenção em 6 meses. repurchaseRate: type: object properties: rate: type: number description: >- Percentual de clientes que compraram mais de uma vez. recurringCustomers: type: number description: Clientes recorrentes. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - rate - recurringCustomers - changeVsPreviousPeriod additionalProperties: false description: Taxa de recompra. mrr: type: object properties: value: type: number description: Receita recorrente mensal, em centavos. changeVsPreviousPeriod: type: number description: Variação contra o período anterior. required: - value - changeVsPreviousPeriod additionalProperties: false description: Receita recorrente mensal. ltvOverTime: type: object properties: changeOverPeriod: type: number description: Variação do LTV do início ao fim do período. points: type: array items: type: object properties: date: type: string description: Data do ponto, em ISO 8601. ltv: type: number description: LTV no ponto, em centavos. customers: type: number description: Clientes considerados no ponto. required: - date - ltv - customers additionalProperties: false description: Série do LTV. required: - changeOverPeriod - points additionalProperties: false description: Evolução do LTV. retentionCurve: type: object properties: points: type: array items: type: object properties: month: type: string description: Mês desde a primeira compra. percentage: type: number description: Percentual de clientes ainda ativos. required: - month - percentage additionalProperties: false description: Curva de retenção mês a mês. required: - points additionalProperties: false description: Quanto tempo o cliente fica. repurchaseDistribution: type: object properties: recurringRate: type: number description: Percentual de clientes recorrentes. buckets: type: array items: type: object properties: label: type: string description: Faixa de número de compras. customers: type: number description: Clientes na faixa. revenue: type: number description: Receita da faixa, em centavos. percentage: type: number description: Fatia dos clientes na faixa. required: - label - customers - revenue - percentage additionalProperties: false description: Distribuição por número de compras. required: - recurringRate - buckets additionalProperties: false description: Quantas vezes o cliente volta. revenueByCustomer: type: object properties: points: type: array items: type: object properties: date: type: string description: Data do ponto, em ISO 8601. newRevenue: type: number description: Receita de clientes novos, em centavos. recurringRevenue: type: number description: >- Receita de clientes recorrentes, em centavos. required: - date - newRevenue - recurringRevenue additionalProperties: false description: Série de receita nova contra recorrente. required: - points additionalProperties: false description: De onde vem a receita. mrrEvolution: type: object properties: changeOverPeriod: type: number description: Variação do MRR do início ao fim do período. points: type: array items: type: object properties: date: type: string description: Data do ponto, em ISO 8601. mrr: type: number description: MRR no ponto, em centavos. required: - date - mrr additionalProperties: false description: Série do MRR. required: - changeOverPeriod - points additionalProperties: false description: Evolução da receita recorrente. required: - estimatedLtv - retention6Months - repurchaseRate - mrr - ltvOverTime - retentionCurve - repurchaseDistribution - revenueByCustomer - mrrEvolution additionalProperties: false required: - success - data additionalProperties: false description: Relatório de escala do período. example: success: true data: estimatedLtv: value: 87400 trend: up changeVsPreviousPeriod: 6.2 retention6Months: rate: 41.3 activeCustomers: 312 changeVsPreviousPeriod: 2.4 repurchaseRate: rate: 27.8 recurringCustomers: 118 changeVsPreviousPeriod: 1.9 mrr: value: 1284000 changeVsPreviousPeriod: 8.1 ltvOverTime: changeOverPeriod: 6.2 points: - date: '2026-09-01T00:00:00.000Z' ltv: 87400 customers: 312 retentionCurve: points: - month: M1 percentage: 100 - month: M6 percentage: 41.3 repurchaseDistribution: recurringRate: 27.8 buckets: - label: 1 compra customers: 306 revenue: 15269400 percentage: 72.2 revenueByCustomer: points: - date: '2026-09-01T00:00:00.000Z' newRevenue: 984200 recurringRevenue: 299800 mrrEvolution: changeOverPeriod: 8.1 points: - date: '2026-09-01T00:00:00.000Z' mrr: 1284000 '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 ````