Sign in

v1

OpenAPI 3.0.02026-08-04109109370.6 KB
Leads

Get reports for a lead

get/leads/report

Query parameters

filter[name]string

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

qstring

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

sortstring

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

format'json' | 'csv' | 'pdf' | 'png' | 'html'
gap'd' | 'w' | 'm' | 'y' | 'q'

The bucket size of the report

groupByFieldstring

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

pivotFacetstring

The facet to sort values on.

reportType'sales' | 'losses' | 'newleads' | 'forecast' | 'attribution' | 'custom'

The type of report to generate.

segmentByField'outcomes' | 'competitors' | 'products' | 'productCategories' | 'assignees' | 'territories' | 'sources' | 'tags' | 'channels'

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?

useConfidenceboolean

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

Response

Reports

Example response

{
  "reports": [
    {
      "report": {
        "id": "3-contacts",
        "data": [
          {
            "bucket": {
              "bucket": "best bucket",
              "count": {
                "prefix": "$",
                "value": 100
              },
              "total": {
                "prefix": "$",
                "value": 100
              }
            }
          }
        ],
        "summary": {
          "bucket": "best bucket",
          "count": {
            "prefix": "$",
            "value": 100
          },
          "total": {
            "prefix": "$",
            "value": 100
          }
        }
      }
    }
  ]
}