create_group_item
Create Group Item
Create a new item within a group. Group items represent sub-categories within a group (e.g., specific teams within a department).
create_group_item
Create a new item within a group. Group items represent sub-categories within a group (e.g., specific teams within a department).
list_users
Retrieve all users in your SimpleKPI account. Returns user details including name, email, role, status, and permissions.
get_kpi
Retrieve a single KPI by its ID. Returns the full KPI configuration including name, description, category, frequency, target, and aggregation settings.
delete_kpi_entry
Permanently delete a KPI data entry by its ID.
record_kpi_entries_batch
Record multiple KPI data entries at once. Supports up to 5,000 entries per batch. Use flags to control whether actuals, targets, or notes are updated across all entries in the batch.
remove_kpi_from_user
Remove a KPI assignment from a user. The user will no longer be able to enter data against or analyze this KPI.
update_kpi
Update an existing KPI's configuration. Only provide the fields you want to change; unspecified fields will remain unchanged. Calculated KPIs cannot be modified through the API.
get_kpi_report
Query processed KPI data entries for reporting, including calculated KPIs. Filter by KPI IDs, date range, user IDs, and group item IDs. This is the primary way to extract aggregated performance data. Unlike "List KPI Entries", this endpoint returns calculated KPI values and formatted report data.
delete_kpi_unit
Permanently delete a KPI unit of measure.
list_kpis
Retrieve all KPIs from your SimpleKPI account. Returns the full list of KPIs with their configuration including name, category, frequency, targets, and status.
create_kpi
Create a new KPI in SimpleKPI. Configure the KPI with a name, category, unit, frequency, target, value direction, and aggregation method.
list_kpi_entries
Retrieve KPI data entries with optional filters for user, KPI, date range, and pagination. Returns raw entry data (not calculated KPIs). Use the "Get KPI Report" tool for calculated/aggregated data.
remove_group_item_from_user
Remove a group item assignment from a user.
assign_kpi_to_user
Assign a KPI to a user. This determines which KPIs the user can enter data against and analyze. Optionally set a user-specific target that overrides the KPI's default target.
update_user
Update an existing user's profile. Only provide the fields you want to change. Password cannot be changed via the API.
create_group
Create a new group for organizing users and KPI data (e.g., departments, teams, regions).
update_category
Update an existing KPI category's name or sort order.
delete_group_item
Permanently delete a group item from a group.
delete_category
Permanently delete a KPI category.
create_user
Create a new user account in SimpleKPI. Set the user's role, status, permissions, and login credentials.
record_kpi_entry
Record an actual value, target, and/or notes for a KPI on a given date. Supports setting or incrementing the actual value, and selectively updating actuals, targets, or notes. You can identify the user by ID or email address.
assign_group_item_to_user
Assign a group item to a user. This associates the user with an organizational group for filtering and segmenting KPI data.
list_user_group_items
Retrieve all group items assigned to a specific user. Shows which groups and group items a user belongs to.
delete_group
Permanently delete a group and its items from SimpleKPI.
list_categories
Retrieve all KPI categories. Categories are used to organize KPIs into logical groups.
delete_kpi
Permanently delete a KPI from SimpleKPI. This will remove the KPI and all associated data entries.
create_category
Create a new KPI category for organizing KPIs.
update_group_item
Update an existing group item's name or sort order.
create_kpi_unit
Create a new KPI unit of measure. Units define how KPI values are displayed and entered (e.g., currency, percentage, count).
list_kpi_configuration
Retrieve KPI configuration reference data: available units, frequencies, and icons. Use this to get valid IDs when creating or updating KPIs.
list_user_kpis
Retrieve all KPIs assigned to a specific user, including user-specific targets and sort order.
update_group
Update an existing group's name or sort order.
list_groups
Retrieve all groups. Groups organize users and data into departments, teams, or other organizational units. Optionally include the items within each group.
delete_user
Permanently delete a user account from SimpleKPI.
Track and manage key performance indicators (KPIs) for business performance management. Create, update, and delete KPIs with configurable frequencies, units, icons, and aggregation methods. Record actual and target values over time, organize KPIs into categories, and assign KPIs to users. Manage users, groups, and organizational structures. Query aggregated KPI data for reporting, filtered by date range, users, KPIs, and group items. Supports KPI data entry with options to set or increment values, and configure measurement units and tracking frequencies.
Common questions about connecting Simplekpi to AI agents with Metorial.