The SimpleKPI connector lets your AI agent act in each user's SimpleKPI account. Each user connects their own SimpleKPI access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 38 tools.
- Tools
- 38
- What they doRead · write · destructive
- 19 · 13 · 619 read13 write6 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the SimpleKPI connection
In AgentKit > Connections, create a SimpleKPI connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'simplekpi'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize SimpleKPI:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'simplekpi_breakdown_items_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "simplekpi"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize SimpleKPI:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="simplekpi_breakdown_items_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their SimpleKPI credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolsimplekpi_breakdown_item_getGet one breakdown item by ID.Read-onlyGet Breakdown Item
Get one breakdown item by ID. Returns the item object.
Inputs
item_idintegerrequired- ID of the breakdown item. Example: 1234.
simplekpi_breakdown_items_listList the breakdown items (the people, teams, products or regions a KPI is split by).Read-onlyList Breakdown Items
List the breakdown items (the people, teams, products or regions a KPI is split by). Returns item IDs to use as source_id on KPI entries. Use simplekpi_breakdown_item_get for one item.
Inputs
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
simplekpi_category_kpi_getGet one KPI from a category.Read-onlyGet KPI in Category
Get one KPI from a category. Returns the KPI object; a KPI from another category returns 404.
Inputs
category_idintegerrequired- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
kpi_idintegerrequired- ID of the KPI. Example: 1234.
simplekpi_category_kpis_listList the KPIs in one category, a page at a time.Read-onlyList KPIs in Category
List the KPIs in one category, a page at a time. Returns KPI objects. Use simplekpi_kpis_list for every KPI.
Inputs
category_idintegerrequired- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
simplekpi_kpi_categories_listList the KPI categories (groups of KPIs).Read-onlyList KPI Categories
List the KPI categories (groups of KPIs). Returns category objects with ID, name and sort order. Use simplekpi_category_kpis_list for the KPIs in one category.
Inputs
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
simplekpi_kpi_category_getGet one KPI category by ID.Read-onlyGet KPI Category
Get one KPI category by ID. Returns the category object. Get IDs from simplekpi_kpi_categories_list.
Inputs
category_idintegerrequired- ID of the category. Example: 1234.
simplekpi_kpi_entries_listList raw KPI entries (actuals, targets, notes per date), filtered by KPI, user, breakdown item and date range, a page at a time.Read-onlyList KPI Entries
List raw KPI entries (actuals, targets, notes per date), filtered by KPI, user, breakdown item and date range, a page at a time. Returns entry objects. Use simplekpi_report_get for values aggregated per period.
Inputs
date_fromstring- Earliest entry date to include. Example: 2026-07-01T00:00:00.
date_tostring- Latest entry date to include. Example: 2026-07-31T00:00:00.
kpi_idinteger- Only entries for this KPI. Example: 1234.
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
source_idinteger- Only entries for this breakdown source. Example: 0.
user_idinteger- Only entries recorded against this user. Example: 42.
simplekpi_kpi_entry_getGet one KPI entry by ID.Read-onlyGet KPI Entry
Get one KPI entry by ID. Returns the entry object. Get IDs from simplekpi_kpi_entries_list.
Inputs
entry_idintegerrequired- ID of the entry. Example: 1234.
simplekpi_kpi_frequencies_listList the frequencies a KPI can use (daily, weekly, monthly...).Read-onlyList KPI Frequencies
List the frequencies a KPI can use (daily, weekly, monthly...). Returns frequency IDs (D, W, M, Q, Y) and names to use as frequency_id.
Inputs
This tool takes no inputs.
simplekpi_kpi_frequency_getGet one frequency by its code.Read-onlyGet KPI Frequency
Get one frequency by its code. Returns the frequency's ID and name.
Inputs
frequency_idstringrequired- Frequency code, for example W (case sensitive). Example: W.
simplekpi_kpi_getGet one KPI by ID.Read-onlyGet KPI
Get one KPI by ID. Returns the KPI object. Get IDs from simplekpi_kpis_list.
Inputs
kpi_idintegerrequired- ID of the KPI. Example: 1234.
simplekpi_kpi_icon_getGet one KPI icon by ID.Read-onlyGet KPI Icon
Get one KPI icon by ID. Returns the icon object.
Inputs
icon_idintegerrequired- ID of the icon. Example: 1234.
simplekpi_kpi_icons_listList the icons a KPI can show.Read-onlyList KPI Icons
List the icons a KPI can show. Returns icon IDs and names to use as icon_id.
Inputs
This tool takes no inputs.
simplekpi_kpi_unit_getGet one unit by ID.Read-onlyGet KPI Unit
Get one unit by ID. Returns the unit object. Get IDs from simplekpi_kpi_units_list.
Inputs
unit_idintegerrequired- ID of the unit. Example: 1234.
simplekpi_kpi_units_listList the units that format KPI values (currency, percentage, number).Read-onlyList KPI Units
List the units that format KPI values (currency, percentage, number). Returns unit IDs and formats to use as unit_id.
Inputs
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
simplekpi_kpis_listList the KPIs on the account, a page at a time.Read-onlyList KPIs
List the KPIs on the account, a page at a time. Returns KPI objects with ID, name, category, unit, frequency, direction and default target. Use simplekpi_category_kpis_list for one category and simplekpi_kpi_get for one KPI.
Inputs
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
simplekpi_report_getReport actuals and targets for KPIs over a date range, aggregated to each KPI's own frequency and aggregate function, one row per KPI, breakdown item and period.Read-onlyGet Actuals and Targets Report
Report actuals and targets for KPIs over a date range, aggregated to each KPI's own frequency and aggregate function, one row per KPI, breakdown item and period. Returns report rows with KPI name, period, actual, target and notes. Use simplekpi_kpi_entries_list for raw entries.
Inputs
date_fromstring- Start of the date range (ISO 8601). Example: 2026-07-01T00:00:00.
date_tostring- End of the date range (ISO 8601). Example: 2026-07-31T00:00:00.
group_item_idsstring- Comma-separated breakdown item IDs to restrict the report to. Example: 77,78.
kpi_idsstring- Comma-separated KPI IDs to report on, for example 1234,1235. Example: 1234,1235.
user_idsstring- Comma-separated user IDs to restrict the report to. Example: 42,43.
simplekpi_user_getGet one user by ID.Read-onlyGet User
Get one user by ID. Returns the user object. Get IDs from simplekpi_users_list.
Inputs
user_idintegerrequired- ID of the user. Example: 1234.
simplekpi_users_listList the people on the SimpleKPI account with their role, status and email.Read-onlyList Users
List the people on the SimpleKPI account with their role, status and email. Returns user objects; pass an ID as user_id (or the email) when writing KPI entries. Users are managed in the app, not the API.
Inputs
pageinteger- Page to return, counting from 1. Lists return a plain array; keep paging until a page has fewer than rows items. Example: 1.
rowsinteger- Rows per page. Defaults to 500. Example: 500.
simplekpi_breakdown_item_createCreate a breakdown item under a breakdown.WriteCreate Breakdown Item
Create a breakdown item under a breakdown. Returns the item with its ID.
Inputs
namestringrequired- Name of the item, for example a team, product or region. Example: North.
breakdown_idinteger- ID of the breakdown the item sits under; null when it combines several breakdowns. Example: 9.
is_archivedboolean- true archives the item: it keeps its history but is not offered for new entries. Example: false.
is_systemboolean- Leave false; true marks items SimpleKPI maintains itself. Example: false.
sort_orderinteger- Position of the item within its breakdown. Example: 1.
simplekpi_breakdown_item_updateReplace a breakdown item's name, breakdown, archive flag and sort order.WriteUpdate Breakdown Item
Replace a breakdown item's name, breakdown, archive flag and sort order. This is a full replacement: fields left out are reset to their defaults, so read the record first and send it back changed. Returns the updated item.
- Idempotent
Inputs
item_idintegerrequired- ID of the item to replace. Example: 1234.
namestringrequired- What this part of the breakdown is called, e.g. a person, team, product or region. Example: North.
breakdown_idinteger- Nullable. Which breakdown the item sits under. Null when the item combines more than one breakdown rather than belonging to a single one. Example: 9.
is_archivedboolean- Archived items keep their history but stop being offered for new entries. Example: false.
is_systemboolean- True for items SimpleKPI maintains itself. Leave it false when creating one; it is ignored on update, because a built-in item cannot be made ordinary through the API. Example: false.
sort_orderinteger- Position of the item within its breakdown. Example: 1.
simplekpi_category_kpi_createCreate a KPI inside a category; the category comes from the path.WriteCreate KPI in Category
Create a KPI inside a category; the category comes from the path. Returns the KPI with its ID. Use simplekpi_kpi_create when the category is in the body.
Inputs
aggregate_functionstringrequired- How values roll up over a period: SUM or AVG. Example: SUM.one of
SUMAVG category_idintegerrequired- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
frequency_idstringrequired- How often data is entered: D daily, W weekly, M monthly, Q quarterly, Y yearly (case sensitive; see simplekpi_kpi_frequencies_list). Example: W.one of
DWMQY namestringrequired- What the KPI is called. Example: New Sales.
value_directionstringrequired- Which way is good: U up, D down, N neither. Example: U.one of
UDN descriptionstring- Nullable. Free text shown alongside the KPI. Example: Closed-won deals per week.
icon_idinteger- ID of the icon shown with the KPI. Required in practice (0 is rejected); get IDs from simplekpi_kpi_icons_list. Example: 1.
is_activeboolean- Inactive KPIs stay on the account but are hidden from day-to-day views. Example: true.
sort_orderinteger- Position of the KPI within its category. Example: 1.
target_defaultnumber- Nullable. The target applied to new entries when none is given. Example: 100.
unit_idinteger- ID of the unit that formats the KPI's values. Send a real ID from simplekpi_kpi_units_list. Example: 123.
simplekpi_category_kpi_updateReplace a KPI that is in the given category.WriteUpdate KPI in Category
Replace a KPI that is in the given category. This is a full replacement: fields left out are reset to their defaults, so read the record first and send it back changed. Returns the updated KPI.
- Idempotent
Inputs
aggregate_functionstringrequired- How values roll up over a period: SUM or AVG. Example: SUM.one of
SUMAVG category_idintegerrequired- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
frequency_idstringrequired- How often data is entered: D daily, W weekly, M monthly, Q quarterly, Y yearly (case sensitive; see simplekpi_kpi_frequencies_list). Example: W.one of
DWMQY kpi_idintegerrequired- ID of the KPI to replace. Example: 1234.
namestringrequired- What the KPI is called. Example: New Sales.
value_directionstringrequired- Which way is good: U up, D down, N neither. Example: U.one of
UDN descriptionstring- Nullable. Free text shown alongside the KPI. Example: Closed-won deals per week.
icon_idinteger- ID of the icon shown with the KPI. Required in practice (0 is rejected); get IDs from simplekpi_kpi_icons_list. Example: 1.
is_activeboolean- Inactive KPIs stay on the account but are hidden from day-to-day views. Example: true.
sort_orderinteger- Position of the KPI within its category. Example: 1.
target_defaultnumber- Nullable. The target applied to new entries when none is given. Example: 100.
unit_idinteger- ID of the unit that formats the KPI's values. Send a real ID from simplekpi_kpi_units_list. Example: 123.
simplekpi_kpi_category_createCreate a KPI category.WriteCreate KPI Category
Create a KPI category. Returns the category with its ID.
Inputs
namestringrequired- What the category is called. Example: New Sales.
sort_orderinteger- Position of the category in the list. Example: 1.
simplekpi_kpi_category_updateReplace a KPI category's name and sort order.WriteUpdate KPI Category
Replace a KPI category's name and sort order. This is a full replacement: fields left out are reset to their defaults, so read the record first and send it back changed. Returns the updated category.
- Idempotent
Inputs
category_idintegerrequired- ID of the category to replace. Example: 1234.
namestringrequired- What the category is called. Example: New Sales.
sort_orderinteger- Position of the category in the list. Example: 1.
simplekpi_kpi_createCreate a KPI with its name, frequency, value direction, aggregate function, category, icon and unit.WriteCreate KPI
Create a KPI with its name, frequency, value direction, aggregate function, category, icon and unit. Returns the KPI with its ID. Get icon IDs from simplekpi_kpi_icons_list and unit IDs from simplekpi_kpi_units_list.
Inputs
aggregate_functionstringrequired- How values roll up over a period: SUM or AVG. Example: SUM.one of
SUMAVG frequency_idstringrequired- How often data is entered: D daily, W weekly, M monthly, Q quarterly, Y yearly (case sensitive; see simplekpi_kpi_frequencies_list). Example: W.one of
DWMQY namestringrequired- What the KPI is called. Example: New Sales.
value_directionstringrequired- Which way is good: U up, D down, N neither. Example: U.one of
UDN category_idinteger- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
descriptionstring- Nullable. Free text shown alongside the KPI. Example: Closed-won deals per week.
icon_idinteger- ID of the icon shown with the KPI. Required in practice (0 is rejected); get IDs from simplekpi_kpi_icons_list. Example: 1.
is_activeboolean- Inactive KPIs stay on the account but are hidden from day-to-day views. Example: true.
sort_orderinteger- Position of the KPI within its category. Example: 1.
target_defaultnumber- Nullable. The target applied to new entries when none is given. Example: 100.
unit_idinteger- ID of the unit that formats the KPI's values. Send a real ID from simplekpi_kpi_units_list. Example: 123.
simplekpi_kpi_entries_batch_upsertUpsert many KPI entries in one call.WriteAdd or Update Many KPI Entries
Upsert many KPI entries in one call. Returns rows_added and rows_rejected; a batch where every row is rejected still returns 200, so check rows_rejected. Use simplekpi_kpi_entry_upsert for a single entry.
Inputs
entriesarray- Entries to write, each shaped like a single entry: kpi_id, entry_date and actual, target or notes, plus setActual/setTarget/setNotes flags and optionally user_id or email and source_id. Example: [{"kpi_id": 1234, "entry_date": "2026-08-03T00:00:00", "actual": 42, "setActual": true}]
has_actualsboolean- true when the batch carries actual values. Example: true.
has_notesboolean- true when the batch carries notes. Example: false.
has_targetsboolean- true when the batch carries target values. Example: false.
simplekpi_kpi_entry_updateUpdate a KPI entry by ID, writing the fields chosen with setActual, setTarget and setNotes.WriteUpdate KPI Entry
Update a KPI entry by ID, writing the fields chosen with setActual, setTarget and setNotes. Returns the updated entry. Get IDs from simplekpi_kpi_entries_list.
- Idempotent
Inputs
entry_idintegerrequired- ID of the entry to update. Example: 1234.
actualnumber- Nullable. The value achieved. Example: 42.
add_to_actualboolean- Send true to add actual to the stored value instead of replacing it. Useful for feeding in events as they happen rather than recalculating a daily total. Example: false.
emailstring- Nullable. Identifies the user by email address instead of user_id. Send one or the other, not both. Kept for integrations built against v1. Example: alex@example.com.
entry_datestring- Date the value is recorded against (ISO 8601). It must fit the KPI's frequency: a weekly KPI rejects a mid-week date. Example: 2026-08-03T00:00:00.
kpi_idinteger- ID of the KPI. Get IDs from simplekpi_kpis_list. Example: 1234.
notesstring- Nullable. Free text stored with the entry. Example: Two deals slipped to next week.
set_actualboolean- Send true to write actual, false to leave whatever is already stored untouched. This is how you update a target without clearing the actual. Example: true.
set_notesboolean- Send true to write notes, false to leave the stored text untouched. Example: false.
set_targetboolean- Send true to write target, false to leave the stored value untouched. Example: true.
source_idinteger- ID of the breakdown item (source) the value belongs to. Get IDs from simplekpi_breakdown_items_list; omit for the KPI's default. Example: 0.
targetnumber- Nullable. The value being aimed at. Example: 50.
user_idinteger- ID of the user the entry is recorded against (null for a KPI with no breakdown). Get IDs from simplekpi_users_list. Example: 42.
simplekpi_kpi_entry_upsertRecord a value for a KPI on a date: an upsert keyed by KPI, breakdown item and date, so sending the same combination again updates it.WriteAdd or Update KPI Entry
Record a value for a KPI on a date: an upsert keyed by KPI, breakdown item and date, so sending the same combination again updates it. setActual, setTarget and setNotes choose which fields are written; addToActual adds to the stored actual. Returns the entry, or a nothing-stored object when actual, target and notes were all empty. Use simplekpi_kpi_entries_batch_upsert for many entries.
Inputs
actualnumber- Nullable. The value achieved. Example: 42.
add_to_actualboolean- Send true to add actual to the stored value instead of replacing it. Useful for feeding in events as they happen rather than recalculating a daily total. Example: false.
emailstring- Nullable. Identifies the user by email address instead of user_id. Send one or the other, not both. Kept for integrations built against v1. Example: alex@example.com.
entry_datestring- Date the value is recorded against (ISO 8601). It must fit the KPI's frequency: a weekly KPI rejects a mid-week date. Example: 2026-08-03T00:00:00.
kpi_idinteger- ID of the KPI. Get IDs from simplekpi_kpis_list. Example: 1234.
notesstring- Nullable. Free text stored with the entry. Example: Two deals slipped to next week.
set_actualboolean- Send true to write actual, false to leave whatever is already stored untouched. This is how you update a target without clearing the actual. Example: true.
set_notesboolean- Send true to write notes, false to leave the stored text untouched. Example: false.
set_targetboolean- Send true to write target, false to leave the stored value untouched. Example: true.
source_idinteger- ID of the breakdown item (source) the value belongs to. Get IDs from simplekpi_breakdown_items_list; omit for the KPI's default. Example: 0.
targetnumber- Nullable. The value being aimed at. Example: 50.
user_idinteger- ID of the user the entry is recorded against (null for a KPI with no breakdown). Get IDs from simplekpi_users_list. Example: 42.
simplekpi_kpi_unit_createCreate a unit with entry and display number formats.WriteCreate KPI Unit
Create a unit with entry and display number formats. Returns the unit with its ID.
Inputs
display_formatstringrequired- Number format used to show values, in the same notation, for example #,##0. Example: #,##0.
entry_formatstringrequired- Number format used when values are typed in, for example #,##0.00 (digits and # are placeholders, a comma groups thousands). Example: #,##0.00.
namestringrequired- Name of the unit, for example Pounds or Percent (max 25 characters). Example: New Sales.
is_percentageboolean- true treats values as percentages. Example: false.
simplekpi_kpi_unit_updateReplace a unit's name and formats.WriteUpdate KPI Unit
Replace a unit's name and formats. This is a full replacement: fields left out are reset to their defaults, so read the record first and send it back changed. Returns the updated unit.
- Idempotent
Inputs
display_formatstringrequired- The format used when the value is shown, in the same notation as entry_format. Example: #,##0.
entry_formatstringrequired- A numeric format string used when values are typed in. Digits and # are placeholders, , groups thousands, and one decimal group is allowed — for example #,##0.00, 0.## or #.00. Example: #,##0.00.
namestringrequired- What the unit is called, e.g. Pounds or Percent. Example: Pounds.
unit_idintegerrequired- ID of the unit to replace. Example: 1234.
is_percentageboolean- True when values are treated as percentages. Example: false.
simplekpi_kpi_updateReplace a KPI's settings.WriteUpdate KPI
Replace a KPI's settings. This is a full replacement: fields left out are reset to their defaults, so read the record first and send it back changed. Returns the updated KPI. Get the current values with simplekpi_kpi_get.
- Idempotent
Inputs
aggregate_functionstringrequired- How values roll up over a period: SUM or AVG. Example: SUM.one of
SUMAVG frequency_idstringrequired- How often data is entered: D daily, W weekly, M monthly, Q quarterly, Y yearly (case sensitive; see simplekpi_kpi_frequencies_list). Example: W.one of
DWMQY kpi_idintegerrequired- ID of the KPI to replace. Example: 1234.
namestringrequired- What the KPI is called. Example: New Sales.
value_directionstringrequired- Which way is good: U up, D down, N neither. Example: U.one of
UDN category_idinteger- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
descriptionstring- Nullable. Free text shown alongside the KPI. Example: Closed-won deals per week.
icon_idinteger- ID of the icon shown with the KPI. Required in practice (0 is rejected); get IDs from simplekpi_kpi_icons_list. Example: 1.
is_activeboolean- Inactive KPIs stay on the account but are hidden from day-to-day views. Example: true.
sort_orderinteger- Position of the KPI within its category. Example: 1.
target_defaultnumber- Nullable. The target applied to new entries when none is given. Example: 100.
unit_idinteger- ID of the unit that formats the KPI's values. Send a real ID from simplekpi_kpi_units_list. Example: 123.
simplekpi_breakdown_item_deleteDelete a breakdown item.DestructiveDelete Breakdown Item
Delete a breakdown item. Returns an empty response. Get IDs from simplekpi_breakdown_items_list.
- Idempotent
Inputs
item_idintegerrequired- ID of the item to delete. Example: 1234.
simplekpi_category_kpi_deleteDelete a KPI that is in the given category, with all its entries.DestructiveDelete KPI in Category
Delete a KPI that is in the given category, with all its entries. This cannot be undone. Returns an empty response.
- Idempotent
Inputs
category_idintegerrequired- ID of the KPI category. Get IDs from simplekpi_kpi_categories_list. Example: 5478.
kpi_idintegerrequired- ID of the KPI to delete. Example: 1234.
simplekpi_kpi_category_deleteDelete a KPI category.DestructiveDelete KPI Category
Delete a KPI category. Returns an empty response. Get IDs from simplekpi_kpi_categories_list.
- Idempotent
Inputs
category_idintegerrequired- ID of the category to delete. Example: 1234.
simplekpi_kpi_deleteDelete a KPI and every entry recorded against it.DestructiveDelete KPI
Delete a KPI and every entry recorded against it. This cannot be undone. Returns an empty response. Get IDs from simplekpi_kpis_list.
- Idempotent
Inputs
kpi_idintegerrequired- ID of the KPI to delete. Example: 1234.
simplekpi_kpi_entry_deleteDelete a KPI entry.DestructiveDelete KPI Entry
Delete a KPI entry. Returns an empty response. Get IDs from simplekpi_kpi_entries_list.
- Idempotent
Inputs
entry_idintegerrequired- ID of the entry to delete. Example: 1234.
simplekpi_kpi_unit_deleteDelete a unit that no KPI uses.DestructiveDelete KPI Unit
Delete a unit that no KPI uses. Returns an empty response; a unit in use cannot be deleted.
- Idempotent
Inputs
unit_idintegerrequired- ID of the unit to delete. Example: 1234.
No tools match.