v1

latestOpenAPI 3.0.12026-08-0671048.4 KB
Analytics

Get Stats

Retrieve dashboard statistics including usage, lead counts, and conversion metrics. A JSON body is required, even if empty ({}).

post/api/stats

Request body

period'current' | 'previous' | 'custom'

Period to retrieve statistics for

startDatestring date

Start date (YYYY-MM-DD). Required when period is custom.

endDatestring date

End date (YYYY-MM-DD). Required when period is custom.

Example request

{
  "startDate": "2026-01-01",
  "endDate": "2026-03-01"
}

Response

Statistics retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "usage": {
      "leadsUsed": 150,
      "leadsLimit": 500,
      "periodStart": "2026-01-01T00:00:00.000Z",
      "periodEnd": "2026-03-01T23:59:59.999Z"
    },
    "leads": {
      "total": 150,
      "byStatus": {
        "open": 45,
        "qualified": 30,
        "won": 50,
        "lost": 25
      },
      "bySource": {
        "gtm": 120,
        "api": 20,
        "manual": 10
      }
    },
    "conversion": {
      "qualified": 80,
      "qualificationRate": 0.7,
      "winRate": 0.625,
      "averageValue": 2500,
      "totalValue": 125000
    }
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6",
    "timestamp": "2026-03-10T12:00:00.000Z"
  }
}