---
title: "Lead count summary"
method: GET
path: "/api/v1/reporting/lead_count_summary"
tags: ["Reporting"]
---

# Lead count summary

`GET /api/v1/reporting/lead_count_summary`

## Request

- Base URL: `https://api.checkcherry.com`
- URL: `https://api.checkcherry.com/api/v1/reporting/lead_count_summary`
- Auth: none declared. Required headers: `Api-Key`

Returns the number of leads, bucketed by time interval. Useful for spotting trends in lead volume — answering "are we getting more inquiries lately?" or "how many leads did we get last quarter?".

Spam-flagged and franchise-hidden leads are excluded. Use `chart_type` to choose whether leads are bucketed by **when they were created** (the default — measures inquiry volume) or **when the requested event would happen** (measures demand by event date).

**Required permission:** `reports_read`

## Query parameters

- `interval` 'year' | 'quarter' | 'month' | 'week' | 'day'
- `starts_at` string
- `ends_at` string
- `chart_type` 'created_on' | 'scheduled_on'
- `brand_id` integer

## Headers

- `Api-Key` string, required

## Response `200`

lead count summary

- object
  - `results` object[]: One entry per interval bucket, in chronological order.
    - `name` string: Human-readable label for the bucket (e.g. `Jan 2026`, `Q1 2026`).
    - `lead_count` integer: Number of leads that fell in this bucket.
    - `report_path` string: Internal Check Cherry path that opens the matching report view in the web app. Not generally useful to API consumers.

## Other responses

- `422`: invalid interval or chart_type

## Changes

- **2026-10-19** `84a9aabdf519`: 1 info
  - added the non-success response with the status `422`

[Operation history](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/changes/api/v1/reporting/lead_count_summary/get.md)

---

[API](https://skmtc.dev/checkcherry/apis/check-cherry-business-api.md) · [All operations](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/llms.txt) · [OpenAPI document](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/revisions/84a9aabdf519?raw)