API Limitations

Rate / Request Limits

Requests are limited based on consumer IP and Identity user to 250 requests per second. If this limit is exceeded, the API will return HTTP 429 (Request Limit Reached).

Listing Entities

We have a standardized set of restrictions that apply to listing of entities. Listing entities can be for example a subscribers, tickets and so forth. Some API(s) may not have these restrictions and it should be stated in the specification.

Pagination and Max Entities

Pages are limited by maximum entities of 250.
Maximum entities per page is 50.
Maximum entities with pagination is 250.

Infinite Entities

If the API resource view supports it you can set the limit to 0 in the URI query string. (for example ?l=0). It should should be stated in specification explicetly if this is supported on the API resource view.

Search and sorting functionality is not supported with infinite entities. However, filtering is still functional.

Finally, the response is identical to standard pagination except for all entities will be returned within the request with no limit.

Streaming Entities

Streaming requests are different, they are generally supported and stream all the entities to consumer. Each entity will be seperated by a new line and not encapsulated in an Array. This is done by setting limit to -1 in the URI query string. (for example ?l=-1)

Example Response:

{"property1": "value1", "property2": "value2"}\n
{"property1": "value1", "property2": "value2"}\n
{"property1": "value1", "property2": "value2"}\n