CustomReport

object

idrequired: Id
Opaque record id.
namerequired: string
descriptionrequired: string or null
entityrequired: string
visibilityrequired: "private" | "team" | "company"
teamrequired: object or null
team.idrequired: Id
Opaque record id.
team.namerequired: string
specrequired: ReportSpec or null
null for a built-in report (preset).
presetrequired: string or null
versionrequired: integer
authorrequired: object or null
author.idrequired: Id
Opaque record id.
author.namerequired: string
minerequired: boolean
editablerequired: boolean
schedulesrequired: integer
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "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"
}