---
title: "Get Home Summary"
method: GET
path: "/api/v1/home/summary"
tags: ["home"]
---

# Get Home Summary

`GET /api/v1/home/summary`

## Query parameters

- `refresh` boolean — Bypass the in-memory cache and recompute.

## Headers

- `authorization` string, nullable
- `X-API-Key` string, nullable

## Response `200`

Successful Response

- HomeSummaryResponse
  - `metrics` DashboardMetrics, required
    - `total_revenue` number, required
    - `revenue_change` number, required
    - `active_leads` integer, required
    - `leads_change` integer, required
    - `conversion_rate` number, required
    - `pipeline_value` number, required
    - `total_leads` integer, required
    - `total_opportunities` integer, required
    - `open_opportunities` integer, required
    - `accounts` integer, required
    - `contacts` integer, required
  - `pipeline_by_month` PipelineMonth[], required
    - `month` string, required
    - `count` integer, required
    - `value` number, required
  - `lead_distribution` LeadDistributionItem[], required
    - `name` string, required
    - `value` integer, required
  - `team_performance` TeamMember[], required
    - `name` string, required
    - `opp_count` integer, required
    - `revenue` number, required
    - `pct` integer, required
  - `recent_activity` RecentActivityItem[], required
    - `id` integer, required
    - `object_type` string, required
    - `record_id` integer, required
    - `action` string, required
    - `field_changes` unknown[], nullable
      - unknown
    - `created_at` string, required
    - `user_name` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ninjavan/apis/salesforce-sales-cloud-replacement.md) · [All operations](https://skmtc.net/ninjavan/apis/salesforce-sales-cloud-replacement/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjavan/salesforce-sales-cloud-replacement/revisions/fd3a41a6260b/schema)