All key metrics

GET https://api.chartmogul.com/v1/metrics/all

Retrieves all key metrics, for the specified time period.

curl -X GET "https://api.chartmogul.com/v1/metrics/all" \
     -u YOUR_API_KEY: \
     -d start-date=2023-07-01 \
     -d end-date=2023-08-31 \
     -d interval=month \
     -d geo=US \
     -d plans=Silver%20Monthly
ChartMogul::Metrics.all(
  start_date: "2023-07-01",
  end_date: "2023-08-31",
  interval: "month",
  geo: "US",
  plans: "Silver Monthly",
)
ChartMogul.Metrics.all(config, {
  "start-date": "2023-07-01",
  "end-date": "2023-08-31",
  interval: "month",
  geo: "US",
  plans: "Silver Monthly",
});
ChartMogul\Metrics::all([
  "start-date" => "2023-07-01",
  "end-date" => "2023-08-31",
  "interval" => "month",
  "geo" => "US",
  "plans" => "Silver Monthly"
]);
api.MetricsRetrieveAll(&cm.MetricsFilter{
  StartDate: "2023-07-01",
  EndDate:   "2023-08-31",
  Interval:  "month",
  Geo:       "US",
  Plans:     "Silver Monthly",
})
chartmogul.Metrics.all(
  config,
  start_date="2023-07-01",
  end_date="2023-08-31",
  interval="month",
  geo="US",
  plans="Silver Monthly",
)
{
  "entries": [
    {
      "date": "2023-07-31",
      "mrr": 339704639,
      "mrr-percentage-change": 0.0,
      "arr": 4076455668,
      "arr-percentage-change": 0.0,
      "customer-churn-rate": 17.13,
      "customer-churn-rate-percentage-change": 0.0,
      "mrr-churn-rate": 4.92,
      "mrr-churn-rate-percentage-change": 0.0,
      "ltv": 2977624,
      "ltv-percentage-change": 0.0,
      "customers": 666,
      "customers-percentage-change": 0.0,
      "asp": 36650,
      "asp-percentage-change": 0.0,
      "arpa": 510067,
      "arpa-percentage-change": 0.0
    },
    {
      "date": "2023-08-31",
      "mrr": 339495262,
      "mrr-percentage-change": -0.06,
      "arr": 4073943144,
      "arr-percentage-change": -0.06,
      "customer-churn-rate": 3.9,
      "customer-churn-rate-percentage-change": -77.23,
      "mrr-churn-rate": 0.49,
      "mrr-churn-rate-percentage-change": -90.04,
      "ltv": 13392307,
      "ltv-percentage-change": 349.76,
      "customers": 650,
      "customers-percentage-change": -2.4,
      "asp": 152454,
      "asp-percentage-change": 315.97,
      "arpa": 522300,
      "arpa-percentage-change": 2.4
    }
  ],
  "summary": {
    "current-mrr": 346382263,
    "previous-mrr": 345823018,
    "mrr-percentage-change": 0.16,
    "current-arr": 4156587156,
    "previous-arr": 4149876216,
    "arr-percentage-change": 0.16,
    "current-customer-churn-rate": 1.63,
    "previous-customer-churn-rate": 1.81,
    "customer-churn-rate-percentage-change": -9.94,
    "current-mrr-churn-rate": -0.05,
    "previous-mrr-churn-rate": -0.74,
    "mrr-churn-rate-percentage-change": 93.24,
    "current-ltv": 30802147,
    "previous-ltv": 28243922,
    "ltv-percentage-change": 9.06,
    "current-customers": 700,
    "previous-customers": 689,
    "customers-percentage-change": 1.6,
    "current-asp": 15071,
    "previous-asp": 55841,
    "asp-percentage-change": -73.01,
    "current-arpa": 494831,
    "previous-arpa": 501920,
    "arpa-percentage-change": -1.41
  }
}
#<ChartMogul::Metrics::AllKeyMetrics:0x007fa4ec493200 
@entries=[
  #<ChartMogul::Metrics::AllKeyMetric:0x007fa4ec492fa8 
  @date=2023-07-31,
  @mrr=339704639,
  @mrr_percentage_change=0.0,
  @arr=4076455668,
  @arr_percentage_change=0.0,
  @customer_churn_rate=17.13,
  @customer_churn_rate_percentage_change=0.0,
  @mrr_churn_rate=4.92,
  @mrr_churn_rate_percentage_change=0.0,
  @ltv=2977624,
  @ltv_percentage_change=0.0,
  @customers=666,
  @customers_percentage_change=0.0,
  @asp=36650,
  @asp_percentage_change=0.0,
  @arpa=510067,
  @arpa_percentage_change=0.0
  >, 
  #<ChartMogul::Metrics::AllKeyMetric:0x007fa4ec492328 
  @date=2023-08-31,
  @mrr=339495262,
  @mrr_percentage_change=-0.06,
  @arr=4073943144,
  @arr_percentage_change=-0.06,
  @customer_churn_rate=3.9,
  @customer_churn_rate_percentage_change=-77.23,
  @mrr_churn_rate=0.49,
  @mrr_churn_rate_percentage_change=-90.04,
  @ltv=13392307,
  @ltv_percentage_change=349.76,
  @customers=650,
  @customers_percentage_change=-2.4,
  @asp=152454,
  @asp_percentage_change=315.97,
  @arpa=522300,
  @arpa_percentage_change=2.4
  >
],
@summary=
  #<ChartMogul::Summary:0x007fa4ec07dda0
  @current_mrr=346382263,
  @previous_mrr=345823018,
  @mrr_percentage_change=0.16,
  @current_arr=4156587156,
  @previous_arr=4149876216,
  @arr_percentage_change=0.16,
  @current_customer_churn_rate=1.63,
  @previous_customer_churn_rate=1.81,
  @customer_churn_rate_percentage_change=-9.94,
  @current_mrr_churn_rate=-0.05,
  @previous_mrr_churn_rate=-0.74,
  @mrr_churn_rate_percentage_change=93.24,
  @current_ltv=30802147,
  @previous_ltv=28243922,
  @ltv_percentage_change=9.06,
  @current_customers=700,
  @previous_customers=689,
  @customers_percentage_change=1.6,
  @current_asp=15071,
  @previous_asp=55841,
  @asp_percentage_change=-73.01,
  @current_arpa=494831,
  @previous_arpa=501920,
  @arpa_percentage_change=-1.41
>
{
  entries: [
    {
      date: "2023-07-31",
      mrr: 339704639,
      "mrr-percentage-change": 0.0,
      arr: 4076455668,
      "arr-percentage-change": 0.0,
      "customer-churn-rate": 17.13,
      "customer-churn-rate-percentage-change": 0.0,
      "mrr-churn-rate": 4.92,
      "mrr-churn-rate-percentage-change": 0.0,
      ltv: 2977624,
      "ltv-percentage-change": 0.0,
      customers: 666,
      "customers-percentage-change": 0.0,
      asp: 36650,
      "asp-percentage-change": 0.0,
      arpa: 510067,
      "arpa-percentage-change": 0.0
    },
    {
      date: "2023-08-31",
      mrr: 339495262,
      "mrr-percentage-change": -0.06,
      arr: 4073943144,
      "arr-percentage-change": -0.06,
      "customer-churn-rate": 3.9,
      "customer-churn-rate-percentage-change": -77.23,
      "mrr-churn-rate": 0.49,
      "mrr-churn-rate-percentage-change": -90.04,
      ltv: 13392307,
      "ltv-percentage-change": 349.76,
      customers: 650,
      "customers-percentage-change": -2.4,
      asp: 152454,
      "asp-percentage-change": 315.97,
      arpa: 522300,
      "arpa-percentage-change": 2.4
    }
  ],
  "summary": {
    "current-mrr": 346382263,
    "previous-mrr": 345823018,
    "mrr-percentage-change": 0.16,
    "current-arr": 4156587156,
    "previous-arr": 4149876216,
    "arr-percentage-change": 0.16,
    "current-customer-churn-rate": 1.63,
    "previous-customer-churn-rate": 1.81,
    "customer-churn-rate-percentage-change": -9.94,
    "current-mrr-churn-rate": -0.05,
    "previous-mrr-churn-rate": -0.74,
    "mrr-churn-rate-percentage-change": 93.24,
    "current-ltv": 30802147,
    "previous-ltv": 28243922,
    "ltv-percentage-change": 9.06,
    "current-customers": 700,
    "previous-customers": 689,
    "customers-percentage-change": 1.6,
    "current-asp": 15071,
    "previous-asp": 55841,
    "asp-percentage-change": -73.01,
    "current-arpa": 494831,
    "previous-arpa": 501920,
    "arpa-percentage-change": -1.41
  }
}
ChartMogul\Metrics\AllKeyMetrics::__set_state(array(
  "entries" => Doctrine\Common\Collections\ArrayCollection::__set_state(array(
    "elements" => array(
      0 => ChartMogul\Metrics\AllKeyMetric::__set_state(array(
        "date" => "2023-07-31",
        "mrr" => 339704639,
        "mrr_percentage_change" => 0.0,
        "arr" => 4076455668,
        "arr_percentage_change" => 0.0,
        "customer_churn_rate" => 17.13,
        "customer_churn_rate_percentage_change" => 0.0,
        "mrr_churn_rate" => 4.92,
        "mrr_churn_rate_percentage_change" => 0.0,
        "ltv" => 29776240,
        "ltv_percentage_change" => 0.0,
        "customers" => 666,
        "customers_percentage_change" => 0.0,
        "asp" => 36650,
        "asp_percentage_change" => 0.0,
        "arpa" => 510067,
        "arpa_percentage_change" => 0.0
      )),
      1 => ChartMogul\Metrics\AllKeyMetric::__set_state(array(
        "date" => "2023-08-31",
        "mrr" => 339495262,
        "mrr_percentage_change" => -0.06,
        "arr" => 4073943144,
        "arr_percentage_change" => -0.06,
        "customer_churn_rate" => 3.9,
        "customer_churn_rate_percentage_change" => -77.23,
        "mrr_churn_rate" => 0.49,
        "mrr_churn_rate_percentage_change" => -90.04,
        "ltv" => 13392307,
        "ltv_percentage_change" => 349.76,
        "customers" => 650,
        "customers_percentage_change" => -2.4,
        "asp" => 152454,
        "asp_percentage_change" => 315.97,
        "arpa" => 522300,
        "arpa_percentage_change" => 2.4
      ))
    )
  )),
  "summary" => ChartMogul\Summary::__set_state(array(
    "current_mrr" => 346382263,
    "previous_mrr" => 345823018,
    "mrr_percentage_change" => 0.16,
    "current_arr" => 4156587156,
    "previous_arr" => 4149876216,
    "arr_percentage_change" => 0.16,
    "current_customer_churn_rate" => 1.63,
    "previous_customer_churn_rate" => 1.81,
    "customer_churn_rate_percentage_change" => -9.94,
    "current_mrr_churn_rate" => -0.05,
    "previous_mrr_churn_rate" => -0.74,
    "mrr_churn_rate_percentage_change" => 93.24,
    "current_ltv" => 30802147,
    "previous_ltv" => 28243922,
    "ltv_percentage_change" => 9.06,
    "current_customers" => 700,
    "previous_customers" => 689,
    "customers_percentage_change" => 1.6,
    "current_asp" => 15071,
    "previous_asp" => 55841,
    "asp_percentage_change" => -73.01,
    "current_arpa" => 494831,
    "previous_arpa" => 501920,
    "arpa_percentage_change" => -1.41
  ))
));
(*chartmogul.MetricsResult)(0xc0420c8ba0)({
  Entries: ([]*chartmogul.AllMetrics) (len=23) {
    (*chartmogul.AllMetrics)(0xc04206ea00)({
      Date: (string) (len=10) "2023-07-31",
      Mrr: (float64) 339704639
      MrrPercentageChange: (float64) 0.0,
      Arr: (float64) 4076455668,
      ArrPercentageChange: (float64) 0.0,
      CustomerChurnRate: (float64) 17.13,
      CustomerChurnRatePercentageChange: (float64) 0.0,
      MrrChurnRate: (float64) 4.92,
      MrrChurnRatePercentageChange: (float64) 0.0,
      Ltv: (float64) 29776240,
      LtvPercentageChange: (float64) 0.0,
      Customers: (uint32) 666,
      CustomersPercentageChange: (float64) 0.0,
      Asp: (float64) 36650,
      AspPercentageChange: (float64) 0.0,
      Arpa: (float64) 510067,
      ArpaPercentageChange: (float64) 0.0
    }),
    (*chartmogul.AllMetrics)(0xc04206ea50)({
      Date: (string) (len=10) "2023-08-31",
      Mrr: (float64) 339495262,
      MrrPercentageChange: (float64) -0.06,
      Arr: (float64) 4073943144,
      ArrPercentageChange: (float64) -0.06,
      CustomerChurnRate: (float64) 3.9,
      CustomerChurnRatePercentageChange: (float64) -77.23,
      MrrChurnRate: (float64) 0.49,
      MrrChurnRatePercentageChange: (float64) -90.04,
      Ltv: (float64) 13392307,
      LtvPercentageChange: (float64) 349.76,
      Customers: (uint32) 650,
      CustomersPercentageChange: (float64) -2.4,
      Asp: (float64) 152454,
      AspPercentageChange: (float64) 315.97,
      Arpa: (float64) 522300,
      ArpaPercentageChange: (float64) 2.4
    })
  },
  Summary: (*chartmogul.Summary)(0xc0420c6160)({
    CurrentMrr: (float64) 346382263,
    PreviousMrr: (float64) 345823018,
    MrrPercentageChange: (float64) 0.16,
    CurrentArr: (float64) 4156587156,
    PreviousArr: (float64) 4149876216,
    ArrPercentageChange: (float64) 0.16,
    CurrentCustomerChurnRate: (float64) 1.63,
    PreviousCustomerChurnRate: (float64) 1.81,
    CustomerChurnRatePercentageChange: (float64) -9.94,
    CurrentMrrChurnRate: (float64) -0.05,
    PreviousMrrChurnRate: (float64) -0.74,
    MrrChurnRatePercentageChange: (float64) 93.24,
    CurrentLtv: (float64) 30802147,
    PreviousLtv: (float64) 28243922,
    LtvPercentageChange: (float64) 9.06,
    CurrentCustomers: (uint32) 700,
    PreviousCustomers: (uint32) 689,
    CustomersPercentageChange: (float64) 1.6,
    CurrentAsp: (float64) 15071,
    PreviousAsp: (float64) 55841,
    AspPercentageChange: (float64) -73.01,
    CurrentArpa: (float64) 494831,
    PreviousArpa: (float64) 501920,
    ArpaPercentageChange: (float64) -1.41
  })
})
Metrics(
  entries=[
    <Metrics{
      date=datetime.date(2023, 7, 31),
      mrr=339704639,
      mrr_percentage_change=0.0,
      arr=4076455668,
      arr_percentage_change=0.0,
      customer_churn_rate=17.13,
      customer_churn_rate_percentage_change=0.0,
      mrr_churn_rate=4.92,
      mrr_churn_rate_percentage_change=0.0,
      ltv=2977624,
      ltv_percentage_change=0.0,
      customers=666,
      customers_percentage_change=0.0,
      asp=36650,
      asp_percentage_change=0.0,
      arpa=510067,
      arpa_percentage_change=0.0
    }>, 
    <Metrics{
      date=datetime.date(2023, 8, 31),
      mrr=339495262,
      mrr_percentage_change=-0.06,
      arr=4073943144,
      arr_percentage_change=-0.06,
      customer_churn_rate=3.9,
      customer_churn_rate_percentage_change=-77.23,
      mrr_churn_rate=0.49,
      mrr_churn_rate_percentage_change=-90.04,
      ltv=13392307.0,
      ltv_percentage_change=349.76,
      customers=650.0,
      customers_percentage_change=-2.4,
      asp=152454.0,
      asp_percentage_change=315.97,
      arpa=522300.0
      arpa_percentage_change=2.4
    }>
  ],
  summary=<Summary{
    current_mrr=346382263,
    previous_mrr=345823018,
    percentage_change=0.16,
    current_arr=4156587156,
    previous_arr=4149876216,
    arr_percentage_change=0.16,
    current_customer_churn_rate=1.63,
    previous_customer_churn_rate=1.81,
    customer_churn_rate_percentage_change=-9.94,
    current_mrr_churn_rate=-0.05,
    previous_mrr_churn_rate=-0.74,
    mrr_churn_rate_percentage_change=93.24,
    current_ltv=30802147,
    previous_ltv=28243922,
    ltv_percentage_change=9.06,
    current_customers=700,
    previous_customers=689,
    customers_percentage_change=1.6,
    current_asp=15071,
    previous_asp=55841,
    asp_percentage_change=-73.01,
    current_arpa=494831,
    previous_arpa=501920,
    arpa_percentage_change=-1.41
  }>
)

Query parameters

start-date datetime required
The start date of the required period of data. An ISO-8601 formatted date, e.g. 2015-05-12
end-date datetime required
The end date of the required period of data. An ISO-8601 formatted date, e.g. 2015-05-12
interval string default: "month"
One of day, week, or month
geo string
A comma-separated list of ISO 3166-1 Alpha-2 formatted country codes to filter the results to, e.g. US,GB,DE.
plans string
A comma-separated list of plan names (as configured in your ChartMogul account), UUIDs and external IDs to filter the results. Spaces in plan names must be URL-encoded (e.g., Silver%20plan,Gold%20plan,Enterprise%20plan). Plan UUIDs are accepted with or without the pl_ prefix (e.g., pl_ca7565ce-1973-9351-11ee-9f34ab5816d8,b35fdb9e-1ca2-11ee-90be-6f197565b760). Plan names and IDs are case-sensitive. You can mix plan names, UUIDs and external IDs in a single string, (e.g., Silver%20plan,pl_ca7565ce-1973-9351-11ee-9f34ab5816d8,gold_plan).

Response

In the response, entries contains an object for each interval, with the following data:

date
the end date of each interval period.
mrr
The Monthly Recurring Revenue (MRR) as at the end of the interval. Divide it by 100 to obtain the actual value.
mrr-percentage-change
The percentage change between the current MRR and MRR from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
arr
the Annual Run Rate (ARR) as at the end of each interval period. This is in your account's selected currency and is an integer number of cents. Divide it by 100 to obtain the actual value.
arr-percentage-change
The percentage change between the current ARR and ARR from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
customer-churn-rate
The customer churn rate at the end of that month, expressed as a percentage.
customer-churn-rate-percentage-change
The percentage change between the current customer churn rate and customer churn rate from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
mrr-churn-rate
The Net MRR churn rate at the end of that month, expressed as a percentage.
mrr-churn-rate-percentage-change
The percentage change between the current mrr churn rate and mrr churn rate from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
ltv
The Customer LTV as at the end of the month. This is in your account's selected currency and is a number of cents. Divide it by 100 to obtain the actual value.
ltv-percentage-change
The percentage change between the current LTV and LTV from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
customers
The number of active customers in your account as at the end of the interval.
customers-percentage-change
The percentage change between the current active customers and active customers from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
asp
The Average Sale Price(ASP) as at the end of the period. This is in your account's selected currency and is an integer number of cents. Divide it by 100 to obtain the actual value.
asp-percentage-change
The percentage change between the current ASP and ASP from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
arpa
The Average Revenue Per Account (ARPA) as at the end of the period. This is in your account's selected currency and is an integer number of cents. Divide it by 100 to obtain the actual value.
arpa-percentage-change
The percentage change between the current ARPA and ARPA from the previous time interval. Will be set to 0.0 if this is the first entry in the response.

All amounts are given in the selected currency of your account and are an integer number of cents. Divide by 100 to obtain the actual value.

The summary key contains the following details:

mrr
The current MRR value, the value 30 days ago, and the percentage change between these two measures.
arr
The current ARR value, the value 30 days ago, and the percentage change between these two measures.
customer-churn-rate
The last month's Customer Churn Rate value, the value a month before that, and the percentage change between these two measures.
mrr-churn-rate
The last month's MRR Churn Rate value, the value a month before that, and the percentage change between these two measures.
ltv
The last month's LTV, the LTV a month before that, and the percentage change between these two measures.
customers
The current active customers value, the value 30 days ago, and the percentage change between these two measures.
arpa
The current ARPA, the value 30 days ago, and the percentage change between these two measures.
asp
The current ASP, the value 30 days ago, and the percentage change between these two measures.