Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
kpi

api_insight_checkout_kpis_get

Get a list of kpis where the transactiosn used is in the aggregations are transactions from "event_created_at_gte", until now. However, transactions from the "current" interval are not included.
E.g if week is provided as interval, then no transactions from the current week are included. This is true for day and month intervals aswell.

Scopes:

  • read:insight
  • admin:insight deprecated 2025-05-20
get/accounts/{aid}/insight/kpi/checkout

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Query parameters

interval'day' | 'week' | 'month' required

The interval over which the data will be aggregated.

field'total_amount' required

The field (db column) used as source for the kpi, eg, total_amount, vat etc.

transaction_status'CAPTURED' | 'REFUNDED' | 'AUTHORIZED' required

Only transactions with this status will be included in the aggregation

aggregate_functionsstring required

The functions applied to the data for every interval.

  • The functions should be provided as a stringified array
  • At least one function must be provided, currency must be combined with another function

Available functions:

  • sum
  • avg
  • count
  • currency
event_created_at_gtestring

Transaction events with created_at date at or later than this date will be included in the aggregations.
If this date parameter is not included, all transactions regardless of creation date are included.
NB! This is not the transactions created_at date, this is the date the event was created (e.g AUTHORIZE, CAPTURE etc..)

Response

Checkout KPIs

kpi_name'avg' | 'sum' | 'count' required

Example response

[
  {
    "values": [
      {
        "currency": "NOK"
      }
    ]
  }
]