New to Corsair? See API access, authentication, and error handling.
Breakdown Items
create
breakdownItems.create
Create a breakdown item, such as a person, team, product or region; its id is what an entry sends as source_id
Risk: write
Output
delete
breakdownItems.delete
Delete a breakdown item. SimpleKPI answers 204 but keeps the item archived (is_archived true) rather than removing it
Risk: destructive · Irreversible
SimpleKPI answers 204 but keeps the item, archived (
is_archived: true), rather than removing it (live, 11-16).
Output
get
breakdownItems.get
Read one breakdown item by id, with the breakdown it belongs to
Risk: read
Output
list
breakdownItems.list
List the breakdown items a KPI can be broken down by, a page at a time; the API has no breakdown filter, so filter on breakdown_id across the pages
Risk: read
The API has no breakdown filter, so page through the items and filter on
breakdown_id yourself.
Output: object[]
Output full type
Output full type
update
breakdownItems.update
Replace a breakdown item; anything left out is reset to its default
Risk: write
Output
Kpi Categories
create
kpiCategories.create
Create a KPI category, which groups KPIs on the dashboard
Risk: write
Output
delete
kpiCategories.delete
Delete a KPI category; the KPIs in it are affected and this cannot be undone
Risk: destructive · Irreversible
Output
get
kpiCategories.get
Read one KPI category by id, with its name and sort order
Risk: read
Output
kpis.create
kpiCategories.kpis.create
Create a KPI inside one category; it lands in the category in the path even when the body names another
Risk: write
Output
kpis.delete
kpiCategories.kpis.delete
Delete a KPI through its category, with every entry recorded against it; this cannot be undone
Risk: destructive · Irreversible
Output
kpis.get
kpiCategories.kpis.get
Read one KPI through its category. A KPI under a different category answers 404
Risk: read
A KPI under a different category answers 404, which is how the API keeps a caller on the right parent.
Output
kpis.list
kpiCategories.kpis.list
List the KPIs inside one category
Risk: read
Output:
object[]
Output full type
Output full type
kpis.update
kpiCategories.kpis.update
Replace a KPI through its category. Anything left out is reset to its default
Risk: write
Output
list
kpiCategories.list
List the KPI categories on the account
Risk: read
Output:
object[]
Output full type
Output full type
update
kpiCategories.update
Replace a KPI category; anything left out is reset to its default
Risk: write
Output
Kpi Entries
create
kpiEntries.create
Write or update one KPI entry. kpi_id, source_id and entry_date identify it, so the same trio again updates rather than duplicating. A write with every value empty answers stored: false
Risk: write
An upsert on kpi_id, source_id and entry_date. A write with every value empty answers 200 with
{ stored: false }, which the output models alongside the entry shape.
Output: object
Output full type
Output full type
createBatch
kpiEntries.createBatch
Write many KPI entries in one request. It answers 200 even when every row was rejected, so rows_added is the only signal; a batch that stored nothing throws
Risk: write
The route answers 200 even when every row was rejected, so rows_added is the signal. A batch that stored nothing throws rather than reporting success.
entries full type
entries full type
delete
kpiEntries.delete
Delete one KPI entry; this cannot be undone
Risk: destructive · Irreversible
Output
get
kpiEntries.get
Read one KPI entry by id, with its actual, target and notes
Risk: read
Output
list
kpiEntries.list
List KPI entries, filtered by user, KPI, breakdown source and date range; narrow by KPI and dates or the response gets large
Risk: read
All filters are optional, but narrow by kpiId and a date range or the response gets large. Filters are camelCase on this route, unlike the bodies.
Output:
object[]
Output full type
Output full type
update
kpiEntries.update
Change one KPI entry named in the path; the setActual, setTarget and setNotes flags choose which values are written
Risk: write
Output:
object
Output full type
Output full type
Kpi Frequencies
get
kpiFrequencies.get
Read one KPI frequency by its id, such as W for weekly
Risk: read
Output
list
kpiFrequencies.list
List the frequencies a KPI can use: D daily, W weekly, M monthly, Q quarterly, Y yearly
Risk: read
object[]
Output full type
Output full type
Kpi Icons
get
kpiIcons.get
Read one KPI icon by id, which is what a KPI sends as icon_id
Risk: read
Output
list
kpiIcons.list
List the icons a KPI can use, which is where a valid icon_id comes from
Risk: read
object[]
Output full type
Output full type
Kpis
create
kpis.create
Create a KPI. icon_id and unit_id must be real ids from kpiIcons and kpiUnits even though the contract does not mark them mandatory
Risk: write
icon_id and unit_id must be real ids: the contract does not mark them mandatory, but the API validates them and a missing one becomes 0, which fails with a 400.
Output
delete
kpis.delete
Delete a KPI and every entry recorded against it; this cannot be undone
Risk: destructive · Irreversible
Output
get
kpis.get
Read one KPI by id, with its frequency, unit, icon, value direction and aggregate function
Risk: read
Output
list
kpis.list
List the KPIs on the account with their frequency, unit, icon, value direction and aggregate function; page until a page comes back short
Risk: read
Output:
object[]
Output full type
Output full type
update
kpis.update
Replace a KPI wholesale. Anything left out is reset to its default rather than kept, so read it first and send it back changed
Risk: write
PUT replaces the whole object. A field left out is reset to its default, not kept, so read the KPI first and send it back changed.
Output
Kpi Units
create
kpiUnits.create
Create a KPI unit with a numeric entry format and a display format
Risk: write
Both formats use digits and # as placeholders, with comma grouping and one decimal group, such as #,##0.00 or 0.##.
Output
delete
kpiUnits.delete
Delete a KPI unit; KPIs using it are affected, and this cannot be undone
Risk: destructive · Irreversible
Output
get
kpiUnits.get
Read one KPI unit by id, with its entry and display formats
Risk: read
Output
list
kpiUnits.list
List the units a KPI can use, with their entry and display formats
Risk: read
Output:
object[]
Output full type
Output full type
update
kpiUnits.update
Replace a KPI unit; anything left out is reset to its default
Risk: write
Output
Reports
allDataEntries
reports.allDataEntries
Read actuals and targets as one row per KPI, breakdown source and period, already aggregated to each KPI’s own frequency
Risk: read
The kpiIDs filter is sent as a comma separated list, which is how this one route takes an array.
Output:
object[]
Output full type
Output full type
Users
get
users.get
Read one user by id, which is what an entry sends as user_id
Risk: read
Output
list
users.list
List the people on the account with their role and status; read-only, because people are added in the app
Risk: read
Read-only: there is no users:write scope, and people are added and changed in the app.
Output:
object[]
Output full type
Output full type