General Introduction

Response Codes

6min

Overview
Explore the variety of possible response codes and what they mean.. 
﻿These error codes can be encountered in all:﻿
﻿Search and collect response codes﻿: codes received with Elasticsearch DSL, Search filters, and Collect endpoints
﻿Bulk Collect response codes﻿: codes received with Bulk Collect endpoints
﻿Webhook (subscriptions) response codes﻿: 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. The error message differs based on the error:
{
"Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']"
}
...
{
"Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]"
}
...
{
"Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]"
}
...
{
"Error": "Query validation failed: request does not support [query_string]"
}
...
{
"Error": "Query validation failed: failed to create query: compile error"
}
...
{
"Error": "Failed to parse es dsl query"
}
...
{
"Error": "Query results count exceeds allowed limit"
}
...
{
"Error": "Query execution was cancelled due to timeout"
}
...
{
"Error": "Query validation failed: failed to create query: compile error"
}
401
No valid API Key was provided. Check if your token is valid and try again.
404
Nonexistent API URL: Using DBAPI instead of CDAPI in the API URL while making a request will result in a 404 error message.
404 page not found
Nonexistent ID:  Using a profile ID that does not exist in our database, you will receive the following response:
{
    "detail": "Member not found"
}
422
Incorrect data structure or data types are provided in the request.
{
  "detail": [
    {
      "loc": [
        "body",
        22
      ],
      "msg": "Expecting property name enclosed in double quotes: line 3 column 1 (char 22)",
      "type": "value_error.jsondecode",
      "ctx": {
        "msg": "Expecting property name enclosed in double quotes",
        "doc": "{\n  \"name\": \"string\",\n}",
        "pos": 22,
        "lineno": 3,
        "colno": 1
      }
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "body"
      ],
      "msg": "Duplicate keys are not allowed within filters",
      "type": "value_error.duplicate"
    }
  ]
}
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.
"Error": "Service is temporarily unavailable"
Bulk Collect response codes
Response codes
Description
﻿201﻿
A successful request.
202
The process is in progress.
{
    "message": "Data request is still being processed"
}
400
Indicates incorrectly formatted or oversized files or invalid data:
{ 
 "detail": "File does not contain any data"
}
...
{ 
 "detail": "Unable to parse the file"
}
...
{
"detail": "File should consist of a single column"
}
...
{
"detail": "File contains invalid IDs"
}
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.
{
    "detail": "Insufficient credits"
}
404
Request did not find any matching IDs.
{
    "detail": "The request matched 0 IDs"
}
409
Duplicate POST requests were submitted.
{
    "detail": "Identical data request is already in progress."
}
422
Request exceeded the limit of 10k IDs.
{
    "detail": "The request matched too many IDs. Maximum is 10000 IDs"
}
503
Bulk 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 503 response code with the following message:
"Error": "File has expired and is no longer available"
Subscriptions response codes
ID endpoint response codes
Request code
Description
200
A successful request﻿
400
Error codes indicate failures due to incorrectly formatted or oversized files or invalid data.
The error message differs based on the error:
{ 
 "detail": "File does not contain any data"
}
...
{ 
 "detail": "File needs to be a CSV file"
}
...
{
"detail": "File needs to be smaller than 15MB"
}
...
{
"detail": "Unable to read the CSV file"
}
...
{
"detail": "File should consist of a single column"
}
...
{
"detail": "File contains invalid IDs"
}
...
{
"detail": "File contains incorrect IDs"
}
...
{
"detail": "File contains too many IDs"
}
401
No valid API Key was provided. Check if your token is valid and try again.
{
    "detail": "Could not identify user"
}
422
The webhook URL you provided is invalid.
{
    "detail": "Provided webhook URL is not valid"
}
5xx
Unable to create subscription due to a server error.
{
    "detail": "Unable to create subscription"
}
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. 
The error message differs based on the error:
{
"Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']"
}
...
{
"Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]"
}
...
{
"Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]"
}
...
{
"Error": "Query validation failed: request does not support [query_string]"
}
...
{
"Error": "Query validation failed: failed to create query: compile error"
}
...
{
"Error": "Failed to parse es dsl query"
}
...
{
"Error": " Query results count exceeds allowed limit"
}
401
No valid API Key was provided. Check if your token is valid and try again.
{
    "detail": "Could not identify user"
}
422
There are two possible reasons for the 422 error code:
The webhook URL you provided is invalid
You have used incompatible filters (such as any date filter from search filters or ES DSL schema).
﻿

Response code	Description
200	A successful request
400	Request was unacceptable, often due to a missing required parameter. The error message differs based on the error: { "Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']" } ... { "Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]" } ... { "Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]" } ... { "Error": "Query validation failed: request does not support [query_string]" } ... { "Error": "Query validation failed: failed to create query: compile error" } ... { "Error": "Failed to parse es dsl query" } ... { "Error": "Query results count exceeds allowed limit" } ... { "Error": "Query execution was cancelled due to timeout" } ... { "Error": "Query validation failed: failed to create query: compile error" }
401	No valid API Key was provided. Check if your token is valid and try again.
404	Nonexistent API URL: Using DBAPI instead of CDAPI in the API URL while making a request will result in a 404 error message. 404 page not found Nonexistent ID: Using a profile ID that does not exist in our database, you will receive the following response: { "detail": "Member not found" }
422	Incorrect data structure or data types are provided in the request. { "detail": [ { "loc": [ "body", 22 ], "msg": "Expecting property name enclosed in double quotes: line 3 column 1 (char 22)", "type": "value_error.jsondecode", "ctx": { "msg": "Expecting property name enclosed in double quotes", "doc": "{\n \"name\": \"string\",\n}", "pos": 22, "lineno": 3, "colno": 1 } } ] } { "detail": [ { "loc": [ "body" ], "msg": "Duplicate keys are not allowed within filters", "type": "value_error.duplicate" } ] }
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. "Error": "Service is temporarily unavailable"

Response codes	Description
201	A successful request.
202	The process is in progress. { "message": "Data request is still being processed" }
400	Indicates incorrectly formatted or oversized files or invalid data: { "detail": "File does not contain any data" } ... { "detail": "Unable to parse the file" } ... { "detail": "File should consist of a single column" } ... { "detail": "File contains invalid IDs" }
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. { "detail": "Insufficient credits" }
404	Request did not find any matching IDs. { "detail": "The request matched 0 IDs" }
409	Duplicate POST requests were submitted. { "detail": "Identical data request is already in progress." }
422	Request exceeded the limit of 10k IDs. { "detail": "The request matched too many IDs. Maximum is 10000 IDs" }
503	Bulk 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 503 response code with the following message: "Error": "File has expired and is no longer available"

Request code	Description
200	A successful request
400	Error codes indicate failures due to incorrectly formatted or oversized files or invalid data. The error message differs based on the error: { "detail": "File does not contain any data" } ... { "detail": "File needs to be a CSV file" } ... { "detail": "File needs to be smaller than 15MB" } ... { "detail": "Unable to read the CSV file" } ... { "detail": "File should consist of a single column" } ... { "detail": "File contains invalid IDs" } ... { "detail": "File contains incorrect IDs" } ... { "detail": "File contains too many IDs" }
401	No valid API Key was provided. Check if your token is valid and try again. { "detail": "Could not identify user" }
422	The webhook URL you provided is invalid. { "detail": "Provided webhook URL is not valid" }
5xx	Unable to create subscription due to a server error. { "detail": "Unable to create subscription" }

Request code	Description
200	A successful request
400	The request was unacceptable, often due to a missing required parameter. The error message differs based on the error: { "Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']" } ... { "Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]" } ... { "Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]" } ... { "Error": "Query validation failed: request does not support [query_string]" } ... { "Error": "Query validation failed: failed to create query: compile error" } ... { "Error": "Failed to parse es dsl query" } ... { "Error": " Query results count exceeds allowed limit" }
401	No valid API Key was provided. Check if your token is valid and try again. { "detail": "Could not identify user" }
422	There are two possible reasons for the 422 error code: The webhook URL you provided is invalid You have used incompatible filters (such as any date filter from search filters or ES DSL schema).

Credits

Rate Limits

Response Codes

Overview

Search and collect response codes

200

400

500

Bulk Collect response codes

﻿201﻿

400

503

Subscriptions response codes

ID endpoint response codes

200

400

5xx

Search Filter and ES DSL endpoint response codes

200

400

201