leads
leads

Leads Coverage

Per-day formation count for a state — or all states — across a date window.

Returns by_date (zero-filled day-by-day count), gap_groups (consecutive zero-day ranges), weekday_median / weekend_median (baseline volumes for spotting partial pulls), and a coverage_pct summary. Caller can use this to decide whether the dataset is complete enough for their query — or to plan a backfill.

Omit state (or pass ALL) to roll every live state together; the response then carries state_breakdown (per-state split per day). Pass industries=N to attach top_industries — the N most-formed industry names per day. A day with records but no classified industries comes back with an empty list (render as "Not Yet Classified").

Counts read from entity so coverage reflects loaded data even if the lead_browse view hasn't been refreshed yet; industries read from lead_browse, which is populated by the classify stage.

get/api/v1/leads/coverage

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/leads/coverage
  • Auth: none declared

Query parameters

statestring nullable

State code (e.g. NY, CO, FL, VA). Omit (or ALL) to roll up every state.

start_datestring required

Window start (YYYY-MM-DD), inclusive

end_datestring required

Window end (YYYY-MM-DD), inclusive

industriesinteger

Attach the top-N industry_name values formed per day (0 = skip).

commercialboolean

True (default) = curated commercial view (off-story hidden, demand-weighted, like the Inventory page). False = show everything (all classified industries, raw count).

bystring

What a day counts. 'formation' (default) = businesses formed that day (the calendar). 'loaded' = new businesses first loaded that UTC day — harvest delivery, the PM's patrol key.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.