API
The Fly dashboard exposes a REST API that lets you programmatically download survey response data from your own scripts and notebooks. It is the same API the Vlab platform uses when you connect a Fly account to pull responses into a study.
This section covers how to authenticate and how to retrieve responses. All endpoints are served from the dashboard API:
| Environment | Base URL |
|---|---|
| Production | https://fly-dashboard-api.vlab.digital/api/v1 |
| Staging | https://staging.fly-dashboard-api.vlab.digital/api/v1 |
Every request must carry a Fly API key in the Authorization header. See
Authentication to create
one, then use List surveys to find
the survey_name you need, and finally
Get responses to pull the data.
- AuthenticationFly API keys are bearer tokens that identify your dashboard account. Every API request must include one in the Authorization header:
- List surveysThe response endpoints take a survey parameter, which is the surveyname of a survey in your account. If you are not sure what your survey is called,…
- Get responsesUse the /responses endpoints to download survey response data. There are three of them: