Customer base page datasets

Key figures (active accounts, ARPA, NRR, GRR), net and gross revenue retention per month, the cohort triangle, customer concentration, account movements, lost MRR by cancellation reason and the segment comparison (all accounts, segmentId, compareSegmentId). Accounts are the accounts of the movement scope; a segment selects accounts by their customer.

Required permission: analytics:read.

GET /api/analytics/finance/customers

Customer base page datasets

cURL

curl --request GET \
  --url https://coreapi.io/api/analytics/finance/customers \
  --header 'Authorization: Bearer <token>'

200

{
  "tenantName": "<string>",
  "currency": "<string>",
  "asOf": "2023-11-07T05:31:56Z",
  "months": [
    "<string>"
  ],
  "customers": {
    "kpis": [
      {
        "id": "mrr",
        "title": "MRR",
        "valueKind": "money",
        "value": "12500.00",
        "delta": "250.00",
        "better": "up",
        "sparkline": [
          "<string>"
        ],
        "caption": "<string>",
        "asOfMonth": "2026-08",
        "monthComplete": true,
        "current": {
          "asOfMonth": "2026-09",
          "value": "5279.33",
          "delta": "1916.00",
          "monthComplete": false
        }
      }
    ],
    "retention": [
      {
        "month": "<string>",
        "nrr": "<string>",
        "grr": "<string>",
        "cohortAccounts": 123,
        "cohortMrr": "<string>"
      }
    ],
    "cohorts": [
      {
        "cohort": "<string>",
        "accounts": 123,
        "startMrr": "<string>",
        "cells": [
          {
            "age": 123,
            "month": "<string>",
            "mrr": "<string>",
            "retention": "<string>"
          }
        ]
      }
    ],
    "concentration": {
      "month": "<string>",
      "total": "<string>",
      "segments": [
        {
          "key": "top1",
          "label": "<string>",
          "amount": "<string>",
          "share": "<string>",
          "accounts": 123
        }
      ],
      "top1Share": "<string>",
      "top5Share": "<string>",
      "top10Share": "<string>",
      "above5Count": 123,
      "top": [
        {
          "rank": 123,
          "customer": {
            "id": "<string>",
            "number": "<string>",
            "name": "<string>"
          },
          "mrr": "<string>",
          "share": "<string>",
          "change": "<string>"
        }
      ]
    },
    "logos": [
      {
        "month": "<string>",
        "new": 123,
        "resurrecting": 123,
        "lost": 123,
        "net": 123,
        "activeEop": 123
      }
    ],
    "churnReasons": {
      "total": "<string>",
      "accounts": 123,
      "entries": [
        {
          "code": "<string>",
          "label": "<string>",
          "amount": "<string>",
          "accounts": 123,
          "share": "<string>"
        }
      ]
    },
    "segmentMetrics": [
      {
        "id": "<string>",
        "name": "<string>",
        "mrr": "<string>",
        "nrr": "<string>",
        "grr": "<string>",
        "churnRate": "<string>",
        "arpa": "<string>",
        "newAccounts": 123,
        "activeAccounts": 123
      }
    ]
  },
  "granularity": "month",
  "segmentComparable": [
    "<string>"
  ],
  "meta": {
    "asOf": "2023-11-07T05:31:56Z",
    "buildId": "<string>",
    "scope": "invoice_address",
    "currency": "EUR",
    "from": "2025-10",
    "to": "2026-09",
    "findings": {
      "error": 0,
      "warning": 3,
      "info": 12
    },
    "filtersNotApplied": [
      "<string>"
    ],
    "notSnapshotted": [
      "one_off",
      "accounted_mrr",
      "cash_collected"
    ],
    "projectedFrom": "2026-10",
    "forecast": {
      "incomplete": false,
      "failedSubscriptions": 0
    },
    "build": {
      "status": "failed",
      "builtAt": "2023-11-07T05:31:56Z",
      "buildId": "<string>",
      "failed": {
        "invariants": [
          "CASH_WITHIN_DOCUMENT"
        ],
        "rowCount": 5,
        "invoiceRowCount": 5
      }
    },
    "dataBuildId": "<string>"
  }
}

Autorisierungen

Authorization · string · header · erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Abfrageparameter

from · string

First month (YYYY-MM, time zone of the organisation). Default: to minus 11 months.

to · string

Last month (YYYY-MM). Default: the current month. At most 36 months.

currency · string

ISO-4217 code. Default: the default currency.

scope · enum<string>

Movement scope. Default: the organisation setting.

Verfügbare Optionen: subscription, invoice_address, customer, organisation

segmentId · string<uuid>

Analytics segment: only its customers.

compareSegmentId · string<uuid>

Second analytics segment for the comparison.

granularity · enum<string>

Cohorts per month (default) or per quarter.

Verfügbare Optionen: month, quarter

Antwort

200

application/json

The datasets.

Customer base page: key figures, retention, cohorts, concentration, account movements, churn by reason and segment comparison.

tenantName · string

Name of the organisation.

currency · string

Currency of every amount (ISO-4217).

asOf · string<date-time> | null

Calculation time; null before the first calculation.

months · string[]

Months of the range (YYYY-MM), ascending.

customers · object

The datasets.

Show child attributes

granularity · enum<string>

Cohort granularity.

Verfügbare Optionen: month, quarter

segmentComparable · string[]

Fields of segmentMetrics that compare across segments of different size (rates and ARPA).

meta · object

Calculation time, scope, currency, findings, filters not applied.

Show child attributes