Insights report name validation rules for metric limits and valid report types

Report Name

INSIGHTS__INVALID_METRICS_TOO_MANY_QUICKREPORT

Definition	Severity	API	Sample	Mode
Validate that the requested count of metrics is permitted

Example Validation Report

{
  "code": "INSIGHTS__INVALID_METRICS_TOO_MANY_QUICKREPORT",
  "message": "Too many metrics requested: '{{value}}', field: '{{field}}', '{{maxValue}}' supported",
  "context": {
    "field": "reportName",
    "metric": "PLACECARD_TAP_ORDER",
    "maxValue": "50"
  }
}

INSIGHTS__INVALID_REPORT

Definition	Severity	API	Sample	Mode
Validate that reports value is valid			Link

Example Validation Report

{
  "code": "INSIGHTS__INVALID_REPORT",
  "message": "Value '{{value}}' for field '{{field}}' is invalid. Valid values are '{{validValue}}'",
  "context": {
    "field": "reportName",
    "value": "MY_REPORT",
    "validValue": "SEARCH_LOCATION_TAP,SEARCH_LOCATION_TAP_NAME,SEARCH_LOCATION_TAP_CATEGORY,SEARCH_LOCATION_TAP_OTHER,SEARCH_LOCATION_TAP_COMBINEDPLACECARD_VIEW,PLACECARD_TAP_DIRECTION,PLACECARD_TAP_WEBSITE,PLACECARD_TAP_CALL,PLACECARD_TAP_SHARE,PLACECARD_TAP_SHOWCASE,PLACECARD_TAP_ORDER,PLACECARD_RESERVE_PARKING,PLACECARD_RESERVE_TABLE,PLACECARD_JOIN_WAITLIST,PLACECARD_ORDER_DELIVERY,PLACECARD_ORDER_FOOD,PLACECARD_ORDER_TAKEOUT,PLACECARD_PICKUP,PLACECARD_VIEW_MENU,PLACECARD_SCHEDULE_APPOINTMENT,PLACECARD_VIEW_AVAILABILITY,PLACECARD_VIEW_PRICING,PLACECARD_COMBINED,SPATIAL_SEARCH_LOCATION_TAP,SPATIAL_DIRECTION_LOCATION_TAP"
  }
}

INSIGHTS__INVALID_REPORT_MISSING

Definition	Severity	API	Sample	Mode
Validate that reports is present			Link

Example Validation Report

{
  "code": "INSIGHTS__INVALID_REPORT_MISSING",
  "message": "Field '{{field}}' must be present",
  "context": {
    "field": "reportName"
  }
}