# Simplekpi

Beautifully simple KPI software. Create, manage and analyse your Key Performance Indicators from the cloud.

- **Category:** analytics
- **Auth:** BASIC
- **Composio Managed App Available?** N/A
- **Tools:** 51
- **Triggers:** 0
- **Slug:** `SIMPLEKPI`
- **Version:** 00000000_00

## Tools

### Add User Group Item

**Slug:** `SIMPLEKPI_ADD_USER_GROUP_ITEM`

Tool to assign a group item to a user in SimpleKPI. Use when you need to add a group item to a specific user's profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The group item identifier to assign to the user. |
| `user_id` | integer | Yes | The identifier of the user to assign the group item to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add User KPI

**Slug:** `SIMPLEKPI_ADD_USER_KPI`

Tool to assign a KPI to a user in SimpleKPI. Use when you need to link a KPI to a specific user with optional custom target and display order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | KPI ID to assign to the user |
| `user_id` | integer | Yes | User ID to assign the KPI to |
| `sort_order` | integer | Yes | Display order of the KPI on the KPI Entry screen for this user |
| `user_target` | number | No | User-specific target value for this KPI (optional). Overrides the default KPI target for this user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Category KPI

**Slug:** `SIMPLEKPI_CREATE_CATEGORY_KPI`

Tool to create a new KPI within a category in SimpleKPI. Use when you need to add a new performance indicator to track metrics like sales, revenue, or customer satisfaction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the KPI (maximum 100 characters) |
| `icon_id` | integer | Yes | The ID of the icon to use for this KPI |
| `unit_id` | integer | Yes | The ID of the unit of measurement for this KPI |
| `is_active` | boolean | Yes | Whether the KPI is active and visible |
| `sort_order` | integer | Yes | Display order position for this KPI within the category |
| `category_id` | integer | Yes | The ID of the category where the KPI will be created |
| `frequency_id` | string | Yes | Frequency ID as a single uppercase letter: D (daily), W (weekly), M (monthly), Q (quarterly), Y (yearly) |
| `value_direction` | string ("U" | "D" | "N") | Yes | Indicates whether higher (U) or lower (D) values are better, or if direction doesn't matter (N) |
| `aggregate_function` | string ("AVG" | "SUM") | Yes | Function to use when aggregating KPI values: AVG (average) or SUM (sum) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group

**Slug:** `SIMPLEKPI_CREATE_GROUP`

Tool to create a new group in SimpleKPI. Use when you need to organize KPIs or users into logical groups for better organization and reporting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Group name. Must not exceed 50 characters. |
| `sort_order` | integer | Yes | Display order for the group. Lower values appear first in lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group Item

**Slug:** `SIMPLEKPI_CREATE_GROUP_ITEM`

Tool to create a new item within a group in SimpleKPI. Use when you need to add a new item to an existing group for organizing KPIs or data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the group item (maximum 100 characters) |
| `group_id` | integer | Yes | The ID of the group to create the item in |
| `sort_order` | integer | Yes | The display order of the item within the group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create KPI

**Slug:** `SIMPLEKPI_CREATE_KPI`

Tool to create a new KPI with specified configuration. Use when you need to add a new Key Performance Indicator to track metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the KPI. |
| `icon_id` | integer | Yes | Icon ID for the KPI display. |
| `unit_id` | integer | Yes | Unit ID that defines the measurement unit for this KPI. |
| `is_active` | boolean | Yes | Active status indicating whether the KPI is currently active. |
| `sort_order` | integer | Yes | Display order for sorting KPIs in the interface. |
| `category_id` | integer | Yes | KPI Category ID. Use GET /api/kpicategories to fetch available categories. |
| `frequency_id` | string | Yes | Frequency ID that determines data entry frequency (e.g., 'M' for monthly, 'W' for weekly, 'D' for daily). |
| `value_direction` | string ("U" | "D" | "N") | Yes | Direction indicator: 'U' (up is good), 'D' (down is good), or 'N' (neutral). |
| `aggregate_function` | string ("AVG" | "SUM") | Yes | Calculation method for aggregating KPI values: 'AVG' (average) or 'SUM' (sum). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create KPI Category

**Slug:** `SIMPLEKPI_CREATE_KPI_CATEGORY`

Tool to create a new KPI category in SimpleKPI. Use when you need to organize KPIs into logical groups or categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Category name (maximum 50 characters) |
| `sort_order` | integer | Yes | Display order for the category (integer value) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create KPI Unit

**Slug:** `SIMPLEKPI_CREATE_KPI_UNIT`

Tool to create a new KPI unit in SimpleKPI. Use when you need to define a measurement unit for KPI tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unit name (maximum 25 characters) |
| `entry_format` | string | Yes | Entry format for the unit (maximum 25 characters). Use '###' as placeholder for numeric values |
| `is_percentage` | boolean | Yes | Whether the unit represents a percentage value |
| `display_format` | string | Yes | Display format for the unit (maximum 25 characters). Use '###' as placeholder for numeric values |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch KPI Entries

**Slug:** `SIMPLEKPI_CREATE_OR_UPDATE_KPI_ENTRIES`

Tool to batch create or update multiple KPI entries at once. Use when you need to load multiple KPI data points efficiently (up to 5000 entries per batch). Each entry must have a kpi_id, entry_date, and either email or user_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entries` | array | Yes | Array of KPI entry objects to create or update. Maximum 5000 entries per batch |
| `hasNotes` | boolean | No | Indicates whether the batch contains notes. Helps optimize processing |
| `hasActuals` | boolean | No | Indicates whether the batch contains actual values. Helps optimize processing |
| `hasTargets` | boolean | No | Indicates whether the batch contains target values. Helps optimize processing |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User

**Slug:** `SIMPLEKPI_CREATE_USER`

Tool to create a new user account in SimpleKPI. Use when you need to add a new user with specific permissions and access levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Valid email address for login |
| `password` | string | Yes | Password for new user. Must be at least 8 characters long |
| `last_name` | string | No | Last name of user (optional) |
| `user_type` | string ("Admin" | "Director" | "Manager" | "User") | Yes | User type: Admin, Director, Manager, or User |
| `first_name` | string | Yes | First name of user |
| `user_status_id` | string ("A" | "L") | Yes | User status: A for Active or L for Locked |
| `can_manage_users` | boolean | Yes | Whether user can manage other users. Relevant for Manager type |
| `can_admin_settings` | boolean | Yes | Whether user can access admin settings. Relevant for Admin type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Category KPI

**Slug:** `SIMPLEKPI_DELETE_CATEGORY_KPI`

Tool to delete a KPI from a category. Use when you need to remove a specific KPI from a category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the KPI to delete from the category |
| `category_id` | integer | Yes | The ID of the category containing the KPI |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `SIMPLEKPI_DELETE_GROUP`

Tool to delete a group by ID. Use when you need to permanently remove a group from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Group ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group Item

**Slug:** `SIMPLEKPI_DELETE_GROUP_ITEM`

Tool to delete a group item by ID. Use when you need to remove an item from a specific group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the group item to delete |
| `group_id` | integer | Yes | The ID of the group containing the item to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete KPI

**Slug:** `SIMPLEKPI_DELETE_KPI`

Tool to delete a KPI by ID. Use when you need to permanently remove a specific KPI from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the KPI to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete KPI Category

**Slug:** `SIMPLEKPI_DELETE_KPI_CATEGORY`

Tool to delete a KPI category by its ID. Use when you need to remove a KPI category from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the KPI category to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete KPI Entry

**Slug:** `SIMPLEKPI_DELETE_KPI_ENTRY`

Tool to delete a KPI entry by ID. Use when you need to permanently remove a specific KPI entry from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kpientryid` | integer | Yes | The unique identifier of the KPI entry to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete KPI Unit

**Slug:** `SIMPLEKPI_DELETE_KPI_UNIT`

Tool to delete a KPI unit by its ID. Use when you need to remove a KPI unit from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the KPI unit to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User

**Slug:** `SIMPLEKPI_DELETE_USER`

Tool to delete a user account by ID. Use when you need to permanently remove a user from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | User ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User Group Item

**Slug:** `SIMPLEKPI_DELETE_USER_GROUP_ITEM`

Tool to remove a group item assignment from a user. Use when you need to unassign a specific group item from a user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Group item ID to remove from the user. |
| `user_id` | integer | Yes | User ID to remove the group item assignment from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User KPI

**Slug:** `SIMPLEKPI_DELETE_USER_KPI`

Tool to remove a KPI assignment from a user. Use when you need to unassign or delete a specific KPI from a user's profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the KPI assignment to remove from the user |
| `user_id` | integer | Yes | The ID of the user from whom to remove the KPI assignment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Data Entries

**Slug:** `SIMPLEKPI_GET_ALL_DATA_ENTRIES`

Tool to retrieve processed KPI data entries for reports including calculated KPIs. Use when you need comprehensive report data with KPI metrics, targets, and metadata. Returns up to 10,000 entries with details like kpiId, kpiName, itemName, period, actual, target, and notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dateTo` | string | No | End date for filtering entries in YYYY-MM-DD format. Defaults to today if not provided |
| `kpiIds` | string | No | Comma-separated list of KPI IDs to filter entries (e.g., '1,2,3'). If not provided, returns entries for all KPIs |
| `userIds` | string | No | Comma-separated list of user IDs to filter entries (e.g., '5,15,25'). Filters by specific users |
| `dateFrom` | string | No | Start date for filtering entries in YYYY-MM-DD format. Defaults to today if not provided |
| `groupItemIds` | string | No | Comma-separated list of group item IDs to filter entries (e.g., '10,20,30'). Filters by specific group items |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category KPI

**Slug:** `SIMPLEKPI_GET_CATEGORY_KPI`

Tool to retrieve a specific KPI within a category. Use when you need detailed information about a particular KPI including its name, description, target values, and configuration settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the KPI to retrieve. |
| `category_id` | integer | Yes | The ID of the category containing the KPI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group

**Slug:** `SIMPLEKPI_GET_GROUP`

Tool to get a specific group by ID from SimplekPI. Use when you need to retrieve detailed information about a particular group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the group to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Item

**Slug:** `SIMPLEKPI_GET_GROUP_ITEM`

Tool to retrieve a specific group item by ID. Use when you need to fetch details of a particular item within a group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the item to retrieve. |
| `group_id` | integer | Yes | The identifier of the group containing the item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get KPI by ID

**Slug:** `SIMPLEKPI_GET_KPI`

Tool to retrieve a specific KPI by ID from SimpleKPI. Use when you need detailed information about a particular KPI including its configuration, targets, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kpi_id` | integer | Yes | The unique identifier of the KPI to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get KPI Category

**Slug:** `SIMPLEKPI_GET_KPI_CATEGORY`

Tool to get a specific KPI category by ID from SimpleKPI. Use when you need to retrieve detailed information about a particular KPI category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the KPI category to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get KPI Entry

**Slug:** `SIMPLEKPI_GET_KPI_ENTRY`

Tool to retrieve a specific KPI entry by ID. Use when you need to fetch detailed information about a particular KPI entry including actual values, targets, notes, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kpientryid` | integer | Yes | The unique identifier of the KPI entry to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get KPI Frequency

**Slug:** `SIMPLEKPI_GET_KPI_FREQUENCY`

Tool to get a specific KPI frequency by ID from SimplekPI. Use when you need to retrieve information about a particular frequency setting for KPIs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The frequency ID (e.g., 'D' for Daily, 'W' for Weekly, 'M' for Monthly) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get KPI Icon by ID

**Slug:** `SIMPLEKPI_GET_KPI_ICON`

Tool to retrieve a specific KPI icon by ID. Use when you need to get icon details including the icon name which can be used to construct the icon URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the KPI icon to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get KPI Unit

**Slug:** `SIMPLEKPI_GET_KPI_UNIT`

Tool to get a specific KPI unit by ID from SimpleKPI. Use when you need to retrieve detailed information about a particular KPI unit including its format specifications and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the KPI unit to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User by ID

**Slug:** `SIMPLEKPI_GET_USER`

Tool to retrieve a specific user by ID. Use when you need to get details about a particular user account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique user ID to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Group Item

**Slug:** `SIMPLEKPI_GET_USER_GROUP_ITEM`

Tool to get a specific group item assigned to a user. Use when you need to retrieve details of a particular group item for a user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The identifier of the group item to retrieve |
| `user_id` | integer | Yes | The identifier of the user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User KPI

**Slug:** `SIMPLEKPI_GET_USER_KPI`

Tool to retrieve a specific KPI assigned to a user. Use when you need details about a particular KPI assignment for a user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the KPI assigned to the user. |
| `user_id` | integer | Yes | The ID of the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Category KPIs

**Slug:** `SIMPLEKPI_LIST_CATEGORY_KPIS`

Tool to retrieve all KPIs within a specific category. Use when you need to list or inspect KPIs belonging to a particular category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | The ID of the category to retrieve KPIs from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Items

**Slug:** `SIMPLEKPI_LIST_GROUP_ITEMS`

Tool to get all items within a group. Use when you need to retrieve the complete list of items belonging to a specific group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | The identifier of the group containing the items |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups

**Slug:** `SIMPLEKPI_LIST_GROUPS`

Tool to retrieve all groups from SimpleKPI. Use when you need to list groups for organizing users and company hierarchy.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List KPI Categories

**Slug:** `SIMPLEKPI_LIST_KPI_CATEGORIES`

Tool to get all KPI categories. Use when you need to retrieve the complete list of KPI categories for organizing KPIs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List KPI Entries

**Slug:** `SIMPLEKPI_LIST_KPI_ENTRIES`

Tool to get all KPI entries filtered by date range and optional criteria. Use when you need to retrieve KPI data for analysis or reporting. Returns a maximum of 500 entries per page. Use pagination parameters (rows, page) to retrieve additional entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 1) |
| `rows` | integer | No | Maximum number of entries to return per page (max 500) |
| `kpiid` | integer | No | Filter by specific KPI ID to get entries only for that KPI |
| `dateTo` | string | Yes | End date for filtering KPI entries in YYYY-MM-DD format |
| `userid` | integer | No | Filter by specific user ID to get entries only for that user |
| `dateFrom` | string | Yes | Start date for filtering KPI entries in YYYY-MM-DD format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List KPI Frequencies

**Slug:** `SIMPLEKPI_LIST_KPI_FREQUENCIES`

Tool to get all KPI frequencies. Use when you need to retrieve available data entry frequency options (Daily, Weekly, Monthly, etc.) for KPI configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List KPI Icons

**Slug:** `SIMPLEKPI_LIST_KPI_ICONS`

Tool to retrieve all KPI icons from SimpleKPI. Use when you need to get available icons for display purposes or to help identify KPIs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All KPIs

**Slug:** `SIMPLEKPI_LIST_KPIS`

Tool to retrieve all KPIs from a SimpleKPI account. Use when you need to list all available KPIs with their configurations, targets, and metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All KPI Units

**Slug:** `SIMPLEKPI_LIST_KPI_UNITS`

Tool to retrieve all KPI units from a SimpleKPI account. Use when you need to list available units that describe how KPI values are displayed (currency, percentage, etc.).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Group Items

**Slug:** `SIMPLEKPI_LIST_USER_GROUP_ITEMS`

Tool to get all group items assigned to a user. Use when you need to retrieve group assignments for a specific user in SimpleKPI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | The ID of the user to retrieve group items for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User KPIs

**Slug:** `SIMPLEKPI_LIST_USER_KPIS`

Tool to get all KPIs assigned to a specific user. Use when you need to retrieve what KPIs a user can enter data against and analyze.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | User ID to retrieve KPIs for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Category KPI

**Slug:** `SIMPLEKPI_UPDATE_CATEGORY_KPI`

Tool to update a KPI within a category. Use when you need to modify KPI details such as name, target, frequency, or aggregation method.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | KPI ID to update |
| `name` | string | Yes | KPI name (max 100 characters) |
| `icon_id` | integer | Yes | Icon identifier for the KPI |
| `unit_id` | integer | Yes | Unit of measure identifier |
| `is_active` | boolean | Yes | Determines if data entry is permitted for this KPI |
| `sort_order` | integer | Yes | Display ordering position |
| `category_id` | integer | Yes | Category ID containing the KPI |
| `description` | string | No | KPI description (max 150 characters) |
| `frequency_id` | string ("W" | "D" | "M" | "Q" | "Y") | Yes | Data entry frequency: W (Weekly), D (Daily), M (Monthly), Q (Quarterly), or Y (Yearly) |
| `target_default` | number | No | Default target value for the KPI |
| `value_direction` | string ("U" | "D" | "N") | Yes | Direction indicator: U (Up), D (Down), or N (None) |
| `aggregate_function` | string ("AVG" | "SUM") | Yes | Calculation method: AVG (Average) or SUM (Sum) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group

**Slug:** `SIMPLEKPI_UPDATE_GROUP`

Tool to update an existing group in SimpleKPI. Use when you need to modify a group's name or display order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique ID of the group to update. |
| `name` | string | Yes | The new name for the group (max 50 characters). |
| `sort_order` | integer | Yes | The display order for the group. Lower values appear first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group Item

**Slug:** `SIMPLEKPI_UPDATE_GROUP_ITEM`

Tool to update an existing item in a SimpleKPI group. Use when you need to modify the name or sort order of a group item. Requires both group_id and item id to identify the item to update. Both name and sort_order must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the item to update. |
| `name` | string | Yes | The new name for the item. Maximum length is 50 characters. |
| `group_id` | integer | Yes | The unique identifier of the group containing the item. |
| `sort_order` | integer | Yes | The display order of the item. Must be a 16-bit integer (range: -32768 to 32767). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update KPI

**Slug:** `SIMPLEKPI_UPDATE_KPI`

Tool to update an existing KPI in SimpleKPI. Use when you need to modify KPI properties such as name, description, target values, or settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | KPI ID to update |
| `name` | string | Yes | KPI name (maximum 100 characters) |
| `icon_id` | integer | Yes | Icon identifier for the KPI |
| `unit_id` | integer | Yes | Unit of measure identifier |
| `is_active` | boolean | Yes | Activation status for data entry. Set to true to enable data entry, false to disable. |
| `sort_order` | integer | Yes | Display order ranking for the KPI |
| `category_id` | integer | Yes | KPI Category ID that this KPI belongs to |
| `description` | string | No | KPI description (maximum 150 characters) |
| `frequency_id` | string ("D" | "W" | "M" | "Q" | "Y") | Yes | Data entry frequency (D=Daily, W=Weekly, M=Monthly, Q=Quarterly, Y=Yearly). Case-sensitive, must be uppercase. |
| `target_default` | number | No | Default target value for the KPI |
| `value_direction` | string ("U" | "D" | "N") | Yes | Direction indicator: U(p) means higher is better, D(own) means lower is better, N(one) means no direction |
| `aggregate_function` | string ("AVG" | "SUM") | Yes | How the KPI is calculated: AVG (Average) or SUM (Total Sum) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update KPI Entry

**Slug:** `SIMPLEKPI_UPDATE_KPI_ENTRY`

Tool to update an existing KPI entry in SimpleKPI. Use when modifying entry values, targets, or notes for a specific KPI entry. At least one of actual, target, or notes must be provided (actual cannot be null if both target and notes are null).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | The note associated with the KPI entry (max 500 characters) |
| `actual` | number | No | The actual value. Cannot be null if the target and notes are both null |
| `kpi_id` | integer | Yes | The KPI must be active and cannot be a calculated KPI. The KPI must also be assigned to the user |
| `target` | number | No | The target value of the entry. This value will be ignored if the KPI has a null target |
| `user_id` | integer | Yes | An ID of an active user to assign to the KPI entry |
| `entry_date` | string | Yes | The date of the entry. Date time format without timezone, e.g. '2019-01-01T00:00:00' |
| `kpientryid` | integer | Yes | The ID of the KPI entry to update (required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update KPI Unit

**Slug:** `SIMPLEKPI_UPDATE_KPI_UNIT`

Tool to update an existing KPI unit in SimpleKPI. Use when you need to modify unit properties such as name, entry format, display format, or percentage status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unit ID to update |
| `name` | string | Yes | The name of the KPI unit (maximum 25 characters) |
| `entry_format` | string | Yes | The entry format is only for entry and will not have the prefix or suffix (e.g., #.00). Maximum 25 characters. |
| `is_percentage` | boolean | Yes | To determine if the value is a percentage as these values are treated differently |
| `display_format` | string | Yes | The display format must be a valid number format (e.g., £ #.00). Maximum 25 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `SIMPLEKPI_UPDATE_USER`

Tool to update an existing user account in SimpleKPI. Use when you need to modify user details such as type, status, name, or permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | User ID to update |
| `email` | string | Yes | Email address of the user |
| `last_name` | string | No | Last name of the user |
| `user_type` | string | Yes | User type (e.g., 'Standard', 'Manager', 'Director') |
| `first_name` | string | Yes | First name of the user |
| `user_status_id` | string | Yes | User status ID. Use 'A' for Active, 'I' for Inactive |
| `can_manage_users` | boolean | No | Whether the user can manage other users. Set to true to grant user management permissions |
| `can_admin_settings` | boolean | No | Whether the user can access admin settings. Set to true to grant admin access |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |