Frequently asked questions
How long does it take to build a report?
A single page report typically takes up to 2 seconds to generate. Multi-page reports, and reports with a lot of data visualisation components will take accordingly longer.
How long is the report stored on the server for?
Reports are stored on the server for up to ~2 days, after which they are removed.
Do you store the JSON schema used to generate the report?
The JSON schema sent to the Hybiscus API is never stored. It is used to make the report, and discarded straight away after.
I set the config option in the schema but it's not having an effect?
The most common issue with setting a config option key (e.g. setting the
columns key to maybe
3) is that there was a typo in the key name. The
Hybiscus API will accept wrong keys and simply ignore them. If the correct key
is present, only then, will it use it. If you still think there is an issue
with the Hybiscus API, please contact support
Is there a way to build the PDF report without storing it on the Hybiscus server?
You can choose to have your report uploaded directly to your cloud storage provider of choice. In this case, the report will never be saved locally. For more details, see here.
My job status is stuck on
If your job status is stuck on
RUNNING, there is likely to be an issue with
your report schema which is delaying its completion. This can occur with
reports that include chart components with a lot of data, or with Image
components that link to a very large image. If your report takes more than
30 seconds to complete, it will automatically fail.
My job status is stuck on
During periods of high traffic on the Hybiscus API, or if you submit too many requests very quickly (please also see our rate limitting docs), your job will remain in a queue until it is ready to be processed. Please allow some time for your job to reach a worker to be processed.
If your job does not progress past the
QUEUED state for more than 5 minutes, this could be an issue
with our API. Please contact email@example.com
with your job ID and details about your job to allow us to investiage. Please
allow up to 24 hours before we can reply.
Are there any rate limits in place on the API?
Please refer to rate limitting page for more information on the rate limits in place.
If you have any other questions, please don't hesitate to contact us at firstname.lastname@example.org
Hybiscus is continuously improving and adding new features. If you think we are missing a critical feature, please do not hesitate to contact us and offer your feedback at email@example.com