Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Parameters

The following parameters are required and must be included with every request.

Note: All parameters should be provided as search parameters in the URL.

Form UUID

You will need to provide a UUID to the API for one of your forms in Zuko. A form’s UUID can be found on the settings page for a form. Click the settings icon on any Zuko report to be taken there.

Example:

form_uuid=3a5b3247-18d2-4170-a71b-90d9248ce31a

Note: This is different to the API key.

Time

You will need to provide the time range which you would like to query the API for. This time range is defined using two parameters in the time hash.

  • time[from]: Specifies the start of the time range
  • time[to]: Specifies the end of the time range

Both of these parameters are required and they are expected to be in the ISO 8601 standard.

Example:

time[from]=2023-01-01T00:00:00Z
time[end]=2023-01-31T23:59:59Z

Table of contents