Retrieve an account's KPIs

Returns the account’s revenue and order counters, under account_kpis.

GET /accounts/{account_id}/kpis

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/accounts/ACC0001/kpis" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "account_kpis": {
    "object": "<string>",
    "total_revenue": "<string>",
    "monthly_recurring_revenue": "<string>",
    "total_collected": "<string>",
    "total_refunded": "<string>",
    "total_outstanding": "<string>",
    "total_overdue": "<string>",
    "total_balance": "<string>",
    "total_credit_balance": "<string>",
    "total_orders": 123,
    "active_orders": 123,
    "last_reactivated_at": "<unknown>",
    "last_cancelled_at": "<unknown>",
    "deleted_at": "<unknown>",
    "computed_at": "<string>"
  }
}

Returns totals such as total_revenue, total_outstanding and total_orders. Money values are strings, such as 0.00; the order counts are integers.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

account_id · string · required

The account's id, such as ACC0001. Not its uuid.

Response

200 - application/json

The counters, under account_kpis.

account_kpis · object

The account's revenue and order counters. Money values are strings, such as 0.00.

Show child attributes