---
title: "Business Home analytics"
description: "Headline KPIs, bucketed metric time-series, plan mix."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/organization/business-home-analytics"
---
# Business Home analytics

> Headline KPIs, bucketed metric time-series, plan mix.

<api-operation method="GET" path="/v1/businesses/{biz}/analytics">
<template v-slot:docs="">
<warning>

This endpoint is deprecated. It keeps working within its API version.

</warning>

Deprecated. Replaced by `GET /v1/analytics` and `GET /v1/analytics/measures`, which answer the same figures one measure at a time from the same underlying computation. This endpoint keeps answering with an unchanged payload and will only be removed at a version boundary, announced ahead of time.

Powers the business dashboard. Flow metrics (billing, payments, refunds, credit notes, signups, activations, cancellations) are bucketed by timestamp; stock metrics (MRR, CMRR, active subscriptions) are reconstructed from subscription lifecycle dates. Money is either converted into the business default currency via its manual FX rates (`currency=ALL`) or scoped to one currency.

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
</tbody>
</table>

## Query parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        range
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      60 days / 13 weeks / 26 weeks / 12 months of buckets
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        currency
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      <code>
        ALL
      </code>
      
       for the FX-converted roll-up, or a currency code to scope every figure to it
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        business_analytics
      </code>
      
      . One of <code>
        business_analytics
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        business
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The business id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        as_of
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When the figures were computed.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        range
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The selected range. One of <code>
        daily
      </code>
      
      , <code>
        3m
      </code>
      
      , <code>
        6m
      </code>
      
      , <code>
        12m
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        granularity
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The bucket size of the series. One of <code>
        day
      </code>
      
      , <code>
        week
      </code>
      
      , <code>
        month
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        currency
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The currency of the money figures.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        converted
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      True if the figures are converted into <code>
        currency
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        available_currencies
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      Currencies you can select.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        missing_rates
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      Currencies that have no exchange rate and are left out.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        kpis
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      The headline figures.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        windows
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      The calendar windows that the KPIs use.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        series
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The metric time-series.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        subscriptions_by_plan
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      Subscription count per plan.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        mrr_movement_by_plan
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      MRR movement per plan.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Business analytics
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        400
      </code>
    </td>
    
    <td>
      Invalid range
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/analytics" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">
<code-group>

```json [200 OK]
{
  "object": "business_analytics",
  "business": "biz_XXXXXXXXXXXX01",
  "as_of": "2026-03-14T09:30:00Z",
  "range": "12m",
  "granularity": "month",
  "currency": "USD",
  "converted": false,
  "available_currencies": [
    "USD"
  ],
  "missing_rates": [
    "EUR"
  ],
  "kpis": {
    "mrr": {
      "value": 1250000,
      "prev_value": 1180000,
      "change_bps": 593
    },
    "cmrr": {
      "value": 1310000
    },
    "active_subscriptions": {
      "value": 1250000,
      "prev_value": 1180000,
      "change_bps": 593
    },
    "paying_subscriptions": {
      "value": 1250000,
      "prev_value": 1180000,
      "change_bps": 593
    },
    "renewing_subscriptions": {
      "value": 1250000,
      "prev_value": 1180000,
      "change_bps": 593
    },
    "retention": {
      "window_label": "Last 12 months",
      "starting_mrr_minor": 2900,
      "new_mrr_minor": 2900,
      "expansion_mrr_minor": 2900,
      "reactivation_mrr_minor": 2900,
      "contraction_mrr_minor": 2900
    },
    "net_billing_minor": 2900,
    "net_payments_minor": 2900,
    "unpaid_invoices": {
      "count": 1,
      "amount_minor": 2900
    },
    "revenue_this_month": {
      "expected_minor": 2900,
      "received_minor": 2900,
      "last_month_minor": 2900
    },
    "revenue_today": {
      "expected_minor": 2900,
      "received_minor": 2900,
      "yesterday_minor": 2900
    },
    "signups_this_month": {
      "count": 1,
      "last_month": 1
    },
    "signups_today": {
      "count": 1,
      "yesterday": 1
    }
  },
  "windows": {
    "today": {
      "on": "2026-10-21"
    },
    "yesterday": {
      "on": "2026-10-20"
    },
    "this_month": {
      "after": "2026-10-01",
      "before": "2026-10-31"
    },
    "last_month": {
      "after": "2026-09-01",
      "before": "2026-09-30"
    }
  },
  "series": [
    {
      "key": "mrr",
      "label": "MRR",
      "kind": "money",
      "headline": {
        "kind": "money",
        "value": 1250000,
        "prev_value": 1180000,
        "prev_label": "Previous 12 months",
        "change_bps": 593
      },
      "points": [
        {
          "t": "2026-09-01",
          "label": "Sep 2026",
          "v": 1250000
        }
      ]
    }
  ],
  "subscriptions_by_plan": {
    "total": 412,
    "rows": [
      {
        "plan": "Pro",
        "plan_id": "pro",
        "count": 240,
        "pct_bps": 5800
      }
    ]
  },
  "mrr_movement_by_plan": [
    {
      "plan": "Pro",
      "plan_id": "pro",
      "new_mrr_minor": 2900,
      "expansion_mrr_minor": 2900,
      "reactivation_mrr_minor": 2900,
      "contraction_mrr_minor": 2900
    }
  ]
}
```

```json [400 Bad Request]
{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid range"
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.