Report builder

Reports you build: an entity, filters, a group-by and a split, measures (counts, totals, averages, conversion rates, cost per lead), charts, drill-down to records, private / team / company sharing and versions — always within the reader’s own report scope.

GET/v1/reports/builder/catalogue

What I can report on

Entities, fields, outcomes and ratios the caller may use (cost fields and field-ruled money left out).

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Response · 200

datarequired: ReportCatalogue
What the caller may report on: entities, fields, outcomes, ratios.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/reports/builder/catalogue' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "entities": [
      {
        "key": "leads",
        "label": "string",
        "noun": [],
        "description": "string",
        "default_date": "string",
        "fields": [
          {
            "key": "string",
            "label": "string",
            "type": "string",
            "section": "string",
            "options": [
              null
            ],
            "of": "string",
            "nullable": true,
            "groupable": true,
            "measurable": true,
            "rangeable": true,
            "money": true,
            "unit": "minutes",
            "day": true
          }
        ],
        "outcomes": [
          {
            "key": "string",
            "label": "string"
          }
        ],
        "ratios": [
          {
            "key": "string",
            "label": "string",
            "money": true
          }
        ]
      }
    ],
    "teams": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "can": {
      "build": true,
      "share_company": true,
      "schedule": true,
      "export": true,
      "settings": true,
      "external_recipients": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/reports/builder/drill

Records behind a report cell

The records of one group (and series) of a spec — only those you may open (the record’s own view scope), newest first, 50 a page. `group` / `split` are the result’s row and series keys.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Request body

specrequired: ReportSpec
A report: entity, filter (shared DSL), range, up to 4 measures (count, sum/avg/min/max of a field, count_if / rate of an outcome, a catalogue ratio), a group-by and an optional split, sort, top-N and the chart.
group: string or null
split: string or null
period: object or null
period.presetrequired: "today" | "yesterday" | "tomorrow" | "this_week" | "last_week" | "next_week" | … or null
period.fromrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
period.torequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
cursor: string or null

Response · 200

datarequired: ReportDrillPage
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/builder/drill' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"},"group":"string","split":"string","period":{"preset":"today","from":"2026-10-06","to":"2026-10-06"},"cursor":"string"}'

Response example

{
  "data": {
    "rows": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "subtitle": "string",
        "at": "2026-10-06T05:30:00.000Z",
        "owner": "string",
        "link": "string"
      }
    ],
    "next": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/reports/builder/run

Run a report

Runs an unsaved spec within your report scope (422 with spec paths when it cannot run).

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Request body

specrequired: ReportSpec
A report: entity, filter (shared DSL), range, up to 4 measures (count, sum/avg/min/max of a field, count_if / rate of an outcome, a catalogue ratio), a group-by and an optional split, sort, top-N and the chart.
period: object or null
period.presetrequired: "today" | "yesterday" | "tomorrow" | "this_week" | "last_week" | "next_week" | … or null
period.fromrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
period.torequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: ReportResult
Totals over everything that matched, the groups (top N) and notes.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/builder/run' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"},"period":{"preset":"today","from":"2026-10-06","to":"2026-10-06"}}'

Response example

{
  "data": {
    "mode": "kpi",
    "entity": "leads",
    "title": "string",
    "group": {
      "field": "string",
      "label": "string"
    },
    "split": {
      "field": "string",
      "label": "string"
    },
    "columns": [
      {
        "key": "string",
        "label": "string",
        "kind": "text"
      }
    ],
    "rows": [
      {
        "key": "string",
        "label": "string",
        "cells": {},
        "split": {}
      }
    ],
    "series": [
      {
        "key": "string",
        "label": "string",
        "totals": {}
      }
    ],
    "totals": {},
    "groups": 0,
    "truncated": true,
    "range": {
      "label": "string",
      "from_day": "2026-10-06",
      "to_day": "2026-10-06"
    },
    "notes": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/reports/custom

Saved reports

Your reports, your teams’ and the company’s (built-in reports for those who schedule).

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

qquery: string
entityquery: string
minequery: "1"

Response · 200

datarequired: array of CustomReport
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/reports/custom' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "description": "string",
      "entity": "string",
      "visibility": "private",
      "team": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "spec": {
        "v": 1,
        "entity": "leads",
        "filter": null,
        "range": {
          "field": "string",
          "preset": "today",
          "from": "string",
          "to": "string"
        },
        "measures": [
          {
            "fn": "count",
            "field": "string"
          }
        ],
        "group_by": {
          "field": "string",
          "bucket": "day"
        },
        "split_by": {
          "field": "string",
          "bucket": "day"
        },
        "sort": {
          "by": "value",
          "dir": "asc"
        },
        "limit": 1,
        "visual": "table"
      },
      "preset": "string",
      "version": 0,
      "author": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "mine": true,
      "editable": true,
      "schedules": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/reports/custom

Save a report

Company-wide sharing needs `reports.schedule`; team sharing a team you belong to.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Request body

namerequired: string
description: string or null
visibility: "private" | "team" | "company"
team_id: Id or null
Opaque record id.
specrequired: ReportSpec
A report: entity, filter (shared DSL), range, up to 4 measures (count, sum/avg/min/max of a field, count_if / rate of an outcome, a catalogue ratio), a group-by and an optional split, sort, top-N and the chart.

Response · 201

datarequired: CustomReport
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/custom' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","visibility":"private","team_id":"cmusrceel0000q7kaafxqi1om","spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "entity": "string",
    "visibility": "private",
    "team": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spec": {
      "v": 1,
      "entity": "leads",
      "filter": null,
      "range": {
        "field": "string",
        "preset": "today",
        "from": "string",
        "to": "string"
      },
      "measures": [
        {
          "fn": "count",
          "field": "string"
        }
      ],
      "group_by": {
        "field": "string",
        "bucket": "day"
      },
      "split_by": {
        "field": "string",
        "bucket": "day"
      },
      "sort": {
        "by": "value",
        "dir": "asc"
      },
      "limit": 1,
      "visual": "table"
    },
    "preset": "string",
    "version": 0,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "schedules": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/reports/custom/{id}

A saved report

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: CustomReport
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/reports/custom/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "entity": "string",
    "visibility": "private",
    "team": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spec": {
      "v": 1,
      "entity": "leads",
      "filter": null,
      "range": {
        "field": "string",
        "preset": "today",
        "from": "string",
        "to": "string"
      },
      "measures": [
        {
          "fn": "count",
          "field": "string"
        }
      ],
      "group_by": {
        "field": "string",
        "bucket": "day"
      },
      "split_by": {
        "field": "string",
        "bucket": "day"
      },
      "sort": {
        "by": "value",
        "dir": "asc"
      },
      "limit": 1,
      "visual": "table"
    },
    "preset": "string",
    "version": 0,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "schedules": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/reports/custom/{id}

Change a saved report

A changed name or spec is a new version. Only the author changes who sees it.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
description: string or null
visibility: "private" | "team" | "company"
team_id: Id or null
Opaque record id.
spec: ReportSpec
A report: entity, filter (shared DSL), range, up to 4 measures (count, sum/avg/min/max of a field, count_if / rate of an outcome, a catalogue ratio), a group-by and an optional split, sort, top-N and the chart.

Response · 200

datarequired: CustomReport
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/reports/custom/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","visibility":"private","team_id":"cmusrceel0000q7kaafxqi1om","spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "entity": "string",
    "visibility": "private",
    "team": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spec": {
      "v": 1,
      "entity": "leads",
      "filter": null,
      "range": {
        "field": "string",
        "preset": "today",
        "from": "string",
        "to": "string"
      },
      "measures": [
        {
          "fn": "count",
          "field": "string"
        }
      ],
      "group_by": {
        "field": "string",
        "bucket": "day"
      },
      "split_by": {
        "field": "string",
        "bucket": "day"
      },
      "sort": {
        "by": "value",
        "dir": "asc"
      },
      "limit": 1,
      "visual": "table"
    },
    "preset": "string",
    "version": 0,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "schedules": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/reports/custom/{id}

Delete a saved report

Archives it and pauses its schedules (the delivery log stays).

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/reports/custom/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/reports/custom/{id}/duplicate

Copy a report

A private copy for you of any report you may open.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 201

datarequired: CustomReport
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/custom/{id}/duplicate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "entity": "string",
    "visibility": "private",
    "team": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spec": {
      "v": 1,
      "entity": "leads",
      "filter": null,
      "range": {
        "field": "string",
        "preset": "today",
        "from": "string",
        "to": "string"
      },
      "measures": [
        {
          "fn": "count",
          "field": "string"
        }
      ],
      "group_by": {
        "field": "string",
        "bucket": "day"
      },
      "split_by": {
        "field": "string",
        "bucket": "day"
      },
      "sort": {
        "by": "value",
        "dir": "asc"
      },
      "limit": 1,
      "visual": "table"
    },
    "preset": "string",
    "version": 0,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "schedules": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/reports/custom/{id}/export

Download a report as CSV

The report’s result within your scope, formula-safe; audited. Needs a fresh step-up.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.export.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/reports/custom/{id}/export' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/reports/custom/{id}/run

Run a saved report

Within your own scope and field rules; `period` replaces its range.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.

Request body

period: object or null
period.presetrequired: "today" | "yesterday" | "tomorrow" | "this_week" | "last_week" | "next_week" | … or null
period.fromrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
period.torequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: ReportResult
Totals over everything that matched, the groups (top N) and notes.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/custom/{id}/run' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"period":{"preset":"today","from":"2026-10-06","to":"2026-10-06"}}'

Response example

{
  "data": {
    "mode": "kpi",
    "entity": "leads",
    "title": "string",
    "group": {
      "field": "string",
      "label": "string"
    },
    "split": {
      "field": "string",
      "label": "string"
    },
    "columns": [
      {
        "key": "string",
        "label": "string",
        "kind": "text"
      }
    ],
    "rows": [
      {
        "key": "string",
        "label": "string",
        "cells": {},
        "split": {}
      }
    ],
    "series": [
      {
        "key": "string",
        "label": "string",
        "totals": {}
      }
    ],
    "totals": {},
    "groups": 0,
    "truncated": true,
    "range": {
      "label": "string",
      "from_day": "2026-10-06",
      "to_day": "2026-10-06"
    },
    "notes": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/reports/custom/{id}/versions

Versions of a saved report

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of CustomReportVersion
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/reports/custom/{id}/versions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "version": 0,
      "name": "string",
      "spec": {
        "v": 1,
        "entity": "leads",
        "filter": null,
        "range": {
          "field": "string",
          "preset": "today",
          "from": "string",
          "to": "string"
        },
        "measures": [
          {
            "fn": "count",
            "field": "string"
          }
        ],
        "group_by": {
          "field": "string",
          "bucket": "day"
        },
        "split_by": {
          "field": "string",
          "bucket": "day"
        },
        "sort": {
          "by": "value",
          "dir": "asc"
        },
        "limit": 1,
        "visual": "table"
      },
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "current": true
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/reports/custom/{id}/versions/{version}/restore

Restore a version

Saves the old version again as the newest one.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reports.view.

Parameters

idpathrequired: Id
Opaque record id.
versionpathrequired: integer

Response · 200

datarequired: CustomReport
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/custom/{id}/versions/{version}/restore' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "entity": "string",
    "visibility": "private",
    "team": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spec": {
      "v": 1,
      "entity": "leads",
      "filter": null,
      "range": {
        "field": "string",
        "preset": "today",
        "from": "string",
        "to": "string"
      },
      "measures": [
        {
          "fn": "count",
          "field": "string"
        }
      ],
      "group_by": {
        "field": "string",
        "bucket": "day"
      },
      "split_by": {
        "field": "string",
        "bucket": "day"
      },
      "sort": {
        "by": "value",
        "dir": "asc"
      },
      "limit": 1,
      "visual": "table"
    },
    "preset": "string",
    "version": 0,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "schedules": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": { "entities": [ { "key": "leads", "label": "string", "noun": [], "description": "string", "default_date": "string", "fields": [ { "key": "string", "label": "string", "type": "string", "section": "string", "options": [ null ], "of": "string", "nullable": true, "groupable": true, "measurable": true, "rangeable": true, "money": true, "unit": "minutes", "day": true } ], "outcomes": [ { "key": "string", "label": "string" } ], "ratios": [ { "key": "string", "label": "string", "money": true } ] } ], "teams": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "can": { "build": true, "share_company": true, "schedule": true, "export": true, "settings": true, "external_recipients": true } }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/reports/builder/drill' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"},"group":"string","split":"string","period":{"preset":"today","from":"2026-10-06","to":"2026-10-06"},"cursor":"string"}'

{ "data": { "rows": [ { "id": "cmusrceel0000q7kaafxqi1om", "title": "string", "subtitle": "string", "at": "2026-10-06T05:30:00.000Z", "owner": "string", "link": "string" } ], "next": "string" }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/reports/builder/run' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"},"period":{"preset":"today","from":"2026-10-06","to":"2026-10-06"}}'

{ "data": { "mode": "kpi", "entity": "leads", "title": "string", "group": { "field": "string", "label": "string" }, "split": { "field": "string", "label": "string" }, "columns": [ { "key": "string", "label": "string", "kind": "text" } ], "rows": [ { "key": "string", "label": "string", "cells": {}, "split": {} } ], "series": [ { "key": "string", "label": "string", "totals": {} } ], "totals": {}, "groups": 0, "truncated": true, "range": { "label": "string", "from_day": "2026-10-06", "to_day": "2026-10-06" }, "notes": [ "string" ] }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "description": "string", "entity": "string", "visibility": "private", "team": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "spec": { "v": 1, "entity": "leads", "filter": null, "range": { "field": "string", "preset": "today", "from": "string", "to": "string" }, "measures": [ { "fn": "count", "field": "string" } ], "group_by": { "field": "string", "bucket": "day" }, "split_by": { "field": "string", "bucket": "day" }, "sort": { "by": "value", "dir": "asc" }, "limit": 1, "visual": "table" }, "preset": "string", "version": 0, "author": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "mine": true, "editable": true, "schedules": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/reports/custom' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","description":"string","visibility":"private","team_id":"cmusrceel0000q7kaafxqi1om","spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"}}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "description": "string", "entity": "string", "visibility": "private", "team": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "spec": { "v": 1, "entity": "leads", "filter": null, "range": { "field": "string", "preset": "today", "from": "string", "to": "string" }, "measures": [ { "fn": "count", "field": "string" } ], "group_by": { "field": "string", "bucket": "day" }, "split_by": { "field": "string", "bucket": "day" }, "sort": { "by": "value", "dir": "asc" }, "limit": 1, "visual": "table" }, "preset": "string", "version": 0, "author": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "mine": true, "editable": true, "schedules": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/reports/custom/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","description":"string","visibility":"private","team_id":"cmusrceel0000q7kaafxqi1om","spec":{"v":1,"entity":"leads","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"split_by":{"field":"string","bucket":"day"},"sort":{"by":"value","dir":"asc"},"limit":1,"visual":"table"}}'

curl -X POST 'https://api.propzolo.com/v1/reports/custom/{id}/run' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"period":{"preset":"today","from":"2026-10-06","to":"2026-10-06"}}'

{ "data": [ { "version": 0, "name": "string", "spec": { "v": 1, "entity": "leads", "filter": null, "range": { "field": "string", "preset": "today", "from": "string", "to": "string" }, "measures": [ { "fn": "count", "field": "string" } ], "group_by": { "field": "string", "bucket": "day" }, "split_by": { "field": "string", "bucket": "day" }, "sort": { "by": "value", "dir": "asc" }, "limit": 1, "visual": "table" }, "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "current": true } ], "meta": {} }