Any other system
Bring data from any other system into Meerkats, and read Meerkats data from your own tools, over the API.
If a system isn't listed, you can still connect it. Send its data to Meerkats as rows or events, and it joins the same business context as everything else: it gets a metric definition, agents read it, and rules can watch it. In the other direction, your own tools can read Meerkats metrics, manage rules and approve actions through the API.
| How it connects | Meerkats API |
| Reads | Rows or events you send, Metrics you read |
| Can change | Create, update, enable, disable or delete a rule; Approve or reject a proposal; Run an agent now |
| Refresh | On your plan's schedule, plus Resync anytime |
Before you start#
- An app under Apps in your account menu, with an API key. Keys are scoped to the workspaces you choose and to read or write.
- A developer who can send JSON over HTTPS.
Permissions#
What Meerkats needs, and why.
| Permission | Why Meerkats needs it |
|---|---|
X-API-Key (read scope) | Read metrics, rules, agents and sync status for the key's workspaces |
X-API-Key (write scope) | Create and change rules, approve or reject proposals, run agents, and send data |
Connect#
1. Create an app and key#
- Open Apps
Select your name at the bottom of the sidebar, then Apps. Select Create app.
- Issue a key
Inside the app, create an API key, choose read or write scope, and pick the workspaces it may access. Copy the key; Meerkats shows it once.
- Make a first call
Call
GET /workspaceswith theX-API-Keyheader to list the workspaces the key can see. The API overview has the full reference.
What syncs#
| Any other system | In Meerkats |
|---|---|
| Rows or events you send | Stored under a source name you choose, with the schema you send; available to metrics, agents and rules |
| Metrics you read | Any metric in the catalog, grouped by any of its dimensions, via `POST /metrics/query` |
Raw data lands in Data Hub › Bronze Layer. Modelled tables, with metrics defined once, are in Data Hub › Gold Layer. Every number in a report or an agent’s answer comes from a query on these tables, never from the model’s own arithmetic.
How often it syncs#
Meerkats syncs on your plan's schedule: daily on Free, hourly on the $49 plan, every 30 minutes on $149 and every 15 minutes on $399. You can run a sync at any time with Resync in Data Hub › Bronze Layer.
- Data you send is available to agents on the next run. The API allows 120 requests a minute per key by default.
What Meerkats can change#
In every connected tool, Meerkats can create, read, update and delete records, within the permissions you grant and the permissions the tool allows. These are the changes it proposes for Any other system, and the limit that applies to each.
| Change | Limit |
|---|---|
| Create, update, enable, disable or delete a rule | Needs write scope; rules default to proposing for approval |
| Approve or reject a proposal | Needs write scope; recorded with the key's app as the actor |
| Run an agent now | Needs write scope; uses credits |
How every change is governed
Every change starts as a proposal in your Inbox. Nothing changes in the connected tool until a person approves it, unless you set that rule to act on its own.
Before it runs an approved change, Meerkats re-reads the live value. If the value moved since the proposal, it asks again instead of acting on stale data.
Meerkats stores the value it replaced, so every change can be undone from Agents run history.
Anything Meerkats creates starts paused. Switching it on is a second, separate approval.
Troubleshooting#
403 Forbidden
The key lacks the scope (read vs write) or the workspace isn't in the key's allowed list. Check the key under Apps.
429 Too Many Requests
You passed the per-key limit (120 a minute by default). Back off and retry; the limit can be raised per key.