Response Codes

Overview

Explore the various possible response codes and their meanings.

These error codes can be encountered in all:

Codes received with Elasticsearch DSL, Search filters, and Collect endpoints

Codes received with Bulk Collect endpoints

Codes received with Webhook subscription endpoints

Search and collect response codes

Response code
Description

200

A successful request

400

Request was unacceptable, often due to a missing required parameter.

401

No valid API Key was provided. Check if your key is valid and try again.

404

  • Nonexistent API URL while making a request will result in a 404 error message.

  • Nonexistent ID: Using a profile ID that does not exist in our database, you will receive the following response:

422

Incorrect data structure or data types are provided in the request.

429

Endpoint rate limit has been exceeded. All API endpoints restrict the number of requests allowed per second for each client's API Key. Find all rate limits here.

500

Code 500 denotes server issues. One possible example is that the wrong request type was selected (POST/GET).

502

Bad Gateway

503

Service is unavailable due to too many requests being received by our API.

Bulk Collect response codes

Response codes
Description

201

A successful request.

202

The process is in progress.

400

Indicates incorrectly formatted or oversized files or invalid data.

402

Insufficient credits. Reduce your request size or contact your account manager to get more credits.

Note: error code can be received using search and collect endpoints.

404

Request did not find any matching IDs.

409

Duplicate POST requests were submitted.

422

  • Request exceeded the limit of 10k IDs

  • The provided URLs cannot be parsed into shorthand names

  • Input does not meet the shorthand_names requirements

  • Request input includes duplicates

503

Collect allows you to download the prepared dataset as often as you like within 30 days of submitting the query. After 30 days of query submission, the GET query will return a 404 response code.

Subscriptions response codes

ID endpoint response codes

Request code
Description

200

Successful request

400

  • Error codes indicate failures due to incorrectly formatted or oversized files or invalid data.

  • The subscription has already expired.

  • Renewing a subscription would push the expiry date over 1 year away.

401

No valid API Key was provided. Check if your key is valid and try again.

404

Subscription doesn’t exist or doesn’t belong to the user

409

Subscription was just created and hasn’t finished initialising

422

The webhook URL you provided is invalid.

5xx

Unable to create subscription due to a server error.

Search Filter and ES DSL endpoint response codes

Request code
Description

200

A successful request

400

The request was unacceptable, often due to a missing required parameter.

401

No valid API Key was provided. Check if your key is valid and try again.

422

There are two possible reasons for the 422 error code:

  1. The webhook URL you provided is invalid

  2. ou have used incompatible filters (such as any date filter from search filters or ES DSL schema).

Last updated

Was this helpful?