GoRunner docs
Search or askSearch⌘K

Get an account’s usage

GET/api/embed/v1/accounts/{accountId}/usage

Returns one account’s usage over a range of days.

Needs a partner key: Authorization: Bearer gre_…, from Platform › Partner keys. Call it from your server only.

Embed · Self-hosted with an Embed license

Parameters

Path

accountIdRequired · string

Your ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain /.

Query

fromRequired · string

The first UTC day counted, YYYY-MM-DD.

toRequired · string

The last UTC day counted, included. Not after today, and at most 366 days with from.

What is counted

runs: production runs by the UTC day they started, a sub-flow’s counted with the run that called it. testRuns: the customer’s test runs. assistantTokens: the Keel tokens it used that the installation pays for.

Counts never shrink when runs are deleted. They are added up every few minutes: asOf says when.

Responses

  • 200OK

    The account’s usage.

  • from or to is missing or out of range.

  • You have no account with this ID.

  • Something failed on the installation’s side. Try again.

Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 429 RATE_LIMITED · 503 BUSY. See Errors.

Request

GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY"  # gre_…
ACCOUNT_ID="acct-bakery"

URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}usage?from=2026-10-01&to=2026-10-25"
curl "$URL" \
  -H "Authorization: Bearer $GORUNNER_EMBED_KEY"

Response · 200 OK

json
{
  "data": {
    "account": {
      "id": "acct-bakery",
      "name": "Bakery Ltd"
    },
    "from": "2026-10-01",
    "to": "2026-10-25",
    "runs": {
      "worked": 480,
      "failed": 30,
      "held": 1,
      "cancelled": 2,
      "inProgress": 1,
      "total": 514
    },
    "testRuns": 41,
    "assistantTokens": 182300,
    "asOf": "2026-10-25T08:55:00Z"
  }
}
Every field

It takes no body.

Response · 200 OK

dataobject
accountobject
idstring
namestring
fromstring
tostring
runsobject

Production runs by the UTC day they started. total is the sum of the other five.

workedinteger
failedinteger
heldinteger
cancelledinteger
inProgressinteger
totalinteger
testRunsinteger

Runs started from the editor to test, counted apart.

assistantTokensinteger

Assistant tokens the installation paid for.

asOftime or null

When the counts were last rolled up (every 5 minutes); null until the first count after the embed license arrives has finished.