Multi-source API

Response Codes

10min

Multi-source API endpoint response codes
Explore the variety of possible response codes and what they mean in the Multi-source API.
A successful query will return the 200 code. 
An unsuccessful query will return any of the following error codes.
Error code
Description
400
Request was unacceptable, often due to a missing required parameter. 

Error message differs based on the error. 
Several examples
{ 
 "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" 
}
{ 
 "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" 
}
﻿
﻿
Error code
Description
401
No valid API bearer token {JWT} 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.
Nonexistent ID:  Using a profile ID that does not exist in our database, you will receive the following response:
Nonexistent API URL
Noneexistant ID
404 page not found
404 page not found
﻿
﻿
Error code
Description
422
Incorrect data structure or data types provided in the request.
422
Duplicate keys
{
  "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",
        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
      }
    }
  ]
}
﻿
﻿
Error code
Description
429
Endpoint rate limit has been exceeded. 
Multi-source API endpoints restrict the number of requests allowed per second for each client's API token.
Multi-source API search endpoint
Multi-source API enrichment endpoints
Multi-source API collection endpoints
Allows 18 requests per second.
Allows 18 requests per second.
Allow 54 requests per second.
﻿
Error code
Description
5xx
One possible example is that the wrong request type was selected (POST/GET). 
Code denotes server issues. 
502
Bad Gateway
Bad Gateway
﻿
﻿
Code
Explanation
503
Service is unavailable due to too many requests received by our API.
503
"Error": "Service is temporarily unavailable"
"Error": "Service is temporarily unavailable"
﻿
﻿

Error code	Description
400	Request was unacceptable, often due to a missing required parameter. Error message differs based on the error.

Error code	Description
401	No valid API bearer token {JWT} 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. Nonexistent ID: Using a profile ID that does not exist in our database, you will receive the following response:

Error code	Description
422	Incorrect data structure or data types provided in the request.

Error code	Description
429	Endpoint rate limit has been exceeded. Multi-source API endpoints restrict the number of requests allowed per second for each client's API token.

Error code	Description
5xx	One possible example is that the wrong request type was selected (POST/GET). Code denotes server issues.

Code	Explanation
503	Service is unavailable due to too many requests received by our API.

Updated 12 Nov 2024

Did this page help you?

Authorization

Elasticsearch DSL