Skip to main content
← All schemas

CustomReportVersion

object

versionrequired
integer
namerequired
string
specrequired
ReportSpec or null

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.

created_byrequired
object or null
created_by.idrequired
Id

Opaque record id.

created_by.namerequired
string
created_atrequired
DateTime

Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

currentrequired
boolean
Example
{
  "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
}