Skip to content

Report Parameters

Universal parameters available when creating and configuring any LightLead report.

Overall parameter structure

Every report is built from the following set of parameters:

json
{
  "name": "string",
  "source_ids": ["uuid"],
  "date_range": "object",
  "dimensions": ["string"],
  "metrics": ["string"],
  "filters": ["object"],
  "sorting": ["object"],
  "write_mode": "string",
  "schedule": "object|null"
}

Parameters

ParameterTypeRequiredDescription
namestringYesThe report name, shown in the UI
source_idsarray of UUIDsYesIdentifiers of the sources data is pulled from
date_rangeobjectYesThe date range: preset or custom
dimensionsarray of stringsNoDimensions (grouping columns)
metricsarray of stringsNoMetrics (numeric indicators)
calculated_metricsarray of objectsNoCalculated metrics with formulas
filtersarray of objectsNoRow filtering conditions
sortingarray of objectsNoSorting rules
write_modestringNoThe data update mode (Replace by default)
scheduleobjectNoThe automatic refresh schedule
limitnumberNoThe maximum number of rows in the result
currencystringNoThe currency to convert monetary metrics to
timezonestringNoThe time zone for time-based metrics

Date Range

The date_range object can take one of two forms:

Preset range:

json
{
  "preset": "last_7_days"
}

Custom range:

json
{
  "start": "2026-01-01",
  "end": "2026-01-31"
}

Available presets: today, yesterday, last_3_days, last_7_days, last_14_days, last_30_days, this_week, last_week, this_month, last_month, this_quarter, last_quarter, this_year, last_year, all_time.

Filters

Each filter consists of three elements:

json
{
  "field": "campaign_name",
  "operator": "CONTAIN",
  "value": "Search"
}

AND (all conditions) and OR (any condition) operators are supported. Nested logic is defined by grouping filters:

json
{
  "logic": "AND",
  "conditions": [
    {"field": "clicks", "operator": "GREATER_THAN", "value": 100},
    {"field": "cost", "operator": "GREATER_THAN", "value": 50}
  ]
}

Maintained by the LightLead Documentation Team · Last verified: 2026-07-25