Average Revenue Per Account (ARPA)

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

Retrieves the Average Revenue Per Account (ARPA) for the specified time period.

curl -X GET "https://api.chartmogul.com/v1/metrics/arpa" \
     -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.arpa(
  start_date: "2023-07-01",
  end_date: "2023-08-31",
  interval: "month",
  geo: "US",
  plans: "Silver Monthly",
)
ChartMogul.Metrics.arpa(config, {
  "start-date": "2023-07-01",
  "end-date": "2023-08-31",
  interval: "month",
  geo: "US",
  plans: "Silver Monthly",
});
ChartMogul\Metrics::arpa([
  "start-date" => "2023-07-01",
  "end-date" => "2023-08-31",
  "interval" => "month",
  "geo" => "US",
  "plans" => "Silver Monthly"
]);
api.MetricsRetrieveARPA(&cm.MetricsFilter{
  StartDate: "2023-07-01",
  EndDate:   "2023-08-31",
  Interval:  "month",
  Geo:       "US",
  Plans:     "Silver Monthly",
})
chartmogul.Metrics.arpa(
  config,
  start_date="2023-07-01",
  end_date="2023-08-31",
  interval="month",
  geo="US",
  plans="Silver Monthly",
)
{
  "entries": [
    {
      "date": "2023-07-31",
      "arpa": 84767,
      "percentage-change": 0.0
    },
    {
      "date": "2023-08-31",
      "arpa": 91121,
      "percentage-change": 7.5
    }
  ],
  "summary": {
    "current": 98307,
    "previous": 86929,
    "percentage-change": 13.09
  }
}
#<ChartMogul::Metrics::ARPAs:0x007fa4ec591148 
  @entries=[
    #<ChartMogul::Metrics::ARPA:0x007fa4ec590ef0 
      @date=2023-07-31, 
      @arpa=84767,
      @percentage_change=0.0
    >, 
    #<ChartMogul::Metrics::ARPA:0x007fa4ec590ab8 
      @date=2023-08-31, 
      @arpa=91121,
      @percentage_change=7.5
    >
  ], 
  @summary=#<ChartMogul::Summary:0x007fa4ec578ff8 
    @current=98307,
    @previous=86929,
    @percentage_change=13.09
  >
>
{
  entries: [
    {
      date: "2023-07-31",
      arpa: 84767,
      "percentage-change": 0.0
    },
    {
      date: "2023-08-31",
      arpa: 91121,
      "percentage-change": 7.5
    }
  ],
  summary: {
    current: 98307,
    previous: 86929,
    "percentage-change": 13.09
  }
}
ChartMogul\Metrics\ARPAs::__set_state(array(
  "entries" => Doctrine\Common\Collections\ArrayCollection::__set_state(array(
    "elements" => array(
      0 => ChartMogul\Metrics\ARPA::__set_state(array(
        "date" => "2023-07-31",
        "arpa" => 84767,
        "percentage_change" => 0.0
      )),
      1 => ChartMogul\Metrics\ARPA::__set_state(array(
        "date" => "2023-08-31",
        "arpa" => 91121,
        "percentage_change" => 7.5
      ))
    )
  )),
  "summary" => ChartMogul\Summary::__set_state(array(
    "current" => 98307,
    "previous" => 86929,
    "percentage_change" => 13.09
  )),
));
(*chartmogul.ARPAResult)(0xc0420b2f00)({
  Entries: ([]*chartmogul.ARPAMetrics) (len=2) {
    (*chartmogul.ARPAMetrics)(0xc0421d60a0)({
      Date: (string) (len=10) "2023-07-31",
      ARPA: (float64) 84767,
      PercentageChange: (float64) 0
    }),
    (*chartmogul.ARPAMetrics)(0xc0421d6100)({
      Date: (string) (len=10) "2023-08-31",
      ARPA: (float64) 91121,
      PercentageChange: (float64) 7.5
    })
  },
  Summary: (*chartmogul.Summary)(0xc0421d6140)({
    Current: (float64) 98307,
    Previous: (float64) 86929,
    PercentageChange: (float64) 13.09
  })
})
Metrics(
  entries=[
    <Metrics{
      arpa=84767.0,
      percentage_change=0.0,
      date=datetime.date(2023, 7, 31)
    }>, 
    <Metrics{
      arpa=91121.0,
      percentage_change=7.5,
      date=datetime.date(2023, 8, 31)
    }>
  ], 
  summary=<Summary{
    current=98307.0, 
    percentage_change=13.09, 
    previous=86929.0
  }>
)

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 optional default: "month"
One of day, week, month (default), quarter or year
geo string optional
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 optional
A comma-separated list of plan UUIDs, external IDs or names (as configured in your ChartMogul account) to filter the results. Plan UUIDs are accepted with or without the pl_ prefix (e.g., pl_ca7565ce-1973-9351-11ee-9f34ab5816d8,b35fdb9e-1ca2-11ee-90be-6f197565b760). Plan IDs and names are case-sensitive. Spaces in plan names must be URL-encoded (e.g., Silver%20plan,Gold%20plan,Enterprise%20plan). You can mix plan UUIDs, external IDs and names in a single string, (e.g., pl_ca7565ce-1973-9351-11ee-9f34ab5816d8,gold_plan,Silver%20plan).

Response

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

date
The date of the end of the interval
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.
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.

The summary key contains the current ARPA value, the value 30 days ago and the percentage change between these two measures.