Get reports for a lead

Query Params
string

Filter results by lead name. Visit the filters guide for more information on how to filter by other terms.

string

Used to search all related info. Returns all reports that are similar to the query term.

string

Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order.

string
enum
Allowed:
string
enum

The bucket size of the report

Allowed:
string

The field to group leads by. Sales or losses reports should use closedTime, newleads and custom reports should use createdTime.

string

The facet to sort values on.

string
enum

The type of report to generate.

Allowed:
string
enum

Ways to break down the report further to compare across different variables. Useful to answer questions such as: Who has made the most sales? Which products are earning the most? Where are our leads coming from?

boolean

When calculating lead values, use their weight confidence value or not

Responses

400

Invalid input

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json