Errors

This guide covers what happens when something goes wrong while you work with the API, along with the status codes and error types you might encounter. To tell if your request was successful, check the status code on the API response. If a response comes back unsuccessful, use the error type and error message to figure out what went wrong and debug before contacting support.

Before reaching out to support, double-check your code. Most reported errors turn out to be in the request itself rather than the API.

Status codes

Here is a list of the different categories of status codes returned by the Datamagnet API. Use these to understand if a request was successful.

Status Code	Description
2xx	A 2xx status code indicates a successful response.
4xx	A 4xx status code indicates a client error — something in your request needs to be corrected.
5xx	A 5xx status code indicates a server error on our side. These are rare.

Error types

When a request is unsuccessful, the Datamagnet API returns an error response with an error type and message. Use this information to understand what went wrong and how to fix it. Most error messages are designed to be actionable. The Datamagnet API uses two error types, listed below.

Error response format

Error response

{
  "type": "api_error",
  "message": "No way this is happening!?",
  "documentation_url": "https://docs.datamagnet.co/errors/api_error"
}

Error types

Error Type	Description
api_error	Indicates an error on the Datamagnet side. These are rare.
invalid_request	Indicates an error in your request, such as missing or malformed parameters.

Getting Started

Concepts

Errors

Errors

Status codes

Error types

Error response format

Error types

​Errors

​Status codes

​Error types

​Error response format

​Error types

Errors

Status codes

Error types

Error response format

Error types