HTTP Methods or "Verbs"
Listed below are the four types of HTTP methods or verbs used in SideDrawer API calls.
Verb | Function |
---|---|
GET | Retrieve resource(s) |
POST | Create resource |
PUT | Update resource |
DELETE | Delete resource |
Common HTTP Response Codes
Listed here are the various possible response codes returned to indicate the status of an API call.
In general:
- a code in the 200s range indicates a successful call
- a code in the 300s range indicates redirection
- a code in the 400s range indicates an error with the call (lack of access, missing parameters, etc.)
- a code in the 500s range indicates a server error
HTTP Status Code | Response Type | Description |
---|---|---|
200 | OK | Everything worked as expected. |
201 | Created | A new resource was created. |
202 | Accepted | The data extraction process is ongoing in the background. At this point your flow must change to asynchronous using the webhook events. |
204 | No Content | There is no content to send for this request. Note: Filters that result in empty data on extracted periods return an empty array with 200 response code. |
302 | Found | URL of resource has been changed temporarily. |
400 | Bad Request | The request cannot be processed, often due to a missing parameter. |
401 | Unauthorized | No valid API keys or access token provided. |
403 | Forbidden | No access to content. |
404 | Not Found | Requested resource does not exist. |
409 | Conflict | Request conflicts with another request. |
429 | Too Many Requests | Too many requests in a given amount of time. Exponential backoff of requests recommended. |
500 | Internal Server Error | Server has error and cannot process request. |
502 | Bad Gateway | Invalid response received from the server. |
503 | Service Unavailable | Server is not ready to handle the request. Please try again later. |
504 | Gateway Timeout | The request timed out from the server. |