Analytics de splits enviados
GET
/api/splits/analytics
Autenticação
Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.splits:read. Retorna summary (totais), recipients (top destinatários), history (paginado), period.Requisição
Parâmetros de Consulta
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/splits/analytics?page=1&limit=20' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"summary": {
"totalSplitsSent": 45,
"totalAmountSent": 125000,
"uniqueRecipients": 8,
"completedSplits": 40,
"pendingSplits": 3,
"failedSplits": 2
},
"recipients": [
{
"userId": "clpartner1",
"name": "Parceiro LTDA",
"email": "parceiro@exemplo.com",
"taxId": "12345678000190",
"taxIdType": "CNPJ",
"splitCount": 15,
"totalAmount": 45000
}
],
"history": [
{
"id": "clsplit0001",
"chargeId": "clcharge0001",
"chargeCorrelationId": "dotfy-1714000000000-abc12345",
"chargeDescription": "Pedido #1234",
"chargeValue": 10000,
"type": "PERCENT",
"value": 50,
"calculatedAmount": 5000,
"status": "COMPLETED",
"recipientEmail": "parceiro@exemplo.com",
"recipientName": "Parceiro LTDA",
"recipientTaxId": "12345678000190",
"recipientTaxIdType": "CNPJ",
"processedAt": "2026-05-05T14:30:00.000Z",
"createdAt": "2026-05-05T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"totalItems": 45,
"totalPages": 3
},
"period": {
"startDate": "2026-04-01",
"endDate": "2026-05-07"
}
}Modificado em 2026-07-02 06:57:27