Métricas de monetização (receita, vendas, assinantes)

GET/api/dashboard/monetization

Auth: Jeton requis
Clé d’API:: reports:read
X-CommunityId: X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.

Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Owner, admin e financeiro (os demais recebem 403). A receita vem do **extrato** (ledger), a mesma fonte dos Relatórios e do resumo do Dashboard:

- `metrics.totalRevenue.amount` é o **bruto** (o que os compradores pagaram), na data do **pagamento**; uma venda reembolsada continua no bruto; - `metrics.totalRevenue.refunds` e `metrics.totalRevenue.chargebacks` trazem reembolsos e contestações do período, à parte (valor positivo e quantidade; a contestação inclui a tarifa de contestação; um reembolso lançado em partes conta uma vez); - `metrics.totalRevenue.net` é o bruto menos reembolsos e contestações (antes da taxa da plataforma); - venda de R$ 0,00 (cortesia, adicional incluído, gratuito) não é venda: fica fora de `count`, das médias, dos produtos e do gráfico.

Uma moeda por resposta: `currency` (padrão: a moeda com mais vendas); `currencies` lista as moedas em que a comunidade já vendeu. `metrics.totalTransactions` continua contando as compras por status, pela data do pedido. Valores em texto decimal. Nunca traz custo do processador de pagamento.

Paramètres

Nom	Emplacement	Type	Description
`period`facultatif	query	`7d \| 30d \| 90d \| 1y \| custom`
`startDate`facultatif	query	`string (date-time)`	Com `period=custom`.
`endDate`facultatif	query	`string (date-time)`	Com `period=custom`.
`currency`facultatif	query	`BRL \| USD \| EUR \| GBP \| MXN \| ARS`	Moeda das métricas (padrão, a com mais vendas).

En-têtes

Nom	Type	Description
`X-CommunityId`facultatif	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

Statut	Description
`200`	Operação realizada com sucesso.
`400`	Requisição inválida — falha de validação.
`401`	Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
`403`	Autenticado, mas sem permissão para esta operação.
`500`	Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/dashboard/monetization" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"