---
title: "Get reports for a lead"
method: GET
path: "/leads/report"
tags: ["Leads"]
---

# Get reports for a lead

`GET /leads/report`

## Query parameters

- `filter[name]` string
- `q` string
- `sort` string
- `format` 'json' | 'csv' | 'pdf' | 'png' | 'html'
- `gap` 'd' | 'w' | 'm' | 'y' | 'q'
- `groupByField` string
- `pivotFacet` string
- `reportType` 'sales' | 'losses' | 'newleads' | 'forecast' | 'attribution' | 'custom'
- `segmentByField` 'outcomes' | 'competitors' | 'products' | 'productCategories' | 'assignees' | 'territories' | 'sources' | 'tags' | 'channels'
- `useConfidence` boolean

## Response `200`

Reports

- object
  - `reports` object[]
    - `report` NutReportOnDemandReport
      - `id` string — The API ID of this entity, formatted {integer}-{entityType}
      - `key` string
      - `data` object[]
        - `bucket` ReportBucket — Bucket of the report
          - `bucket` string — The name of the bucket
          - `count` ReportCount — Count of the report
            - `formatted` string — The formatted value after applying the prefix and suffix
            - `prefix` string — The prefix to apply to the value
            - `suffix` string — The suffix to apply to the value
            - `value` number — The raw value to be formatted
          - `total` ReportCount — Count of the report
            - `formatted` string — The formatted value after applying the prefix and suffix
            - `prefix` string — The prefix to apply to the value
            - `suffix` string — The suffix to apply to the value
            - `value` number — The raw value to be formatted
          - `bucketType` string
          - `bucketSubtype` string
          - `filters` string[] — The filters applied to the report
          - `segments` string[]
      - `name` string
      - `prefix` string
      - `summary` ReportBucket — Bucket of the report
        - `bucket` string — The name of the bucket
        - `count` ReportCount — Count of the report
          - `formatted` string — The formatted value after applying the prefix and suffix
          - `prefix` string — The prefix to apply to the value
          - `suffix` string — The suffix to apply to the value
          - `value` number — The raw value to be formatted
        - `total` ReportCount — Count of the report
          - `formatted` string — The formatted value after applying the prefix and suffix
          - `prefix` string — The prefix to apply to the value
          - `suffix` string — The suffix to apply to the value
          - `value` number — The raw value to be formatted
        - `bucketType` string
        - `bucketSubtype` string
        - `filters` string[] — The filters applied to the report
        - `segments` string[]

## Other responses

- `400` — Invalid input

---

[API](https://skmtc.dev/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.dev/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/revisions/14f59cf6a09a/schema)