Error Codes

The following are the different kinds of error messages you could receive when using the Nexosis API.

400 - Looks like you need some help

These are generally validation errors on the request being performed. If you are receiving a 400 error, the specific type of error can be found in the errorType property, and the properties or values which are failing validation will be specified in the errorDetails property of the response. In particular, the following are different types of validation errors you could see.

InvalidColumnMetadata

When uploading data, the accompanying column metadata is validated to ensure that we correctly understand how all of the columns in the uploaded dataset should be used. If the specified metadata is not compatible with the specified data, then an error will be reported. The column names and reasons that validation failed will be specified.

{
  "statusCode": 400,
  "message": "One or more columns were supplied with invalid metadata",
  "errorType": "InvalidColumnMetadata",
  "errorDetails": {
    "sales": [
      "Target columns must have data type Numeric"
    ],
  }
}

InvalidDateRange

Any requests that use two date parameters for the startDate and endDate of a range must both have valid dates, and the startDate must be before the endDate. These include any of the endpoints which filter returned results in a GET request, or POSTs which use the dates as parameters to start sessions. Ensure that the dates are sent in ISO-8601 format (e.g. YYYY-MM-DD), and that the startDate is before the endDate.

For more information on ISO-8601 Date/Time formats, see Working With Dates.

{
  "statusCode": 400,
  "message": "Start Date must be before End Date",
  "errorType": "InvalidDateRange",
  "errorDetails": {
    "startDate": "2018-01-01T00:00:00+00:00",
    "endDate": "2017-01-05T00:00:00+00:00"
  }
}

NoData

When issuing a PUT to the /data/{dataSetName} endpoint, ensure that the intended dataset is being included in the request. If no data was received, than this error will be returned.

This error could also be returned when issuing a POST to the /sessions/forecast or /sessions/impact endpoints that includes neither a dataset name nor a session-scoped dataset.

{
  "statusCode": 400,
  "message": "No data was sent",
  "errorType": "NoData",
  "errorDetails": {
    "dataSetName": "Location-A"
  }
}

RequestValidation

This is a general error indicating that we were unable to parse the request that was sent. Ensure that the request body conforms to the schema provided for that request in the API documentation. Also, double check that the correct Content-Type header is being set correctly.

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "data": [
      "The data field is required."
    ]
  }
}

SomeParametersRequired

Some requests have all of their parameters marked as optional, but, at least one parameter of the set must be specified. This indicates that there were no parameter values received when at least one of them is required to perform the operation.

{
  "statusCode": 400,
  "message": "Some session selection parameters are required.",
  "errorType": "SomeParametersRequired",
  "errorDetails": {}
}

401 - Access Denied

This status code indicates that the api-key header, which much be present on all requests, was not valid. Either the header was not included at all, or the provided key was not valid. Refer to the API key documentation for further information.

{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}

403 - Plan Upgrade Required

This will be returned if you attempt to access paid developer endpoints using a Community subscription key. If you have purchased a plan, please double check that you are using the new API Key associated with the paid plan (named ‘Paid Subscription’ in your profile) as the key changes upon purchase.

404 - Not Found

Returned whenever the specified resource was not found. This error can also be returned if the endpoint that the request was issued to does not exist. If a specific resource was requested, the itemId and itemType will be included in the response. Ensure that this Id is the one you intended. Also, check the listing endpoints, such as /data or /sessions if you are unsure of the id.

{
  "statusCode": 404,
  "message": "Item of type dataSet with identifier Location-A was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "dataSet",
    "itemId": "Location-A"
  }
}

429 - Quota Exceeded

In this case it looks like you’ve exceeded our limits on the API. You can read about our usage policies on our support site here: https://support.nexosis.com

500 - We Screwed Up

Well, a 500-level error means that something went wrong in the internals of the Nexosis API. You can help us diagnose and fix the problem by sending the details of the request that you were trying when you encountered the problem. Please send details to us via our Support system (on the bottom-right of this page). Please include as many of the following details that you have available:

• Session ID
• Dataset Name
• Request URL (including query string parameters)
• Request Body

{
  "statusCode": 500,
  "message": "An unexpected error occurred",
  "errorType": "ServerError",
  "errorDetails": {}
}