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=2015-01-01 \
     -d end-date=2015-11-01
ChartMogul::Metrics.customer_churn_rate(start_date: '2015-01-01', end_date: '2015-11-01')
ChartMogul.Metrics.customerChurnRate(config, {
   'start-date': '2015-01-01',
   'end-date': '2015-11-01'
}, function (err, res) {
   // asynchronously called
});
<?php

ChartMogul\Metrics::customerChurnRate([
    "start-date" => "2015-01-01",
    "end-date" => "2015-11-01",
]);
?>
api.MetricsRetrieveCustomerChurnRate(&cm.MetricsFilter{
        StartDate: "2016-01-01",
        EndDate:   "2016-03-12",
        Interval:  "month",
    Geo:             "GB",
    Plans:       "PRO Plan",
    })
chartmogul.Metrics.customer_churn_rate(
    config,
    start_date="2016-01-01",
    end_date="2016-03-12",
    interval="month",
      geo="GB",
        plans="PRO Plan")
Result Format
{
  "entries":[
    {
      "date":"2015-01-31",
      "customer-churn-rate":9.8
    },
    {"...more...": "...entries..."}
  ],
  "summary":{
    "current":9.8,
    "previous":8.5,
    "percentage-change":2
  }
}
#<ChartMogul::Metrics::CustomerChurnRates:0x007faf03d088d8 
@entries=[
  #<ChartMogul::Metrics::CustomerChurnRate:0x007faf03d08680 
  @date=2015-01-31, 
  @customer_churn_rate=9.8
  >, 
  <...more entries...>
], 
@summary=
  #<ChartMogul::Summary:0x007faf03d01038
  @current=9.8,
  @previous=8.5,
  @percentage_change=2.0
  >
>
{
  "entries":[
    {
      "date":"2015-01-31",
      "customer-churn-rate":9.8
    },
    {"...more...": "...entries..."}
  ],
  "summary":{
    "current":9.8,
    "previous":8.5,
    "percentage-change":2
  }
}
<?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" => "2015-01-31",
         "customer_churn_rate" => 9.8,
      )),
      1 => ...
  ))),
   "summary" => 
  ChartMogul\Summary::__set_state(array(
     "current" => 9.8,
     "previous" => 8.5,
     "percentage_change" => 2,
  )),
?>
(*chartmogul.CustomerChurnRateResult)(0xc0420b2f00)({
 Entries: ([]*chartmogul.CustomerChurnRateMetrics) (len=3) {
  (*chartmogul.CustomerChurnRateMetrics)(0xc0420b3320)({
   Date: (string) (len=10) "2016-01-31",
   CustomerChurnRate: (float64) 0
  }),
  (*chartmogul.CustomerChurnRateMetrics)(0xc0420b33a0)({
   Date: (string) (len=10) "2016-02-29",
   CustomerChurnRate: (float64) 0
  }),
  (*chartmogul.CustomerChurnRateMetrics)(0xc0420b33c0)({
   Date: (string) (len=10) "2016-03-12",
   CustomerChurnRate: (float64) 0
  })
 },
 Summary: (*chartmogul.Summary)(0xc0420b33e0)({
  Current: (float64) 0,
  Previous: (float64) 0,
  PercentageChange: (float64) 0
 })
})
Metrics(entries=[
    <Metrics{
        customer_churn_rate=0.0, 
        date=datetime.date(2016, 1, 31)}>, 
    <Metrics{
        customer_churn_rate=0.0, 
        date=datetime.date(2016, 2, 29)}>, 
    <Metrics{
        customer_churn_rate=0.0, 
        date=datetime.date(2016, 3, 12)}>], 
summary=<Summary{
    current=0.0, 
    percentage_change=0.0, 
    previous=0.0}>)

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.

The summary key contains the current Customer Churn Rate value, the value a month ago, and the percentage change between these two measures.

Language
Authentication
Basic
base64
: