The SimpleKPI API lets you read and write your data programmatically — push entries from your own systems, pull KPIs into a warehouse, or wire up a custom integration. Access is controlled by API keys you create and manage yourself.

Create an API key

Each key carries its own name, an optional expiry, and a set of per-resource permissions, so you can scope a key tightly to what it needs.

  1. Go to Settings → API Access and click Create API Key.
  2. Give the key a name that says where it's used, e.g. "CI/CD Pipeline".
  3. Optionally set an Expiry Date. Leave it blank for no expiry.
  4. For each resource — KPIs, Entries, Users, and Sources — pick a permission of None, Read, or Write. At least one permission is required.
  5. Click Create API Key.

Copy your key

The key is shown once, right after creation. Copy it and store it somewhere safe — a password manager or your deployment secrets. You won't be able to see it again, so if you lose it you'll need to create a new one.

Manage existing keys

The keys table shows each key's name, when it was last used, and when it was created. Hover a key's name to see its permissions and prefix. To revoke a key, click the delete icon in its row — any integration using it will stop working immediately.

Give each integration its own key, scoped to only the resources it touches. If one is ever leaked, you can delete just that key without disrupting anything else. Full endpoint reference lives at support.simplekpi.com/Developers.