Retrieve all key metrics

Retrieves all key metrics, for the specified time period.

Examples
curl -X GET "https://api.chartmogul.com/v1/metrics/all" \
     -u YOUR_API_KEY:
     -d start-date=2015-01-01 \
     -d end-date=2015-11-24 \
     -d interval=month \
     -d geo=GB \
     -d plans=PRO%20Plan
ChartMogul::Metrics.all(start_date: '2015-01-01', end_date: '2015-11-24', interval: 'month', geo: 'GB', plans: 'PRO Plan')
ChartMogul.Metrics.all(config, {
   'start-date': '2015-01-01',
   'end-date': '2015-11-24',
   'interval': 'month',
   'geo': 'GB',
   'plans': 'PRO Plan'
}, function (err, res) {
   // asynchronously called
});
<?php

ChartMogul\Metrics::all([
    "start-date" => "2015-01-01",
    "end-date" => "2015-11-24",
    "interval" => "month",
    "geo" => "GB",
    "plans" => "PRO Plan"
]);
?>
api.MetricsRetrieveAll(&cm.MetricsFilter{
        StartDate: "2016-01-01",
        EndDate:   "2016-03-24",
        Interval:  "month",
        Geo:       "GB",
        Plans:     "PRO Plan",
    })
chartmogul.Metrics.all(
    config,
    start_date="2016-01-01",
    end_date="2016-02-29",
    interval="month",
      geo="GB",
        plans="PRO Plan")
Result Format
{
  "entries":[
    {
      "date":"2015-01-31",
      "customer-churn-rate":20,
      "mrr-churn-rate":14,
      "ltv":1250.3,
      "customers":331,
      "asp":125,
      "arpa":1250,
      "arr":254000,
      "mrr":21166
    },
    {
      "date":"2015-02-28",
      "customer-churn-rate":20,
      "mrr-churn-rate":22,
      "ltv":1248,
      "customers":329,
      "asp":125,
      "arpa":1250,
      "arr":238000,
      "mrr":21089
    },
    {"...more...": "...entries..."}
  ]
}
#<ChartMogul::Metrics::AllKeyMetrics:0x007fa4ec493200 
@entries=[
  #<ChartMogul::Metrics::AllKeyMetric:0x007fa4ec492fa8 
  @date=2015-01-31,
  @customer_churn_rate=20,
  @mrr_churn_rate=14,
  @ltv=1250.3,
  @customers=331,
  @asp=125,
  @arpa=1250,
  @arr=254000,
  @mrr=21166
  >, 
  #<ChartMogul::Metrics::AllKeyMetric:0x007fa4ec492328 
  @date=2015-02-28,
  @customer_churn_rate=20,
  @mrr_churn_rate=22,
  @ltv=1248,
  @customers=329,
  @asp=125,
  @arpa=1250,
  @arr=238000,
  @mrr=21089
  >, 
  <...more entries...>
]
>
{
  "entries":[
    {
      "date":"2015-01-31",
      "customer-churn-rate":20,
      "mrr-churn-rate":14,
      "ltv":1250.3,
      "customers":331,
      "asp":125,
      "arpa":1250,
      "arr":254000,
      "mrr":21166
    },
    {
      "date":"2015-02-28",
      "customer-churn-rate":20,
      "mrr-churn-rate":22,
      "ltv":1248,
      "customers":329,
      "asp":125,
      "arpa":1250,
      "arr":238000,
      "mrr":21089
    },
    {"...more...": "...entries..."}
  ]
}
<?php

ChartMogul\Metrics\AllKeyMetrics::__set_state(array(
    "entries" => 
  Doctrine\Common\Collections\ArrayCollection::__set_state(array(
     "elements" => 
    array (
      0 => 
      ChartMogul\Metrics\AllKeyMetric::__set_state(array(
         "date" => "2015-01-31",
         "arpa" => 1250,
         "arr" => 254000,
         "asp" => 125,
         "customer_churn_rate" => 20,
         "customers" => 331,
         "ltv" => 1250.3,
         "mrr" => 21166,
         "mrr_churn_rate" => 14,
      )),
      1 => ...
  )))
));
?>
(*chartmogul.MetricsResult)(0xc0420c8ba0)({
 Entries: ([]*chartmogul.AllMetrics) (len=23) {
  (*chartmogul.AllMetrics)(0xc04206ea00)({
   Date: (string) (len=10) "2016-01-31",
   CustomerChurnRate: (float64) 0,
   MrrChurnRate: (float64) 66.67,
   Ltv: (float64) 0,
   Customers: (uint32) 1,
   Asp: (float64) 0,
   Arpa: (float64) 4100,
   Arr: (float64) 49200,
   Mrr: (float64) 4100
  }),
  (*chartmogul.AllMetrics)(0xc04206ea50)({
   Date: (string) (len=10) "2016-02-29",
   CustomerChurnRate: (float64) 0,
   MrrChurnRate: (float64) 0,
   Ltv: (float64) 0,
   Customers: (uint32) 1,
   Asp: (float64) 0,
   Arpa: (float64) 4100,
   Arr: (float64) 49200,
   Mrr: (float64) 4100
  }),
  (*chartmogul.AllMetrics)(0xc04206f130)({
   Date: (string) (len=10) "2016-03-24",
   CustomerChurnRate: (float64) 0,
   MrrChurnRate: (float64) 0,
   Ltv: (float64) 0,
   Customers: (uint32) 0,
   Asp: (float64) 0,
   Arpa: (float64) 0,
   Arr: (float64) 0,
   Mrr: (float64) 0
  })
 }
})
Metrics(entries=[
    <Metrics{
        arpa=4100.0, 
        arr=49200.0, 
        asp=0.0, 
        customer_churn_rate=0.0, 
        customers=1.0, 
        date=datetime.date(2016, 1, 31), 
        ltv=0.0, 
        mrr=4100.0, 
        mrr_churn_rate=66.67}>, 
    <Metrics{
        arpa=4100.0, 
        arr=49200.0, 
        asp=0.0, 
        customer_churn_rate=0.0, 
        customers=1.0, 
        date=datetime.date(2016, 2, 29), 
        ltv=0.0, 
        mrr=4100.0, 
        mrr_churn_rate=0.0}>
])

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

  • date - the end date of each interval period.
  • customer-churn-rate - The customer churn rate at the end of that month, expressed as a percentage.
  • mrr-churn-rate - The Net MRR churn rate at the end of that month, expressed as a percentage.
  • 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.
  • customers - The number of active customers in your account as at the end of the interval.
  • asp - The 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.
  • arpa - The 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.
  • arr - the Annual Recurring Revenue 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.
  • mrr - The Monthly Recurring Revenue as at the end of the interval. Divide it by 100 to obtain the actual value.
Language
Authentication
Basic
base64
: