Endpoints / getLeadStats

getLeadStats

Aggregierte Lead-Statistik (Charts/Reports)

Gruppiert Leads nach groupBy-Dimension und liefert Aggregat. Ersetzt UI-Cases statspie + statscolumns.

HTTP Request

POST https://dev.vitabyte.ch/v1/sales/getLeadStats

Auth basicAuth apiKey

Request Parameters

Mögliche groupBy-Werte: folder, source, assignee, country, what, nextStep, day, week, month. metric: count (Default), revenue oder costs. Filter analog zu getLeads (ispatient, assignee, folderId, from/to).

Parameter	Pflicht	Typ	Beispiel / Default
`groupBy`	required	string enum: folder \| source \| assignee \| country \| what \| nextStep \| day \| week \| month
`metric`	optional	string enum: count \| revenue \| costs	default: `count`
`filter` Gleiche Filter-Optionen wie getLeads	optional	object

Response Parameters

Fehler mit HTTP 400: Provide a groupBy. bzw. Unsupported groupBy: <value>.

Field	Typ	Beschreibung
`key`	string	Gruppierungsschlüssel
`label`	string	Anzeigename der Gruppe
`value`	number	Aggregierter Wert gemäss metric

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/sales/getLeadStats

Payload

{
    "groupBy": "folder",
    "metric": "count",
    "filter": {
        "ispatient": 1,
        "from": "2026-04-01",
        "to": "2026-05-18"
    }
}

Response

{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "key": "1",
            "label": "Open",
            "value": 42
        },
        {
            "key": "2",
            "label": "To be contacted",
            "value": 15
        },
        {
            "key": "3",
            "label": "In discussion",
            "value": 9
        }
    ]
}