Requests

The Bidtheatre API is fully RESTful. Users can access the resources provided by the API by using standard HTTP methods. Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI.

GET

For retrieval of information about any object, you should use the GET method.

The information you request will be returned to you as a JSON object.

Relationships are displayed as "object links" or "link objects", allowing you to retrieve more information about that relationship. You can read more details about this under the relationships section listed below.

Any request using the GET method is read-only and will not affect any of the objects you are querying.

DELETE

To remove a object, the DELETE method should be used.

This will remove the specified object if it is found.

If it is not found, the operation will return a response indicating that the object was not found.

This means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.

PUT

To update the information about a resource in your network, the PUT method is available.

Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.

POST

To create a new object, your request should specify the POST method.

The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.

PATCH

Only the fields given in the request are updated.

PATCH is generally not implemented but in some cases where new object fields have been added PATCH is supported to facilitate updates of those fields without introducing breaking changes.

❗️

Throttling

To ensure good performance, accounts are limited by default to 1,000 reads per minute and 60 writes per minute. These limits apply at the account level and are shared by all users of that account.

Additional limits apply to concurrent requests: by default, up to 3 statistics requests or 1 performance statistics request can run at a time. Concurrent limits apply separately per request class. For API users, each limit is shared by all API users within the same network. For non-API users, each user account has its own limit within that account. Certain operations also have a limit of one concurrent request, either per user group or per object. Requests that exceed the applicable limits receive an HTTP 429 (Too Many Requests) response.

The default read, write, and concurrent statistics limits can be configured for your account. If you feel these limits need adjusting, please contact your account manager to discuss your requirements. Some operation-specific concurrency limits are fixed to protect data consistency and system performance.