Insights start date validation rules for format, ranges, spatial reports, and interval alignment

Start Date

INSIGHTS__INVALID_SPATIAL_DATES_VALUE

Definition	Severity	API	Sample	Mode
Validate that startDate and endDate are suitable for generation of a spatial report

Example Validation Report

{
  "code": "INSIGHTS__INVALID_SPATIAL_DATES_VALUE",
  "message": "Start date '{{startDate}}' and end date '{{endDate}}' not suitable for spatial reports, must be 1 month or 1 year interval, start date arranged to beginning of month, end date arranged to end of month",
  "context": {
    "startDate": "2026-10-15",
    "endDate": "2026-11-23"
  }
}

INSIGHTS__INVALID_STARTDATE

Definition	Severity	API	Sample	Mode
Validate that startDate value is valid

Example Validation Report

{
  "code": "INSIGHTS__INVALID_STARTDATE",
  "message": "Field '{{field}}' must be in format of date without a time part, ex: '2024-10-22'",
  "context": {
    "field": "startDate"
  }
}

INSIGHTS__INVALID_STARTDATE_MAX

Definition	Severity	API	Sample	Mode
Validate that startDate is not after a permitted date

Example Validation Report

{
  "code": "INSIGHTS__INVALID_STARTDATE_MAX",
  "message": "Field '{{field}}' cannot be after '{{maxValue}}'",
  "context": {
    "field": "startDate",
    "maxValue": "2026-10-13"
  }
}

INSIGHTS__INVALID_STARTDATE_MIN

Definition	Severity	API	Sample	Mode
Validate that startDate is not before a permitted date

Example Validation Report

{
  "code": "INSIGHTS__INVALID_STARTDATE_MIN",
  "message": "Field '{{field}}' cannot be before '{{minValue}}'",
  "context": {
    "field": "startDate",
    "minValue": "2026-05-13"
  }
}

INSIGHTS__INVALID_STARTDATE_MISSING

Definition	Severity	API	Sample	Mode
Validate that startDate is present			Link

Example Validation Report

{
  "code": "INSIGHTS__INVALID_STARTDATE_MISSING",
  "message": "Field '{{field}}' must be present",
  "context": {
    "field": "startDate"
  }
}

INSIGHTS__INVALID_STARTDATE_MUST_START_WEEK

Definition	Severity	API	Sample	Mode
Validate startDate week

Example Validation Report

{
  "code": "INSIGHTS__INVALID_STARTDATE_MUST_START_WEEK",
  "message": "Date is not arranged to interval: '{{value}}', field: '{{field}}', start date must be first day of week, ex: '{{validValue}}'",
  "context": {
    "field": "startDate",
    "value": "DAY",
    "validValue": "2026-05-13"
  }
}

INSIGHTS__INVALID_STARTDATE_MUST_START_MONTH

Definition	Severity	API	Sample	Mode
Validate startDate month

Example Validation Report

{
  "code": "INSIGHTS__INVALID_STARTDATE_MUST_START_MONTH",
  "message": "Date is not arranged to interval: '{{value}}', field: '{{field}}', start date must be first day of week, ex: '{{validValue}}'",
  "context": {
    "field": "startDate",
    "value": "DAY",
    "validValue": "2026-05-13"
  }
}

INSIGHTS__INVALID_TOTALS_INTERVAL

Definition	Severity	API	Sample	Mode
Validate that startDate is suitable for use with the specified timeGranularity

Example Validation Report

{
  "code": "INSIGHTS__INVALID_TOTALS_INTERVAL",
  "message": "Field '{{field}}' has invalid value '{{value}}, totals only supported for interval WEEK or MONTH",
  "context": {
    "field": "startDate",
    "value": "2026-05-13"
  }
}

INSIGHTS__INVALID_TOTALS_DATES

Definition	Severity	API	Sample	Mode
Validate that startDate is suitable for use

Example Validation Report

{
  "code": "INSIGHTS__INVALID_TOTALS_DATES",
  "message": "Field '{{field}}' has invalid value '{{value}}, for totals dates must be arranged to week or month",
  "context": {
    "field": "startDate",
    "value": "2026-05-13"
  }
}

INSIGHTS__INVALID_DATES_INCOMPLETE_TOTAL

Definition	Severity	API	Sample	Mode
Validate that reporting period encompassed by startDate and endDate is completed

Example Validation Report

{
  "code": "INSIGHTS__INVALID_DATES_INCOMPLETE_TOTAL",
  "message": "Period not complete for '{{id}}'. Start date '{{startDate}}' and end date '{{endDate}} totals not yet available",
  "context": {
    "id": "9467895078742654976",
    "startDate": "2026-10-01",
    "endDate": "2026-10-31"
  }
}