Skip to main content

Insights resource validation rules for IDs, types, status, and data availability checks

Resource ID

INSIGHTS__INVALID_RESOURCE_ID_MISSING

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

INSIGHTS__INVALID_RESOURCE_ID

DefinitionSeverityAPISampleMode
Validate that resourceId is present
VIOLATION
POST
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_RESOURCE_ID",
"message": "Field '{{field}}' must be Apple-generated resource ID, ex: '13213131313'",
"context": {
"field": "resourceId"
}
}

INSIGHTS__INVALID_RESOURCE_ID_NO_INSIGHTS

DefinitionSeverityAPISampleMode
Validate that Insights data is available for the identified resource
VIOLATION
POST
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_RESOURCE_ID_NO_INSIGHTS",
"message": "Insights data not yet available for '{{id}}'",
"context": {
"id": "9467895078742654976"
}
}

Resource Status

INSIGHTS__INVALID_RESOURCE_STATUS_SPATIAL

DefinitionSeverityAPISampleMode
Validate that spatial insights queries are supported for the identified resource
VIOLATION
POST
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_RESOURCE_STATUS_SPATIAL",
"message": "Location '{{id}}' does not support spatial insights queries",
"context": {
"id": "9467895078742654976"
}
}

INSIGHTS__INVALID_RESOURCE_STATUS_GENERIC

DefinitionSeverityAPISampleMode
Validate that generic insights queries are supported for the identified resource
VIOLATION
POST
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_RESOURCE_STATUS_GENERIC",
"message": "Location '{{id}}' does not support generic insights queries",
"context": {
"id": "9467895078742654976"
}
}

Resource Type

INSIGHTS__INVALID_RESOURCETYPE

DefinitionSeverityAPISampleMode
Validate that resourceType value is valid
VIOLATION
POST
Link
S
Example Validation Report
{
"code": "INSIGHTS__INVALID_RESOURCETYPE",
"message": "The value '{{value}}' for field '{{field}}' is invalid. Valid values are {{validValue}}",
"context": {
"field": "resourceType",
"value": "AREA",
"validValue": "LOCATION"
}
}

INSIGHTS__INVALID_RESOURCETYPE_MISSING

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