In Simplicate, custom fields allow you to enrich different entities with additional information. These fields can also be made available within the Insights API, enabling you to use your custom data in reports, dashboards, and external analytics tools.
This article explains how custom fields work within Insights, how to configure them, and how they appear in the Insights API.
Overview
For each entity, you can designate up to five custom fields as reporting fields. Once configured, these fields become part of the Insights API data model.
Supported entities:
Person
Organization
Project
Sales
Employee
Custom fields of the type Note field are not supported.
Configuring Reporting Fields
You can define which custom fields should be exposed to the Insights API via:
Settings → Insights → Reporting fields
Each entity provides five available reporting slots.
How to assign a custom field:
Select the entity (e.g., Person).
Choose one of the five reporting slots.
Select an existing custom field (excluding Note-type fields).
Save your configuration.
Once saved, the selected custom field will automatically be included in the Insights data model.
How the Fields Appear in the Insights API
Assigned custom fields are materialized and added as additional attributes to the Cube model of the corresponding entity. This ensures fast and reliable querying without the need for complex joins.
The name of the field is based on the slot number; the value corresponds directly to the selected custom field.
Permissions
Only users with the appropriate Insights settings permissions can configure which custom fields are exposed through the Insights API.
Limitations
Maximum of 5 custom fields per entity
Custom fields of type Note field cannot be assigned
Reporting fields are a global configuration for the entire environment