DashboardOverview

object

periodrequired: object
period.keyrequired: "today" | "7d" | "30d" | "this_month" | "last_month"
period.fromrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
period.torequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
period.previous_fromrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
period.previous_torequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
period.daysrequired: array of LocalDate
Calendar date YYYY-MM-DD in the company time zone.
scoperequired: object
scope.kindrequired: "team" | "me" | "member"
scope.memberrequired: object or null
scope.member.idrequired: Id
Opaque record id.
scope.member.namerequired: string
scope.can_view_teamrequired: boolean
Show the scope control (the caller reaches others).
members_in_scoperequired: integer
Active staff in the lens (1 = a solo view: no team board).
featuresrequired: object
Sections the plan and the caller’s permissions allow; hide the others.
features.callsrequired: boolean
features.call_logrequired: boolean
features.call_listrequired: boolean
features.visitsrequired: boolean
features.dealsrequired: boolean
features.revenuerequired: boolean
features.source_costsrequired: boolean
features.slarequired: boolean
features.accountabilityrequired: boolean
features.attendancerequired: boolean
features.teamrequired: boolean
your_dayrequired: object or null
The caller’s own today, whatever the period and lens (null for API keys).
your_day.member_idrequired: Id
Opaque record id.
your_day.callsrequired: integer
your_day.connectedrequired: integer
your_day.talk_secrequired: integer
your_day.follow_ups_duerequired: integer
your_day.follow_ups_overduerequired: integer
your_day.visitsrequired: integer
your_day.visits_donerequired: integer
your_day.new_leadsrequired: integer
your_day.unassignedrequired: integer or null
Open leads without an owner (members who assign).
kpisrequired: array of DashboardKpi
generated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "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"
}

{ "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" }