Integration Clients — Tenant Admin
Overview
Integration clients let your organization connect external applications (BI tools, data pipelines, custom reporting systems) to Survanta through an API key. Each client has a specific set of scopes that determine what the client can read.
This feature is available only if your subscription plan includes integration API access and the Platform Admin has enabled it for your organization.
What Integration Clients Can Access
Each integration client is granted a set of scopes:
| Scope | What It Grants |
|---|---|
| ReportsRead | Read survey metadata and aggregate response summaries |
| UsageRead | Read tenant integration usage summary data |
| RawResponsesRead | Read individual response rows |
Clients cannot create, update, or delete any data — access is read-only.
Creating an Integration Client
- Open Integration Clients from the dashboard navigation.
- Click New Client.
- Enter a name for the client (e.g. "BI Dashboard", "Monthly Report Export").
- Select the scopes to grant to this client.
- Click Create Client.
After creation, the API key is displayed once. Copy and store it securely. You cannot retrieve the key again — if lost, rotate the client to generate a new key.
Rotating an API Key
If a key is lost or compromised:
- Click the client name.
- Click Rotate Key.
- Confirm the rotation.
The old key is immediately invalidated. A new key is generated and displayed once.
Revoking a Client
- Click the client name.
- Click Revoke Client.
- Confirm.
Revoking permanently disables the client. The API key stops working immediately. This action cannot be undone — to restore access, create a new client.
Security Practices
- Treat integration API keys as secrets. Do not share them in emails, chat messages, or version control.
- Grant only the scopes the external application needs (principle of least privilege).
- Rotate keys regularly and whenever a key may have been exposed.
- Revoke clients immediately when they are no longer needed or when an employee who held the key leaves the organization.
Client Limits
The maximum number of integration clients you can create is defined by your subscription plan. To increase this limit, submit a Limit Increase Request from the Billing Requests section.