Reporting

Lead count summary

Changed on

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

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

Query parameters

interval'year' | 'quarter' | 'month' | 'week' | 'day'

Time-bucket size. Defaults to month.

starts_atstring

Start of the date range (YYYY-MM-DD). Defaults to one year ago. Snapped to the beginning of the chosen interval.

ends_atstring

End of the date range (YYYY-MM-DD). Defaults to today. Snapped to the end of the chosen interval.

chart_type'created_on' | 'scheduled_on'

Which date drives bucketing. created_on (default) buckets by lead creation date. scheduled_on buckets by the lead's requested event date.

brand_idinteger

Limit results to a single brand. Omit to include all brands on the account.

Headers

Api-Keystring required

Your Integration Key

Response

lead count summary

Changes