Skip to main content

Insights validation rules for field values and time granularity requirements

Valid Values

INSIGHTS__INVALID_FIELD_VALUE

DefinitionSeverityAPISampleMode
Validate that a value is valid
VIOLATION
POST
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_FIELD_VALUE",
"message": "Field '{{field}}' has invalid value '{{value}}'",
"context": {
"field": "timeZoneId",
"value": "GMT"
}
}

Time Granularity

INSIGHTS__INVALID_TIMEGRANULARITY_MISSING

DefinitionSeverityAPISampleMode
Validate that timeGranularity is present
VIOLATION
POST
Link
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_TIMEGRANULARITY_MISSING",
"message": "Field '{{field}}' must be present",
"context": {
"field": "timeGranularity"
}
}

INSIGHTS__INVALID_TIMEGRANULARITY

DefinitionSeverityAPISampleMode
Validate that timeGranularity value is valid
VIOLATION
POST
Link
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_TIMEGRANULARITY",
"message": "The value '{{value}}' for field '{{field}}' is invalid. Valid values are {{validValue}}",
"context": {
"field": "timeGranularity",
"value": "FORTNIGHT",
"validValue": "DAY,WEEK MONTH"
}
}