SimpleKPI
Analytics & dataCredentials form
Read SimpleKPI users, KPIs, groups and report data, and add, update or delete KPI data entries.
14 actions
| Action | Effect | Data handled | Scope |
|---|---|---|---|
| simplekpi_list_usersLists the account's users with their type, status and email | read | Personal data | |
| simplekpi_get_userGets one user by id | read | Personal data | |
| simplekpi_list_kpisLists all KPIs with their category, unit, frequency, default target, value direction and aggregation | read | General | |
| simplekpi_get_kpiGets one KPI by id | read | General | |
| simplekpi_list_kpi_categoriesLists the KPI categories | read | General | |
| simplekpi_list_groupsLists the groups (such as Region or Department) used to slice KPI data | read | General | |
| simplekpi_list_group_itemsLists the items of a group, e.g | read | General | |
| simplekpi_list_kpi_entriesLists KPI data entries by user, KPI and date range (both default to today); returns up to rows entries (max 500) per page, so ask for the next page while a page is full | read | General | |
| simplekpi_get_kpi_entryGets one KPI data entry by id | read | General | |
| simplekpi_add_kpi_entryAdds a data entry for a user (by id or email) and an active, non-calculated KPI assigned to them; give actual, target or notes | write | General | |
| simplekpi_add_kpi_entriesAdds or updates up to 5000 KPI entries in one batch; hasActuals, hasTargets or hasNotes false keeps those values of existing entries unchanged | write | General | |
| simplekpi_update_kpi_entryUpdates a KPI data entry's user, KPI, date, actual, target or notes | write | General | |
| simplekpi_delete_kpi_entryPermanently deletes a KPI data entry with its group items | destructive | General | |
| simplekpi_get_report_entriesGets the processed report data (up to 10,000 entries), including calculated KPIs, for KPIs, users and group items over a date range (default today) | read | General |