Skip to content

Error responses

In some ocasions, and for different reasons, we might not be able to process your request and return results back to you, at which point we will return an error response. Review Index API uses a common error response format, which is described below:

Error response format

API error response example 
{
    "success": false,
    "message": "Nothing to fetch - no results from search",
    "request_id": "1694794050484291168-2cd1089a-1b02-4c",
    "credits_used": 1,
    "details": "Sorry, we were not able to find any results for your search. Try to modify the request by adding more information about the company and make sure we support the company requested. If the issue persists, please get in touch with us at support@datashake.com.",
    "request": {
        "name": "Hilton Singapore Orchard",
        "priority_job": false,
        "city": null,
        "external_identifier": null,
        "state": null,
        "strictness": "none",
        "zip_code": null,
        "domain": null,
        "per_page": 10,
        "review_site": [
            "capterra"
        ],
        "phone_number": null,
        "update": false,
        "ticker_symbol": null,
        "callback": "https://example.com/callback",
        "address": "333 Orchard Rd, Singapore 238867",
        "page_number": 1,
        "country": null,
        "street": null
    }
}

Error response fields

  • We always return request_id, which you can forward us for troubleshooting if needed.
  • We always return credits_used, which tells you how many credits were used for this request. For more information on credits and what failed requests we charge, please see the Tips and tricks section.
  • We return message and details fields which you can use to determine which type of error occcurred.
  • We return request field which just describes the request you submitted. This is useful for debugging purposes (both for you and us).

Common errors

No results

The request failed because we were unable to find any results for your search. It will likely be the most common error you will encounter and it's not directly caused due to an application error. It could be happening because your input does not quite match the data we found or because there are no results at all for your search.

Related messages:
- Nothing to fetch - no results from search
- No results
- No profiles
- No groups

{
    "success": false,
    "message": "Nothing to fetch - no results from search",
    "request_id": "1694794050484291168-2cd1089a-1b02-4c",
    "credits_used": 1,
    "details": "...",
    "request": {
        ...
    }
}
Task failed

The request failed because we were unable to process your request even though we found results for your search. Usually happens when our crawlers are unable to fetch data from review sites. When you encounter this error, please retry your request after a few minutes. If the issue persists, please contact us.

Related messages:
- Task failed

{
    "success": false,
    "message": "Task failed",
    "request_id": "1694794050484291168-2cd1089a-1b02-4c",
    "credits_used": 1,
    "details": "...",
    "request": {
        ...
    }
}
Unexpected error

The request failed due to an application issue. If you encounter this error, please contact us and forward us the request_id field so we can investigate. No credits will be deducted from your account for this type of error.

Related messages:
- Unexpected error

{
    "success": false,
    "message": "Unexpected error",
    "request_id": "1694794050484291168-2cd1089a-1b02-4c",
    "credits_used": 1,
    "details": "...",
    "request": {
        ...
    }
}