Simplekpi
simplekpiBeautifully simple KPI software. Create, manage and analyse your Key Performance Indicators from the cloud.
Acciones disponibles (51)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add User Group ItemSIMPLEKPI_ADD_USER_GROUP_ITEMAcciónTool 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.
SIMPLEKPI_ADD_USER_GROUP_ITEMAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe group item identifier to assign to the user.
user_idintegerObligatorioThe identifier of the user to assign the group item to.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add User KPISIMPLEKPI_ADD_USER_KPIAcciónTool 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.
SIMPLEKPI_ADD_USER_KPIAcciónTool 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.
Parámetros de entrada
idintegerObligatorioKPI ID to assign to the user
user_idintegerObligatorioUser ID to assign the KPI to
sort_orderintegerObligatorioDisplay order of the KPI on the KPI Entry screen for this user
user_targetnumberUser-specific target value for this KPI (optional). Overrides the default KPI target for this user
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Category KPISIMPLEKPI_CREATE_CATEGORY_KPIAcciónTool 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.
SIMPLEKPI_CREATE_CATEGORY_KPIAcciónTool 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.
Parámetros de entrada
namestringObligatorioName of the KPI (maximum 100 characters)
icon_idintegerObligatorioThe ID of the icon to use for this KPI
unit_idintegerObligatorioThe ID of the unit of measurement for this KPI
is_activebooleanObligatorioWhether the KPI is active and visible
sort_orderintegerObligatorioDisplay order position for this KPI within the category
category_idintegerObligatorioThe ID of the category where the KPI will be created
frequency_idstringObligatorioFrequency ID as a single uppercase letter: D (daily), W (weekly), M (monthly), Q (quarterly), Y (yearly)
value_directionstringObligatorioenumIndicates whether higher (U) or lower (D) values are better, or if direction doesn't matter (N)
UDNaggregate_functionstringObligatorioenumFunction to use when aggregating KPI values: AVG (average) or SUM (sum)
AVGSUM
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create GroupSIMPLEKPI_CREATE_GROUPAcciónTool to create a new group in SimpleKPI. Use when you need to organize KPIs or users into logical groups for better organization and reporting.
SIMPLEKPI_CREATE_GROUPAcciónTool to create a new group in SimpleKPI. Use when you need to organize KPIs or users into logical groups for better organization and reporting.
Parámetros de entrada
namestringObligatorioGroup name. Must not exceed 50 characters.
sort_orderintegerObligatorioDisplay order for the group. Lower values appear first in lists.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Group ItemSIMPLEKPI_CREATE_GROUP_ITEMAcciónTool 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.
SIMPLEKPI_CREATE_GROUP_ITEMAcciónTool 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.
Parámetros de entrada
namestringObligatorioThe name of the group item (maximum 100 characters)
group_idintegerObligatorioThe ID of the group to create the item in
sort_orderintegerObligatorioThe display order of the item within the group
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create KPISIMPLEKPI_CREATE_KPIAcciónTool to create a new KPI with specified configuration. Use when you need to add a new Key Performance Indicator to track metrics.
SIMPLEKPI_CREATE_KPIAcciónTool to create a new KPI with specified configuration. Use when you need to add a new Key Performance Indicator to track metrics.
Parámetros de entrada
namestringObligatorioName of the KPI.
icon_idintegerObligatorioIcon ID for the KPI display.
unit_idintegerObligatorioUnit ID that defines the measurement unit for this KPI.
is_activebooleanObligatorioActive status indicating whether the KPI is currently active.
sort_orderintegerObligatorioDisplay order for sorting KPIs in the interface.
category_idintegerObligatorioKPI Category ID. Use GET /api/kpicategories to fetch available categories.
frequency_idstringObligatorioFrequency ID that determines data entry frequency (e.g., 'M' for monthly, 'W' for weekly, 'D' for daily).
value_directionstringObligatorioenumDirection indicator: 'U' (up is good), 'D' (down is good), or 'N' (neutral).
UDNaggregate_functionstringObligatorioenumCalculation method for aggregating KPI values: 'AVG' (average) or 'SUM' (sum).
AVGSUM
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create KPI CategorySIMPLEKPI_CREATE_KPI_CATEGORYAcciónTool to create a new KPI category in SimpleKPI. Use when you need to organize KPIs into logical groups or categories.
SIMPLEKPI_CREATE_KPI_CATEGORYAcciónTool to create a new KPI category in SimpleKPI. Use when you need to organize KPIs into logical groups or categories.
Parámetros de entrada
namestringObligatorioCategory name (maximum 50 characters)
sort_orderintegerObligatorioDisplay order for the category (integer value)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create KPI UnitSIMPLEKPI_CREATE_KPI_UNITAcciónTool to create a new KPI unit in SimpleKPI. Use when you need to define a measurement unit for KPI tracking.
SIMPLEKPI_CREATE_KPI_UNITAcciónTool to create a new KPI unit in SimpleKPI. Use when you need to define a measurement unit for KPI tracking.
Parámetros de entrada
namestringObligatorioUnit name (maximum 25 characters)
entry_formatstringObligatorioEntry format for the unit (maximum 25 characters). Use '###' as placeholder for numeric values
is_percentagebooleanObligatorioWhether the unit represents a percentage value
display_formatstringObligatorioDisplay format for the unit (maximum 25 characters). Use '###' as placeholder for numeric values
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Batch KPI EntriesSIMPLEKPI_CREATE_OR_UPDATE_KPI_ENTRIESAcciónTool 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.
SIMPLEKPI_CREATE_OR_UPDATE_KPI_ENTRIESAcciónTool 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.
Parámetros de entrada
entriesobject[]ObligatorioArray of KPI entry objects to create or update. Maximum 5000 entries per batch
hasNotesbooleanIndicates whether the batch contains notes. Helps optimize processing
hasActualsbooleanIndicates whether the batch contains actual values. Helps optimize processing
hasTargetsbooleanIndicates whether the batch contains target values. Helps optimize processing
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create UserSIMPLEKPI_CREATE_USERAcciónTool to create a new user account in SimpleKPI. Use when you need to add a new user with specific permissions and access levels.
SIMPLEKPI_CREATE_USERAcciónTool to create a new user account in SimpleKPI. Use when you need to add a new user with specific permissions and access levels.
Parámetros de entrada
emailstringObligatorioemailValid email address for login
passwordstringObligatorioPassword for new user. Must be at least 8 characters long
last_namestringLast name of user (optional)
user_typestringObligatorioenumUser type: Admin, Director, Manager, or User
AdminDirectorManagerUserfirst_namestringObligatorioFirst name of user
user_status_idstringObligatorioenumUser status: A for Active or L for Locked
ALcan_manage_usersbooleanObligatorioWhether user can manage other users. Relevant for Manager type
can_admin_settingsbooleanObligatorioWhether user can access admin settings. Relevant for Admin type
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Category KPISIMPLEKPI_DELETE_CATEGORY_KPIAcciónTool to delete a KPI from a category. Use when you need to remove a specific KPI from a category.
SIMPLEKPI_DELETE_CATEGORY_KPIAcciónTool to delete a KPI from a category. Use when you need to remove a specific KPI from a category.
Parámetros de entrada
idintegerObligatorioThe ID of the KPI to delete from the category
category_idintegerObligatorioThe ID of the category containing the KPI
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete GroupSIMPLEKPI_DELETE_GROUPAcciónTool to delete a group by ID. Use when you need to permanently remove a group from the system.
SIMPLEKPI_DELETE_GROUPAcciónTool to delete a group by ID. Use when you need to permanently remove a group from the system.
Parámetros de entrada
idintegerObligatorioGroup ID to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Group ItemSIMPLEKPI_DELETE_GROUP_ITEMAcciónTool to delete a group item by ID. Use when you need to remove an item from a specific group.
SIMPLEKPI_DELETE_GROUP_ITEMAcciónTool to delete a group item by ID. Use when you need to remove an item from a specific group.
Parámetros de entrada
idintegerObligatorioThe ID of the group item to delete
group_idintegerObligatorioThe ID of the group containing the item to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete KPISIMPLEKPI_DELETE_KPIAcciónTool to delete a KPI by ID. Use when you need to permanently remove a specific KPI from the system.
SIMPLEKPI_DELETE_KPIAcciónTool to delete a KPI by ID. Use when you need to permanently remove a specific KPI from the system.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the KPI to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete KPI CategorySIMPLEKPI_DELETE_KPI_CATEGORYAcciónTool to delete a KPI category by its ID. Use when you need to remove a KPI category from the system.
SIMPLEKPI_DELETE_KPI_CATEGORYAcciónTool to delete a KPI category by its ID. Use when you need to remove a KPI category from the system.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the KPI category to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete KPI EntrySIMPLEKPI_DELETE_KPI_ENTRYAcciónTool to delete a KPI entry by ID. Use when you need to permanently remove a specific KPI entry from the system.
SIMPLEKPI_DELETE_KPI_ENTRYAcciónTool to delete a KPI entry by ID. Use when you need to permanently remove a specific KPI entry from the system.
Parámetros de entrada
kpientryidintegerObligatorioThe unique identifier of the KPI entry to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete KPI UnitSIMPLEKPI_DELETE_KPI_UNITAcciónTool to delete a KPI unit by its ID. Use when you need to remove a KPI unit from the system.
SIMPLEKPI_DELETE_KPI_UNITAcciónTool to delete a KPI unit by its ID. Use when you need to remove a KPI unit from the system.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the KPI unit to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete UserSIMPLEKPI_DELETE_USERAcciónTool to delete a user account by ID. Use when you need to permanently remove a user from the system.
SIMPLEKPI_DELETE_USERAcciónTool to delete a user account by ID. Use when you need to permanently remove a user from the system.
Parámetros de entrada
idintegerObligatorioUser ID to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete User Group ItemSIMPLEKPI_DELETE_USER_GROUP_ITEMAcciónTool to remove a group item assignment from a user. Use when you need to unassign a specific group item from a user.
SIMPLEKPI_DELETE_USER_GROUP_ITEMAcciónTool to remove a group item assignment from a user. Use when you need to unassign a specific group item from a user.
Parámetros de entrada
idintegerObligatorioGroup item ID to remove from the user.
user_idintegerObligatorioUser ID to remove the group item assignment from.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete User KPISIMPLEKPI_DELETE_USER_KPIAcciónTool to remove a KPI assignment from a user. Use when you need to unassign or delete a specific KPI from a user's profile.
SIMPLEKPI_DELETE_USER_KPIAcciónTool to remove a KPI assignment from a user. Use when you need to unassign or delete a specific KPI from a user's profile.
Parámetros de entrada
idintegerObligatorioThe ID of the KPI assignment to remove from the user
user_idintegerObligatorioThe ID of the user from whom to remove the KPI assignment
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Data EntriesSIMPLEKPI_GET_ALL_DATA_ENTRIESAcciónTool 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.
SIMPLEKPI_GET_ALL_DATA_ENTRIESAcciónTool 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.
Parámetros de entrada
dateTostringEnd date for filtering entries in YYYY-MM-DD format. Defaults to today if not provided
kpiIdsstringComma-separated list of KPI IDs to filter entries (e.g., '1,2,3'). If not provided, returns entries for all KPIs
userIdsstringComma-separated list of user IDs to filter entries (e.g., '5,15,25'). Filters by specific users
dateFromstringStart date for filtering entries in YYYY-MM-DD format. Defaults to today if not provided
groupItemIdsstringComma-separated list of group item IDs to filter entries (e.g., '10,20,30'). Filters by specific group items
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Category KPISIMPLEKPI_GET_CATEGORY_KPIAcciónTool 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.
SIMPLEKPI_GET_CATEGORY_KPIAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe ID of the KPI to retrieve.
category_idintegerObligatorioThe ID of the category containing the KPI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get GroupSIMPLEKPI_GET_GROUPAcciónTool to get a specific group by ID from SimplekPI. Use when you need to retrieve detailed information about a particular group.
SIMPLEKPI_GET_GROUPAcciónTool to get a specific group by ID from SimplekPI. Use when you need to retrieve detailed information about a particular group.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the group to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group ItemSIMPLEKPI_GET_GROUP_ITEMAcciónTool to retrieve a specific group item by ID. Use when you need to fetch details of a particular item within a group.
SIMPLEKPI_GET_GROUP_ITEMAcciónTool to retrieve a specific group item by ID. Use when you need to fetch details of a particular item within a group.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the item to retrieve.
group_idintegerObligatorioThe identifier of the group containing the item.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KPI by IDSIMPLEKPI_GET_KPIAcciónTool 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.
SIMPLEKPI_GET_KPIAcciónTool 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.
Parámetros de entrada
kpi_idintegerObligatorioThe unique identifier of the KPI to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KPI CategorySIMPLEKPI_GET_KPI_CATEGORYAcciónTool to get a specific KPI category by ID from SimpleKPI. Use when you need to retrieve detailed information about a particular KPI category.
SIMPLEKPI_GET_KPI_CATEGORYAcciónTool to get a specific KPI category by ID from SimpleKPI. Use when you need to retrieve detailed information about a particular KPI category.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the KPI category to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KPI EntrySIMPLEKPI_GET_KPI_ENTRYAcciónTool 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.
SIMPLEKPI_GET_KPI_ENTRYAcciónTool 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.
Parámetros de entrada
kpientryidintegerObligatorioThe unique identifier of the KPI entry to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KPI FrequencySIMPLEKPI_GET_KPI_FREQUENCYAcciónTool to get a specific KPI frequency by ID from SimplekPI. Use when you need to retrieve information about a particular frequency setting for KPIs.
SIMPLEKPI_GET_KPI_FREQUENCYAcciónTool to get a specific KPI frequency by ID from SimplekPI. Use when you need to retrieve information about a particular frequency setting for KPIs.
Parámetros de entrada
idstringObligatorioThe frequency ID (e.g., 'D' for Daily, 'W' for Weekly, 'M' for Monthly)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KPI Icon by IDSIMPLEKPI_GET_KPI_ICONAcciónTool 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.
SIMPLEKPI_GET_KPI_ICONAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the KPI icon to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KPI UnitSIMPLEKPI_GET_KPI_UNITAcciónTool 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.
SIMPLEKPI_GET_KPI_UNITAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the KPI unit to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User by IDSIMPLEKPI_GET_USERAcciónTool to retrieve a specific user by ID. Use when you need to get details about a particular user account.
SIMPLEKPI_GET_USERAcciónTool to retrieve a specific user by ID. Use when you need to get details about a particular user account.
Parámetros de entrada
idintegerObligatorioThe unique user ID to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User Group ItemSIMPLEKPI_GET_USER_GROUP_ITEMAcciónTool 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.
SIMPLEKPI_GET_USER_GROUP_ITEMAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe identifier of the group item to retrieve
user_idintegerObligatorioThe identifier of the user
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User KPISIMPLEKPI_GET_USER_KPIAcciónTool to retrieve a specific KPI assigned to a user. Use when you need details about a particular KPI assignment for a user.
SIMPLEKPI_GET_USER_KPIAcciónTool to retrieve a specific KPI assigned to a user. Use when you need details about a particular KPI assignment for a user.
Parámetros de entrada
idintegerObligatorioThe ID of the KPI assigned to the user.
user_idintegerObligatorioThe ID of the user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Category KPIsSIMPLEKPI_LIST_CATEGORY_KPISAcciónTool to retrieve all KPIs within a specific category. Use when you need to list or inspect KPIs belonging to a particular category.
SIMPLEKPI_LIST_CATEGORY_KPISAcciónTool to retrieve all KPIs within a specific category. Use when you need to list or inspect KPIs belonging to a particular category.
Parámetros de entrada
category_idintegerObligatorioThe ID of the category to retrieve KPIs from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Group ItemsSIMPLEKPI_LIST_GROUP_ITEMSAcciónTool to get all items within a group. Use when you need to retrieve the complete list of items belonging to a specific group.
SIMPLEKPI_LIST_GROUP_ITEMSAcciónTool to get all items within a group. Use when you need to retrieve the complete list of items belonging to a specific group.
Parámetros de entrada
group_idintegerObligatorioThe identifier of the group containing the items
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List GroupsSIMPLEKPI_LIST_GROUPSAcciónTool to retrieve all groups from SimpleKPI. Use when you need to list groups for organizing users and company hierarchy.
SIMPLEKPI_LIST_GROUPSAcciónTool to retrieve all groups from SimpleKPI. Use when you need to list groups for organizing users and company hierarchy.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List KPI CategoriesSIMPLEKPI_LIST_KPI_CATEGORIESAcciónTool to get all KPI categories. Use when you need to retrieve the complete list of KPI categories for organizing KPIs.
SIMPLEKPI_LIST_KPI_CATEGORIESAcciónTool to get all KPI categories. Use when you need to retrieve the complete list of KPI categories for organizing KPIs.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List KPI EntriesSIMPLEKPI_LIST_KPI_ENTRIESAcciónTool 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.
SIMPLEKPI_LIST_KPI_ENTRIESAcciónTool 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.
Parámetros de entrada
pageintegerPage number for pagination (starts at 1)
rowsintegerMaximum number of entries to return per page (max 500)
kpiidintegerFilter by specific KPI ID to get entries only for that KPI
dateTostringObligatorioEnd date for filtering KPI entries in YYYY-MM-DD format
useridintegerFilter by specific user ID to get entries only for that user
dateFromstringObligatorioStart date for filtering KPI entries in YYYY-MM-DD format
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List KPI FrequenciesSIMPLEKPI_LIST_KPI_FREQUENCIESAcciónTool to get all KPI frequencies. Use when you need to retrieve available data entry frequency options (Daily, Weekly, Monthly, etc.) for KPI configuration.
SIMPLEKPI_LIST_KPI_FREQUENCIESAcciónTool to get all KPI frequencies. Use when you need to retrieve available data entry frequency options (Daily, Weekly, Monthly, etc.) for KPI configuration.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List KPI IconsSIMPLEKPI_LIST_KPI_ICONSAcciónTool to retrieve all KPI icons from SimpleKPI. Use when you need to get available icons for display purposes or to help identify KPIs.
SIMPLEKPI_LIST_KPI_ICONSAcciónTool to retrieve all KPI icons from SimpleKPI. Use when you need to get available icons for display purposes or to help identify KPIs.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All KPIsSIMPLEKPI_LIST_KPISAcciónTool to retrieve all KPIs from a SimpleKPI account. Use when you need to list all available KPIs with their configurations, targets, and metadata.
SIMPLEKPI_LIST_KPISAcciónTool to retrieve all KPIs from a SimpleKPI account. Use when you need to list all available KPIs with their configurations, targets, and metadata.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All KPI UnitsSIMPLEKPI_LIST_KPI_UNITSAcciónTool 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.).
SIMPLEKPI_LIST_KPI_UNITSAcciónTool 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.).
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List User Group ItemsSIMPLEKPI_LIST_USER_GROUP_ITEMSAcciónTool to get all group items assigned to a user. Use when you need to retrieve group assignments for a specific user in SimpleKPI.
SIMPLEKPI_LIST_USER_GROUP_ITEMSAcciónTool to get all group items assigned to a user. Use when you need to retrieve group assignments for a specific user in SimpleKPI.
Parámetros de entrada
user_idintegerObligatorioThe ID of the user to retrieve group items for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List User KPIsSIMPLEKPI_LIST_USER_KPISAcciónTool 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.
SIMPLEKPI_LIST_USER_KPISAcciónTool 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.
Parámetros de entrada
user_idintegerObligatorioUser ID to retrieve KPIs for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Category KPISIMPLEKPI_UPDATE_CATEGORY_KPIAcciónTool to update a KPI within a category. Use when you need to modify KPI details such as name, target, frequency, or aggregation method.
SIMPLEKPI_UPDATE_CATEGORY_KPIAcciónTool to update a KPI within a category. Use when you need to modify KPI details such as name, target, frequency, or aggregation method.
Parámetros de entrada
idintegerObligatorioKPI ID to update
namestringObligatorioKPI name (max 100 characters)
icon_idintegerObligatorioIcon identifier for the KPI
unit_idintegerObligatorioUnit of measure identifier
is_activebooleanObligatorioDetermines if data entry is permitted for this KPI
sort_orderintegerObligatorioDisplay ordering position
category_idintegerObligatorioCategory ID containing the KPI
descriptionstringKPI description (max 150 characters)
frequency_idstringObligatorioenumData entry frequency: W (Weekly), D (Daily), M (Monthly), Q (Quarterly), or Y (Yearly)
WDMQYtarget_defaultnumberDefault target value for the KPI
value_directionstringObligatorioenumDirection indicator: U (Up), D (Down), or N (None)
UDNaggregate_functionstringObligatorioenumCalculation method: AVG (Average) or SUM (Sum)
AVGSUM
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update GroupSIMPLEKPI_UPDATE_GROUPAcciónTool to update an existing group in SimpleKPI. Use when you need to modify a group's name or display order.
SIMPLEKPI_UPDATE_GROUPAcciónTool to update an existing group in SimpleKPI. Use when you need to modify a group's name or display order.
Parámetros de entrada
idintegerObligatorioThe unique ID of the group to update.
namestringObligatorioThe new name for the group (max 50 characters).
sort_orderintegerObligatorioThe display order for the group. Lower values appear first.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Group ItemSIMPLEKPI_UPDATE_GROUP_ITEMAcciónTool 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.
SIMPLEKPI_UPDATE_GROUP_ITEMAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the item to update.
namestringObligatorioThe new name for the item. Maximum length is 50 characters.
group_idintegerObligatorioThe unique identifier of the group containing the item.
sort_orderintegerObligatorioThe display order of the item. Must be a 16-bit integer (range: -32768 to 32767).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update KPISIMPLEKPI_UPDATE_KPIAcciónTool to update an existing KPI in SimpleKPI. Use when you need to modify KPI properties such as name, description, target values, or settings.
SIMPLEKPI_UPDATE_KPIAcciónTool to update an existing KPI in SimpleKPI. Use when you need to modify KPI properties such as name, description, target values, or settings.
Parámetros de entrada
idintegerObligatorioKPI ID to update
namestringObligatorioKPI name (maximum 100 characters)
icon_idintegerObligatorioIcon identifier for the KPI
unit_idintegerObligatorioUnit of measure identifier
is_activebooleanObligatorioActivation status for data entry. Set to true to enable data entry, false to disable.
sort_orderintegerObligatorioDisplay order ranking for the KPI
category_idintegerObligatorioKPI Category ID that this KPI belongs to
descriptionstringKPI description (maximum 150 characters)
frequency_idstringObligatorioenumData entry frequency (D=Daily, W=Weekly, M=Monthly, Q=Quarterly, Y=Yearly). Case-sensitive, must be uppercase.
DWMQYtarget_defaultnumberDefault target value for the KPI
value_directionstringObligatorioenumDirection indicator: U(p) means higher is better, D(own) means lower is better, N(one) means no direction
UDNaggregate_functionstringObligatorioenumHow the KPI is calculated: AVG (Average) or SUM (Total Sum)
AVGSUM
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update KPI EntrySIMPLEKPI_UPDATE_KPI_ENTRYAcciónTool 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).
SIMPLEKPI_UPDATE_KPI_ENTRYAcciónTool 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).
Parámetros de entrada
notesstringThe note associated with the KPI entry (max 500 characters)
actualnumberThe actual value. Cannot be null if the target and notes are both null
kpi_idintegerObligatorioThe KPI must be active and cannot be a calculated KPI. The KPI must also be assigned to the user
targetnumberThe target value of the entry. This value will be ignored if the KPI has a null target
user_idintegerObligatorioAn ID of an active user to assign to the KPI entry
entry_datestringObligatorioThe date of the entry. Date time format without timezone, e.g. '2019-01-01T00:00:00'
kpientryidintegerObligatorioThe ID of the KPI entry to update (required)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update KPI UnitSIMPLEKPI_UPDATE_KPI_UNITAcciónTool 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.
SIMPLEKPI_UPDATE_KPI_UNITAcciónTool 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.
Parámetros de entrada
idintegerObligatorioThe unit ID to update
namestringObligatorioThe name of the KPI unit (maximum 25 characters)
entry_formatstringObligatorioThe entry format is only for entry and will not have the prefix or suffix (e.g., #.00). Maximum 25 characters.
is_percentagebooleanObligatorioTo determine if the value is a percentage as these values are treated differently
display_formatstringObligatorioThe display format must be a valid number format (e.g., £ #.00). Maximum 25 characters.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update UserSIMPLEKPI_UPDATE_USERAcciónTool to update an existing user account in SimpleKPI. Use when you need to modify user details such as type, status, name, or permissions.
SIMPLEKPI_UPDATE_USERAcciónTool to update an existing user account in SimpleKPI. Use when you need to modify user details such as type, status, name, or permissions.
Parámetros de entrada
idintegerObligatorioUser ID to update
emailstringObligatorioEmail address of the user
last_namestringLast name of the user
user_typestringObligatorioUser type (e.g., 'Standard', 'Manager', 'Director')
first_namestringObligatorioFirst name of the user
user_status_idstringObligatorioUser status ID. Use 'A' for Active, 'I' for Inactive
can_manage_usersbooleanWhether the user can manage other users. Set to true to grant user management permissions
can_admin_settingsbooleanWhether the user can access admin settings. Set to true to grant admin access
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not