Limitations
This article explains the limitations on the TextReveal API.
Max supported entities (companies/concepts) in a single request
The recommended maximum number of entities requested in a single request is 5 000
. This limit applies to both /analyze/dataset
and /analyze/tql
routes.
If you have more entities to request at the same time you need to cut and create two or more requests.
Time range limitations
The recommended maximum time range for an instance is one year
to avoid overly heavy results. However, it is possible to parallelize analyses over multiple years (see limitations on simultaneous instances below). This approach allows faster data retrieval since the time range is queried month by month sequentially.
A longer time range results in slower data retrieval because it relies on a single cluster processing data sequentially. In contrast, shorter time ranges can be parallelized across multiple clusters, enabling faster retrieval as payloads are processed simultaneously.
Automatic deletion of documents / Max TTL for analyzes
Our documents are automatically deleted after 2 weeks
(1209600 seconds).
This deletion cannot be canceled.
Max simultaneous running instances
The maximum number of simultaneous running instances per company is set to 10. If this limit is reached, the instances will be queued and the status of the related instances will be set to pending.
Max simultaneous pending instances
The maximum number of simultaneous pending instances per company is set to 60. If this limit is reached, the TextReveal® API will throw an error with the 429 status code (TOO MANY REQUESTS).
Data access limitations
The access to premium document's texts is forbidden. However, all other fields remain accessible.
Depending on the route, the text field will either be replaced by the message "The download of licensed text is not allowed" or an error
field indicating the reason.