Simplekpi

These are the Simplekpi actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• 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.

• Batch 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.

• 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.

• 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.

• Create KPI Category

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

• 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.

• 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.

• Get KPI by ID

  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.

• 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.

• Get User by ID

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

• List All 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.

• 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.

• List Groups

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

• List KPI Categories

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

• 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.

• 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.

• 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.

• 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.

• 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.

• Create KPI Unit

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

• Delete Category KPI

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

• Delete Group

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

• Delete Group Item

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

• Delete KPI

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

• Delete KPI Category

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

• 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.

• Delete KPI Unit

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

• Delete User

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

• 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.

• 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.

• 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.

• Get Group

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

• 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.

• 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.

• 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.

• Get KPI Icon by ID

  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.

• 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.

• 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.

• 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.

• List All 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.).

• 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.

• 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.

• 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.

• 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.

• 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.

• Update Group

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

• 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.

• 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.

• 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).

• 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.

• 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.