Retrieve Customer Churn Rate

Retrieves the Customer Churn Rate, for the specified time period.

Examples
curl -X GET "https://api.chartmogul.com/v1/metrics/customer-churn-rate" \
     -u YOUR_API_KEY: \
     -d start-date=2023-07-01 \
     -d end-date=2023-08-31 \
     -d geo=US \
     -d plans=Silver%20Monthly
ChartMogul::Metrics.customer_churn_rate(
  start_date: '2023-07-01',
  end_date: '2023-08-31',
  geo: 'US',
  plans: 'Silver Monthly')
ChartMogul.Metrics.customerChurnRate(config, {
   "start-date": "2023-07-01",
   "end-date": "2023-08-31",
   "geo": "US",
   "plans": "Silver Monthly"
});
<?php

ChartMogul\Metrics::customerChurnRate([
    "start-date" => "2023-07-01",
    "end-date" => "2023-08-31",
    "geo" => "US",
    "plans" => "Silver Monthly"
]);
?>
api.MetricsRetrieveCustomerChurnRate(&cm.MetricsFilter{
		StartDate: "2023-07-01",
		EndDate:   "2023-08-31",
		Geo: "US",
		Plans: "Silver Monthly",
	})
chartmogul.Metrics.customer_churn_rate(
    config,
    start_date="2023-07-01",
    end_date="2023-08-31",
    geo="US",
    plans="Silver Monthly")
Result Format
{
  "entries":[
    {
      "date": "2023-07-31",
      "customer-churn-rate": 8.5,
      "percentage-change": 0.0
    },
    {
      "date": "2023-08-31",
      "customer-churn-rate": 9.8,
      "percentage-change": 2.0
    }
  ],
  "summary":{
    "current": 9.8,
    "previous": 8.5,
    "percentage-change": 2.0
  }
}
#<ChartMogul::Metrics::CustomerChurnRates:0x007faf03d088d8 
@entries=[
  #<ChartMogul::Metrics::CustomerChurnRate:0x007faf03d08680 
  @date=2023-07-31, 
  @customer_churn_rate=8.5,
  @percentage_change=0.0
  >, 
  #<ChartMogul::Metrics::CustomerChurnRate:0x007faf03d08680 
  @date=2023-08-31, 
  @customer_churn_rate=9.8,
  @percentage_change=2.0
  >
], 
@summary=
  #<ChartMogul::Summary:0x007faf03d01038
  @current=9.8,
  @previous=8.5,
  @percentage_change=2.0
  >
>
{
  "entries":[
    {
      "date": "2023-07-31",
      "customer-churn-rate": 8.5,
      "percentage-change": 0.0
    },
    {
      "date": "2023-08-31",
      "customer-churn-rate": 9.8,
      "percentage-change": 2.0
    }
  ],
  "summary":{
    "current": 9.8,
    "previous": 8.5,
    "percentage-change": 2.0
  }
}
<?php

ChartMogul\Metrics\CustomerChurnRates::__set_state(array(
   "entries" => 
  Doctrine\Common\Collections\ArrayCollection::__set_state(array(
     "elements" => 
    array (
      0 => 
      ChartMogul\Metrics\CustomerChurnRate::__set_state(array(
         "date" => "2023-07-31",
         "customer_churn_rate" => 8.5,
         "percentage_change" => 0.0
      )),
      ChartMogul\Metrics\CustomerChurnRate::__set_state(array(
         "date" => "2023-08-31",
         "customer_churn_rate" => 9.8,
         "percentage_change" => 2.0
      ))
  ))),
   "summary" => 
  ChartMogul\Summary::__set_state(array(
     "current" => 9.8,
     "previous" => 8.5,
     "percentage_change" => 2.0
  )),
?>
(*chartmogul.CustomerChurnRateResult)(0xc0420b2f00)({
 Entries: ([]*chartmogul.CustomerChurnRateMetrics) (len=2) {
  (*chartmogul.CustomerChurnRateMetrics)(0xc0420b3320)({
   Date: (string) (len=10) "2023-07-31",
   CustomerChurnRate: (float64) 8.5,
   PercentageChange: (float64) 0
  }),
  (*chartmogul.CustomerChurnRateMetrics)(0xc0420b33a0)({
   Date: (string) (len=10) "2023-08-31",
   CustomerChurnRate: (float64) 9.8,
   PercentageChange: (float64) 2
  })
 },
 Summary: (*chartmogul.Summary)(0xc0420b33e0)({
  Current: (float64) 0,
  Previous: (float64) 0,
  PercentageChange: (float64) 0
 })
})
Metrics(entries=[
    <Metrics{
        customer_churn_rate=8.5,
        percentage_change=0.0, 
        date=datetime.date(2023, 7, 31)}>, 
    <Metrics{
        customer_churn_rate=9.8, 
        percentage_change=2.0, 
        date=datetime.date(2023, 8, 31)}>], 
summary=<Summary{
    current=9.8, 
    percentage_change=2.0, 
    previous=8.5}>)

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

  • date - The date of the end of the month
  • customer-churn-rate - The customer churn rate at the end of that month, expressed as a percentage.
  • 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.

The summary key contains the last month's Customer Churn Rate value, the value a month before that, and the percentage change between these two measures.

Language
Authorization
Basic
base64
: