Sessions API

The Sessions API provides access to the session data that Zuko stores. This gives you the flexibility to extract, display and analyse your form analytics data in a variety of places outside of the Zuko app.

This is a HTTP API, which returns JSON data representing the session data that we have tracked for your forms.

The API is accessible at https://egress.api.zuko.io/sessions.

Here, we document how to interface with the API.

For simplicity and brevity, examples are given using cURL (a command-line tool use to submit requests to HTTP-based servers). The Session API can be interfaced with any programming language.

Quickstart

curl --header "X-Api-Key: API_KEY" https://egress.api.zuko.io/sessions?form_uuid=FORM_UUID&time[from]=START_TIME&time[to]=END_TIME

The above cURL command will allow you to pull a single page of sessions from the API. It contains a series of placeholders, which you must replace with your own values:

• API_KEY: See the Authentication section.
• FORM_UUID: See the Form UUID section.
• START_TIME and END_TIME: See the Time section.

Table of contents

• Authentication
• Parameters
• Response Schema
• Pagination
• Rate-limiting
• Examples
• FAQ