Troubleshooting

API errors in the Edge Network API can have a variety of causes, internal (Edge Network itself) or external (input, configuration, or upstream related).

Error types

Severity

Edge Network API errors can also be split by severity:

• Fatal errors halt the dispatch pipeline.
• Non-fatal errors could signal a partial processing, while allowing for request processing to continue. When present, the overall status code of the request becomes 207 Multi-Status.

Fatal errors

Fatal errors halt the request processing and cause a non-2xx response status to be returned. See the error types section to see the expected status code, corresponding to each error type.

Errors are accompanied by a response body containing an error object. In this case, the response body contains a problem detail, as defined by RFC 7807 Problem Details for HTTP APIs.

The returned content-type is the application/problem+json media type. When present, this response contains machine-readable details pertaining to the error. Problem details include a URI type.

All error objects have a type, status, title, detail and report message properties so that the API client can tell what the problem is.

Copy
Copied to your clipboard
{
   "type":"https://ns.adobe.com/aep/errors/EXEG-0104-422",
   "status":422,
   "title":"Unprocessable entity",
   "detail":"Invalid request (report attached). Please check your input and try again.",
   "report":{
      "errors":[
         "Allowed Adobe version is 1.0 for standard 'Adobe' at index 0",
         "Allowed IAB version is 2.0 for standard 'IAB TCF' at index 1",
         "IAB consent string value must not be empty for standard 'IAB TCF' at index 1"
      ],
      "requestId":"0f8821e5-ed1a-4301-b445-5f336fb50ee8",
      "orgId":"53A16ACB5CC1D3760A495C99@AdobeOrg"
   }
}

Non-fatal errors

Non-fatal errors can be further broken down into:

• Errors: Issues that occurred while processing the request, but did not cause the entire request to be rejected (eg. a non-critical upstream failure).
• Warnings: Messages from upstream services which could signal that a partial processing of the request occurred.

When encountering non-fatal errors (excluding warnings), the API changes the response status to 207 Multi-Status.

Warnings, on the other hand, are mostly informative, as they generally represent a potentially transient condition, which did not impact the request to full extent. One example here is a partial profile read in the segmentation engine, in which case the accuracy is impacted to some degree, but the functionality is still delivered.

Non-fatal errors are represented in the Problem Details format, but are embedded directly in the gateway's standard response, which is of type application/json.

Copy
Copied to your clipboard
{
  "requestId": "72eaa048-207e-4dde-bf16-0cb2b21336d5",
  "handle": [
  ],
  "errors": [
    {
      "type": "https://ns.adobe.com/aep/errors/EXEG-0201-503",
      "status": 503,
      "title": "The 'com.adobe.experience.platform.ode' service is temporarily unable to serve this request. Please try again later."
    }
  ],
  "warnings": [
    {
      "type": "https://ns.adobe.com/aep/errors/EXEG-0204-200",
      "status": 200,
      "title": "A warning occurred while calling the 'com.adobe.audiencemanager' service for this request.",
      "report": {
        "cause": {
          "message": "Cannot read related customer for device id: ...",
          "code": 202
        }
      }
    }
  ]
}

General error codes guidance

The table below includes general information about the most frequently encountered types of errors. For more detailed information about other error codes, see the detailed error codes list further below on this page.

Detailed error codes list

The table below includes all the available Edge Network API error codes, along with their descriptions. Refer to this table if you encounter errors with your integration.

Last updated 11/13/2024

Was this helpful?

Yes

No