tinyDialog API
Read survey responses from your applications and feed readers.
Use the tinyDialog API to read submitted feedback as JSON or RSS.
The base URL is https://app.tinydialog.com/api/v1.
Authentication
Create a CLI API key in your account settings. The API uses the same keys and read permissions as the CLI. Existing keys work with both.
Send the key in the Authorization header:
curl 'https://app.tinydialog.com/api/v1/responses' \
--header "Authorization: Bearer $TINYDIALOG_API_TOKEN"For clients that cannot send this header, such as some feed readers, pass the key as the token query parameter:
https://app.tinydialog.com/api/v1/responses?format=rss&token=YOUR_API_TOKENUse one authentication method per request. Requests with both methods or more than one token parameter return 400.
Keep API keys private. Prefer the header because URLs can be saved in browser history and server logs. Do not put keys in public pages or client-side application code. Use HTTPS. Revoke a key in account settings if it is exposed.
A key can read responses only from organizations that its user currently belongs to. Expired, disabled, revoked, and invalid keys are rejected. An API key does not create a dashboard session.
Rate limits
The responses endpoint allows up to 60 requests per minute per account, shared across its keys, and 60 requests per minute per client IP address. The IP limit also applies to unsuccessful authentication attempts. Clients behind one public IP share that IP limit.
The existing API key limit of 120 requests per minute per key also applies and is shared with CLI requests. A rate limit returns 429 with a Retry-After header in seconds. Wait for that interval before retrying.
API responses use Cache-Control: private, no-store.
Endpoints
- GET /responses: List account, project, or survey responses as JSON or RSS.
Last updated on
