HTTP Response Codes

Successful response codes

In addition to the rate limit information in the header, the APIs attempt to generate a response code and also include an appropriate explanation in a JSON body when necessary. For all codes greater than 200, clients should wait before attempting another connection.

Endpoint

HTTP return code on success

PYLON for LinkedIn Engagement Insights
GET /pylon/{service}/task 200 OK
GET /pylon/{service}/task/{id} 200 OK
POST /pylon/{service}/task 202 Accepted
PYLON for Facebook Topic Data
/pylon/analyze 200 OK
/pylon/validate 200 OK
/pylon/sample 200 OK
/pylon/start 200 OK
/pylon/compile 200 OK
/pylon/get 200 OK
/pylon/stop 204 No Content
/pylon/tags 200 OK
/pylon/update 204 No Content
Account API
GET /account/identity 200 OK
POST /account/identity 201 Created
GET /account/identity/{id} 200 OK
PUT /account/identity/{id} 200 OK
GET /account/identity/limit/{service} 200 OK
GET /account/identity/{identity_id}/token 200 OK
POST /account/identity/{identity_id}/limit 201 Created
POST /account/identity/{identity_id}/token 201 Created
GET /account/identity/{identity_id}/limit/{service} 200 OK
PUT /account/identity/{identity_id}/limit/{service} 200 OK or 201 Created
GET /account/identity/{identity_id}/token/{service} 200 OK
PUT /account/identity/{identity_id}/token/{service} 200 OK or 201 Created
DELETE /account/identity/{identity_id}/limit/{service} 204 No Content
DELETE /account/identity/{identity_id}/token/{service} 204 No Content
GET /account/usage 200 OK
Core
/validate 200 OK
/compile 200 OK
/usage 200 OK
/dpu 200 OK
/balance 200 OK
Push Delivery
/push/validate 200 OK
/push/create 200 OK
/push/pause 200 OK
/push/resume 200 OK
/push/update 200 OK
/push/stop 200 OK
/push/delete 204 No content
/push/log 200 OK
/push/get 200 OK
/pull 200 OK
Historics
/historics/prepare 200 OK
/historics/start 204 No content
/historics/stop 204 No content
/historics/update 204 No content
/historics/delete 204 No content
/historics/get 200 OK
Historics Preview
/preview/create 202 Accepted
/preview/get 202 OK
Managed Sources
/source/create 201 Created
/source/stop 200 OK
/source/start 200 OK
/source/update 202 Accepted
/source/delete 204 No content
/source/get 200 OK
/source/log 200 OK

Summary of the codes you might see

Response codes in the 400 range indicate an error with the client. Codes in the 500 range indicate a problem with the server.

2xx Success

200 OK

The API call was successful.

201 Created

You have successfully connected. This code is returned, for example, by the /source/create endpoint in our Managed Sources API and indicates that authentication has succeeded and you are logged in correctly to the data source that you want to filter in DataSift.

202 Accepted

The API call was accepted. The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place

204 Success

The server successfully processed the request, but is not returning any content.

4xx Client Error

400 Bad Request

Bad request from the client.

401 Unauthorized

HTTP authentication failed due to a non-existent username or an incorrect API key.

403 Forbidden

Your account has been denied access due to a violation.

404 Not Found

  • Streaming API: Invalid hash.
  • REST API: endpoint not found.

405 Method Not Allowed

A request method is not supported for the requested resource; for example, a GET request on a form which requires data to be presented via POST, or a PUT request on a read-only resource.

409 Conflict

Indicates that the request could not be processed because of conflict in the request, such as trying to start a PYLON recording or Historics query which is already running.

410 Gone

Indicates that the resource requested is no longer available and will not be available again, for example performing a GET request to retrieve details of an account identity which has been deleted.

413 Payload Too Large

The request is larger than the server is willing or able to process. An example of when you may receive this is when you exceed your per-minute ingestion limit on ODP.

415 Unsupported Media Type

The request entity has a media type which the resource does not support. For example, trying to create a PYLON analysis task using a media type other than application/json.

429 Too Many Requests

You have hit your API rate limit. Not supported by API versions prior to 1.2.

5xx Server Error

500 Server Internal Error

Try again. You shouldn't see this error. Please contact support.

503 Service Unavailable

Try again. The node you were routed to is unavailable.

504 Gateway Timeout

Try again. The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.