Get lead status change report
Get a lead status change report.
The date range is optional. A report may be requested
for a specific time period or overall. You can specify
either a `query` or `smart_view_id` (but not both) to
filter leads included in the report.
The following fields are returned (when requesting an
overall report, some inapplicable fields will not be
returned):
* `status_overview`: A list of all statuses with:
* `status_id`, `status_label`,
`status_is_deleted`: The ID and label of the
status, and whether it was deleted.
* `started`: Number of leads in this status at
the start of the period.
* `ended`: Number in this status at the end.
* `change`: Net change during the period
(`ended` minus `started`).
* `change_percent`: Net change in percent.
* `gained`: Number that were not in this status
at the beginning but were at the end.
* `lost`: Number that were in this status at the
beginning but were not at the end.
* `entered`: Number that entered this status at
some point during the period.
* `left`: Number that left this status at some
point during the period.
* `_queries`: A dictionary containing search
queries for the different states (`started`,
`ended`, `gained`, `lost`, `entered`, `left`).
* `_leads_page_urls`: A dictionary containing
paths to the lead search UI page.
* `status_transitions`: A list of all status
transitions (aggregated by start/end status) for
the given period with:
* `from_status_id`, `from_status_label`,
`from_status_is_deleted`: Starting status
(null for created leads).
* `to_status_id`, `to_status_label`,
`to_status_is_deleted`: Ending status.
* `count`: The number that transitioned.
* `_query`: The search query for those records.
* `_leads_page_url`: Path to the search UI page.
* `status_transitions_summary`: Status transitions
summarized for the period. E.g. a lead that went
A→B→C is counted as A→C.
Authentication
AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
org_id
Query parameters
date_start
date_end
query
smart_view_id
Response
Successful response
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error