Alerts & Troubleshooting

Successful search API responses return a 200 response but may contain either alerts or warnings.

This page will help you identify and troubleshoot alerts.

For warnings, consult the search API Reference for instructions on how better format your query based on warning contents.

Response Object

The response object is rich.

Errors will appear within the alerts or warnings array of the meta object.

{
  "meta": {
    "alerts": [], // Indicates issues with the App Search service.
    "warnings": [], // Indicates issues with query formation.
    "page": {
      "current": integer,
      "total_pages": integer,
      "total_results": integer,
      "size": integer
    },
    "request_id": "9c4c527ba0f57e6bafb1f318167eaa04"
  },
  "results": [

  # ... Documents.

  ]
}

5001: Degraded search results

It is helpful to know whether a query has timed out, or whether the query returned no results.

A 5001 error indicates that the query could not be completed in full.

Use the 5001 error to initiate a retry of the query, perhaps after assessing whether the given parameters are bloating the query.

If the issue persists, please contact support.

Stuck? Looking for help? Contact support or check out the App Search community forum!