Flow API
Flow API 0.0.4
Tharinda Lasika
Last Update 2 maanden geleden
FLOW API uses REST and returns JSON objects that can be parsed for the requested information unless otherwise noted.
This set of API endpoints will allow you to:
This set of API endpoints will allow you to:
- Get information on all events
- Get information on registrants for specified events
- Get CSV reports on a specified past event
- Create a new barebones event.
Authentication (API Key/Secret)
- Log in to your Dashboard
- Navigate to the Account page
- Click the "Show API Key" button under Account to reveal your account's API key. It may take a brief moment to generate.
Note: As these keys are used to authenticate API requests and grant many privileges, make sure to keep them private. Be careful not to push the key to any public Git repositories or include them in any client code or documentation. Anyone with this API secret key will be able to use the APIs to manage their associated account.
GET Events List
CURL EXAMPLE
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/events/sessions?period=current&simple_analytics=1
GET Events Info
CURL EXAMPLE
GET Events Info
CURL EXAMPLE
POST Registration
CURL EXAMPLE
curl https://prod.flowapp.com/api/v1/registrants -i -X POST -H "Content-Type:application/json" -d '{"email":"jessepinkman@breakingbad.com", "firstName":"Jesse", "lastName":"Pinkman","eventSessionToken":"rGt3dC546xs"}'
GET Registrant List
CURL EXAMPLE
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/reports/events/sessions/registrants/T35tT0K3n
POST Event Creation
GET Operator List
GET Event Session Surveys
CURL EXAMPLE
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/reports/events/sessions/surveys/T35tT0K3n
RESPONSE PARAMETERS
An array of data with survey information, most notably the ID used to fetch survey response reports.
An array of data with survey information, most notably the ID used to fetch survey response reports.
GET CSV Reports
Complied Report
Registrants
Attendee Chat Log
Operator Chat Log
Survey Responses
CURL EXAMPLE
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/reports/events/sessions/csv/summary/T35tT0K3n
Others
CSV Data will be returned with the requested information.
SSO
The SSO API allows for registration and redirection to the login link in one request. For example, it can be incorporated into a page in a login-protected area on your company site. See the registration API notes for the correct parameter to send.
Request Access by contacting technical support at the bottom right of this page.