Overview
Oversai's API allows you to securely access your data and integrate it with external systems.
Common use cases include:
Building custom dashboards in your BI solution (Power BI, Tableau, Looker, etc.).
Exporting Oversai data for internal reporting.
Creating custom integrations and workflows.
Automating data synchronization with your internal systems.
Before creating an API key, make sure your user has the appropriate permissions.
Step 1: Enable API Permissions
A user must have permission to manage API Keys before they can create one.
Go to Settings from the left navigation menu.
Open the Role assigned to the user.
Navigate to Features.
Select the Admin category.
Under API Keys, set the permission to All.
Save your changes in the lower right corner.
Once this permission is enabled, the user will be able to generate API keys.
Step 2: Create Your API Key
Go to Settings → API Keys.
Click Create New API Key.
Enter a descriptive name for your key (for example: Power BI Integration or Internal Reporting).
Click Create.
Your API Key will be generated immediately.
Important: Your API Key is displayed only once when it is created. For security reasons, it cannot be viewed again after you close the dialog. Make sure to copy and store it in a secure location, such as a password manager or your organization's secret vault. If the key is lost, it cannot be recovered—you'll simply need to generate a new API Key.
Step 3: Access the API Documentation
To learn how to use the API and explore the available endpoints:
Go to Settings → API Keys.
Click the API Docs button.
The API documentation includes:
Authentication
Available endpoints
Request and response examples
Parameters
Best practices
Need Help?
If you have any questions about the API or need assistance with your integration, contact us at [email protected].
We're always happy to help! 😀