Dashboard

The adaptive dashboard: your day, KPI tiles with deltas, the pipeline and the live team board.

GET/v1/dashboard/overview

Dashboard overview

Your day (today, your own: calls, follow-ups due and overdue, visits, new and unassigned leads), the KPI tiles of the lens with the previous period and a daily series (new leads, calls, connected %, talk time, first response median, visits done, deals closed, revenue — masked without commission access), the sections the plan and your permissions allow, and how many members the lens covers. "Call next" and its counts: GET /me/call-list.

Access: API key with reports:read, or a member session. Permission reports.view.

Parameters

periodquery: "today" | "7d" | "30d" | "this_month" | "last_month"
Company calendar; compared with the period of the same length before it.
scopequery: "team" | "me" | "member"
`team`: everyone your report scope reaches; `me`: your own; `member`: one member of your scope (with `member_id`; outside your scope → 404). Without it: your whole report scope.
member_idquery: Id
The member of `scope=member`.

Response · 200

datarequired: DashboardOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/dashboard/overview' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "period": {
      "key": "today",
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z",
      "previous_from": "2026-10-06T05:30:00.000Z",
      "previous_to": "2026-10-06T05:30:00.000Z",
      "days": [
        "2026-10-06"
      ]
    },
    "scope": {
      "kind": "team",
      "member": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "can_view_team": true
    },
    "members_in_scope": 0,
    "features": {
      "calls": true,
      "call_log": true,
      "call_list": true,
      "visits": true,
      "deals": true,
      "revenue": true,
      "source_costs": true,
      "sla": true,
      "accountability": true,
      "attendance": true,
      "team": true
    },
    "your_day": {
      "member_id": "cmusrceel0000q7kaafxqi1om",
      "calls": 0,
      "connected": 0,
      "talk_sec": 0,
      "follow_ups_due": 0,
      "follow_ups_overdue": 0,
      "visits": 0,
      "visits_done": 0,
      "new_leads": 0,
      "unassigned": 0
    },
    "kpis": [
      {
        "key": "new_leads",
        "unit": "count",
        "value": 0,
        "previous": 0,
        "change_pct": 0,
        "series": [
          0
        ],
        "lower_is_better": true,
        "masked": true,
        "truncated": true
      }
    ],
    "generated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/dashboard/pipeline

Dashboard pipeline

The pipelines you can pick; for one pipeline the leads per status now in pipeline order (count, share, deal value, stuck for 7+ days) and the stage funnel of the leads received in the period (leads → contacted → qualified → visit → deal) with conversion and the previous period. 404 for a pipeline of another company.

Access: API key with reports:read, or a member session. Permission reports.view.

Parameters

periodquery: "today" | "7d" | "30d" | "this_month" | "last_month"
Company calendar; compared with the period of the same length before it.
scopequery: "team" | "me" | "member"
`team`: everyone your report scope reaches; `me`: your own; `member`: one member of your scope (with `member_id`; outside your scope → 404). Without it: your whole report scope.
member_idquery: Id
The member of `scope=member`.
pipeline_idquery: Id
Default: the company’s default pipeline.

Response · 200

datarequired: DashboardPipeline
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/dashboard/pipeline' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "pipelines": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_default": true
      }
    ],
    "pipeline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "period": {
      "key": "today",
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z",
      "previous_from": "2026-10-06T05:30:00.000Z",
      "previous_to": "2026-10-06T05:30:00.000Z"
    },
    "totals": {
      "leads": 0,
      "open": 0,
      "won": 0,
      "lost": 0,
      "invalid": 0,
      "stuck": 0
    },
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "string",
        "count": 0,
        "share_pct": 0,
        "deal_value_paise": 850000000,
        "stuck": 0
      }
    ],
    "funnel": [
      {
        "key": "leads",
        "count": 0,
        "previous": 0,
        "conversion_pct": 0,
        "of_leads_pct": 0
      }
    ],
    "funnel_out": {
      "junk": 0,
      "lost": 0
    },
    "stuck_days": 0,
    "deal_value_visible": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/dashboard/team

Dashboard team board

One row per member of the lens: live status, first and last call today, calls, connected and talk time in the period, follow-ups done / overdue, visits, deals won, the accountability score and the phone’s call-tracking health — and who needs attention and why. `scope=team` or `member` (403 for `me` or an own-only scope).

Access: API key with reports:read, or a member session. Permission reports.view.

Parameters

periodquery: "today" | "7d" | "30d" | "this_month" | "last_month"
Company calendar; compared with the period of the same length before it.
scopequery: "team" | "me" | "member"
`team`: everyone your report scope reaches; `me`: your own; `member`: one member of your scope (with `member_id`; outside your scope → 404). Without it: your whole report scope.
member_idquery: Id
The member of `scope=member`.

Response · 200

datarequired: DashboardTeam
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/dashboard/team' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "period": {
      "key": "today",
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z"
    },
    "attendance_on": true,
    "phones_visible": true,
    "score_day": "2026-10-06",
    "rows": [
      {
        "member": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "role": "string",
          "branch": "string",
          "is_me": true
        },
        "live": {
          "status": "calling",
          "since": "2026-10-06T05:30:00.000Z"
        },
        "attendance": {
          "punch_in_at": "2026-10-06T05:30:00.000Z",
          "punch_out_at": "2026-10-06T05:30:00.000Z",
          "on_break": true,
          "late": true
        },
        "today": {
          "calls": 0,
          "first_call_at": "2026-10-06T05:30:00.000Z",
          "last_call_at": "2026-10-06T05:30:00.000Z"
        },
        "calls": 0,
        "connected": 0,
        "talk_sec": 0,
        "follow_ups": {
          "done": 0,
          "done_on_time": 0,
          "overdue": 0
        },
        "visits_done": 0,
        "deals_won": 0,
        "score": {
          "value": 0,
          "band": "strong",
          "trend": {
            "delta": 0,
            "direction": "up"
          },
          "weakest": {
            "key": "first_response",
            "label": "string",
            "value": 0
          }
        },
        "phone": {
          "health": "healthy",
          "tracking_enabled": true,
          "last_seen_at": "2026-10-06T05:30:00.000Z",
          "calls": {
            "state": "ok",
            "failed_streak": 0,
            "reason": "airplane",
            "sim_slot": 0,
            "last_failed_at": "2026-10-06T05:30:00.000Z"
          }
        }
      }
    ],
    "attention": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "reasons": [
          {
            "key": "low_score",
            "message": "string"
          }
        ]
      }
    ],
    "generated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": { "period": { "key": "today", "from": "2026-10-06T05:30:00.000Z", "to": "2026-10-06T05:30:00.000Z", "previous_from": "2026-10-06T05:30:00.000Z", "previous_to": "2026-10-06T05:30:00.000Z", "days": [ "2026-10-06" ] }, "scope": { "kind": "team", "member": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "can_view_team": true }, "members_in_scope": 0, "features": { "calls": true, "call_log": true, "call_list": true, "visits": true, "deals": true, "revenue": true, "source_costs": true, "sla": true, "accountability": true, "attendance": true, "team": true }, "your_day": { "member_id": "cmusrceel0000q7kaafxqi1om", "calls": 0, "connected": 0, "talk_sec": 0, "follow_ups_due": 0, "follow_ups_overdue": 0, "visits": 0, "visits_done": 0, "new_leads": 0, "unassigned": 0 }, "kpis": [ { "key": "new_leads", "unit": "count", "value": 0, "previous": 0, "change_pct": 0, "series": [ 0 ], "lower_is_better": true, "masked": true, "truncated": true } ], "generated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

{ "data": { "pipelines": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "is_default": true } ], "pipeline": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "period": { "key": "today", "from": "2026-10-06T05:30:00.000Z", "to": "2026-10-06T05:30:00.000Z", "previous_from": "2026-10-06T05:30:00.000Z", "previous_to": "2026-10-06T05:30:00.000Z" }, "totals": { "leads": 0, "open": 0, "won": 0, "lost": 0, "invalid": 0, "stuck": 0 }, "statuses": [ { "id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string", "color": "string", "category": "string", "count": 0, "share_pct": 0, "deal_value_paise": 850000000, "stuck": 0 } ], "funnel": [ { "key": "leads", "count": 0, "previous": 0, "conversion_pct": 0, "of_leads_pct": 0 } ], "funnel_out": { "junk": 0, "lost": 0 }, "stuck_days": 0, "deal_value_visible": true }, "meta": {} }

{ "data": { "period": { "key": "today", "from": "2026-10-06T05:30:00.000Z", "to": "2026-10-06T05:30:00.000Z" }, "attendance_on": true, "phones_visible": true, "score_day": "2026-10-06", "rows": [ { "member": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "role": "string", "branch": "string", "is_me": true }, "live": { "status": "calling", "since": "2026-10-06T05:30:00.000Z" }, "attendance": { "punch_in_at": "2026-10-06T05:30:00.000Z", "punch_out_at": "2026-10-06T05:30:00.000Z", "on_break": true, "late": true }, "today": { "calls": 0, "first_call_at": "2026-10-06T05:30:00.000Z", "last_call_at": "2026-10-06T05:30:00.000Z" }, "calls": 0, "connected": 0, "talk_sec": 0, "follow_ups": { "done": 0, "done_on_time": 0, "overdue": 0 }, "visits_done": 0, "deals_won": 0, "score": { "value": 0, "band": "strong", "trend": { "delta": 0, "direction": "up" }, "weakest": { "key": "first_response", "label": "string", "value": 0 } }, "phone": { "health": "healthy", "tracking_enabled": true, "last_seen_at": "2026-10-06T05:30:00.000Z", "calls": { "state": "ok", "failed_streak": 0, "reason": "airplane", "sim_slot": 0, "last_failed_at": "2026-10-06T05:30:00.000Z" } } } ], "attention": [ { "member_id": "cmusrceel0000q7kaafxqi1om", "name": "string", "reasons": [ { "key": "low_score", "message": "string" } ] } ], "generated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }