ResponseError

Error information returned in the response body when a Recommendations or Suggestions request fails.

Declaration

object RecommendationResponseError

Properties

Name	Type	Description
`code`	string	A machine-readable error code identifying the failure type, useful for programmatic error handling. Read-only.
`message`	string	A human-readable summary of what went wrong. Read-only.
`details`	[`RecommendationResponseErrorDetail`]	An array of granular error detail objects providing field-level context, one per issue. See ResponseErrorDetail. Read-only.

Discussion

The ResponseError object is embedded in the error field of the response envelope when a Recommendations or Suggestions request fails.

When the error involves multiple field-level issues (for example, validation failures on several request fields), inspect the details array to identify and correct each specific problem before retrying the request.

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid query request",
  "details": [
    {
      "code": "MISSING_REQUIRED_FILTER",
      "message": "Filter 'promotedObjectId' is required"
    }
  ]
}

ResponseError

Declaration

Properties

Discussion

Example

See Also