Introduction
The Simplicate Insights API is a SQL-based interface that allows customers to query and extract their Simplicate data through a Postgres-compatible connection. If a tool can connect to a PostgreSQL database, it can connect to the Insights API.
The API exposes the same data model used by the Insights module within Simplicate, enabling organizations to build custom dashboards, KPIs, and analytics in their own BI environment — using reliable, structured Simplicate data.
Available in Rise en Optimize
In Pilot
This feature is currently in a pilot phase. If you are interested in participating, please contact Simplicate Support.
Before You Start
Before getting started, make sure to review the data model documentation to avoid using fields that will be deprecated soon. This will help ensure your implementation remains stable and future-proof.
Applications
The Insights API can be used with a wide range of data and analytics tools:
Category | Examples |
Business Intelligence tools | Power BI, Tableau, Qlik, Metabase |
ETL / Data loading | Python scripts |
You can connect directly from a BI tool, but for large datasets we recommend extracting data first into your own database or warehouse.
Setup
Obtain credentials
1. Activate the Insights add-on in the add-on center. Via Environmentsettings > Add-ons and integrations. Upon activation, you will receive:
Host
Database name
Username (listed as API token in Simplicate)
Password (listed as API secret in Simplicate)
You need All rights in Simplicate to activate the Insights add-on and obtain the credentials.
2. Add a new PostgreSQL connection
In your tool, select “PostgreSQL” as the data source and enter the details provided. Use 5432 as the port.
Usage Guidelines
1. Data extraction and import first
The API is optimized for exporting or syncing Simplicate data into your own data environment. Once imported, you can build joins and complex models within your own BI or database system.
The data model consists of tables oriented around specific business entities (such as Projects, Time Entries, or Invoices).
In addition, there are combined tables that bring together related data around a shared context — for example, all facts related to a project, including time entries, expenses, and invoices.
Joins are not supported within the Insights API itself.
Combine data only after extraction.
The Insights API is read-only. Data modification and schema changes are not supported.
Typical flow:
Simplicate Insights API → Data Script / ETL → Your Database → BI Tool
2. Result set limits
The maximum result set per query is 50,000 rows.
For large datasets (such as Time Entries), you will need to loop through multiple requests using filters like date ranges or pagination.
Example:SELECT * FROM time_entries WHERE entry_date BETWEEN '2025-10-01' AND '2025-10-07';
Implement a simple script to iterate through time periods until all data has been retrieved.
3. Refresh frequency
The underlying Insights data is updated every hour at the half-hour mark (e.g. 09:30, 10:30, 11:30, ...).
Refreshing your data more frequently than once per hour has no effect — no new data will be available yet.
We recommend scheduling your ETL or BI refresh to run once per hour at most.
4. Query efficiency
Always apply filters (
WHERE,LIMIT) to narrow your result sets.Avoid unfiltered
SELECT *queries on large tables.Aggregations and grouping should be done within your BI tool or database after extraction.
5. Security and access
Your credentials enforce the same permissions as your Simplicate account.
Only authorized data is accessible.
All access is read-only and logged for security auditing.
Pilot phase limits
During the pilot phase, API limits are intentionally more flexible as we explore the system’s boundaries. This applies to aspects such as result size, rate limiting, and other technical restrictions.
During the pilot the published limits are indicative and may be adjusted. Simplicate reserves the right to take corrective or protective measures — including rate limiting, throttling, or temporary suspension of access — No rights can be derived from the current limits.
Fair use
If the API is used in a way that disrupts or inconveniences other users, or causes instability or damage to the software, Simplicate may take measures such as limiting access or temporarily suspending usage. These measures help ensure the overall stability and availability of the Simplicate platform.
Changelog
Date (YYYY-MM-DD) | Change |
2025-11-13 | added tables api_project_service_cost_budgets & api_project_service_hour_budgets |
2025-12-04 | added custom field tables |