Read Metrics

Intent

Reads the metrics without changing it.

When to call it

Call this after your application has received or stored the identifier for the metrics.

Access boundary

Authorize the request with a token that carries metrics:read.

Successful result

A successful request returns 200. The response schema below defines the body your integration receives.

Operational notes

Get metrics about your orders and subscriptions.

Currency values are output in cents.

Scopes: metrics:read

GET

metrics

Read Metrics

curl --request GET \
  --url https://api.getruba.com/v1/metrics/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/metrics/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/metrics/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/metrics/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/metrics/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "periods": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "active_subscriptions": 123,
      "committed_subscriptions": 123,
      "monthly_recurring_revenue": 123,
      "trial_monthly_recurring_revenue": 123,
      "committed_monthly_recurring_revenue": 123,
      "trial_committed_monthly_recurring_revenue": 123,
      "average_revenue_per_user": 123,
      "checkouts": 123,
      "succeeded_checkouts": 123,
      "churned_subscriptions": 123,
      "churn_rate": 123,
      "seats_total": 123,
      "seats_claimed": 123,
      "seats_pending": 123,
      "seat_customers": 123,
      "new_seat_customers": 123,
      "churned_seat_customers": 123,
      "orders": 123,
      "revenue": 123,
      "net_revenue": 123,
      "cumulative_revenue": 123,
      "net_cumulative_revenue": 123,
      "costs": 123,
      "cumulative_costs": 123,
      "average_order_value": 123,
      "net_average_order_value": 123,
      "cost_per_user": 123,
      "active_user_by_event": 123,
      "one_time_products": 123,
      "one_time_products_revenue": 123,
      "one_time_products_net_revenue": 123,
      "new_subscriptions": 123,
      "new_subscriptions_revenue": 123,
      "new_subscriptions_net_revenue": 123,
      "renewed_subscriptions": 123,
      "renewed_subscriptions_revenue": 123,
      "renewed_subscriptions_net_revenue": 123,
      "canceled_subscriptions": 123,
      "canceled_subscriptions_customer_service": 123,
      "canceled_subscriptions_low_quality": 123,
      "canceled_subscriptions_missing_features": 123,
      "canceled_subscriptions_switched_service": 123,
      "canceled_subscriptions_too_complex": 123,
      "canceled_subscriptions_too_expensive": 123,
      "canceled_subscriptions_unused": 123,
      "canceled_subscriptions_other": 123,
      "annual_recurring_revenue": 123,
      "committed_annual_recurring_revenue": 123,
      "checkouts_conversion": 123,
      "ltv": 123,
      "gross_margin": 123,
      "gross_margin_percentage": 123,
      "cashflow": 123,
      "average_seats_per_customer": 123,
      "seat_utilization_rate": 123
    }
  ],
  "totals": {
    "active_subscriptions": 123,
    "committed_subscriptions": 123,
    "monthly_recurring_revenue": 123,
    "trial_monthly_recurring_revenue": 123,
    "committed_monthly_recurring_revenue": 123,
    "trial_committed_monthly_recurring_revenue": 123,
    "average_revenue_per_user": 123,
    "checkouts": 123,
    "succeeded_checkouts": 123,
    "churned_subscriptions": 123,
    "churn_rate": 123,
    "seats_total": 123,
    "seats_claimed": 123,
    "seats_pending": 123,
    "seat_customers": 123,
    "new_seat_customers": 123,
    "churned_seat_customers": 123,
    "orders": 123,
    "revenue": 123,
    "net_revenue": 123,
    "cumulative_revenue": 123,
    "net_cumulative_revenue": 123,
    "costs": 123,
    "cumulative_costs": 123,
    "average_order_value": 123,
    "net_average_order_value": 123,
    "cost_per_user": 123,
    "active_user_by_event": 123,
    "one_time_products": 123,
    "one_time_products_revenue": 123,
    "one_time_products_net_revenue": 123,
    "new_subscriptions": 123,
    "new_subscriptions_revenue": 123,
    "new_subscriptions_net_revenue": 123,
    "renewed_subscriptions": 123,
    "renewed_subscriptions_revenue": 123,
    "renewed_subscriptions_net_revenue": 123,
    "canceled_subscriptions": 123,
    "canceled_subscriptions_customer_service": 123,
    "canceled_subscriptions_low_quality": 123,
    "canceled_subscriptions_missing_features": 123,
    "canceled_subscriptions_switched_service": 123,
    "canceled_subscriptions_too_complex": 123,
    "canceled_subscriptions_too_expensive": 123,
    "canceled_subscriptions_unused": 123,
    "canceled_subscriptions_other": 123,
    "annual_recurring_revenue": 123,
    "committed_annual_recurring_revenue": 123,
    "checkouts_conversion": 123,
    "ltv": 123,
    "gross_margin": 123,
    "gross_margin_percentage": 123,
    "cashflow": 123,
    "average_seats_per_customer": 123,
    "seat_utilization_rate": 123
  },
  "metrics": {
    "active_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "trial_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "trial_committed_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_revenue_per_user": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "checkouts": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "succeeded_checkouts": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "churned_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "churn_rate": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seats_total": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seats_claimed": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seats_pending": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seat_customers": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_seat_customers": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "churned_seat_customers": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "orders": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "costs": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_costs": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_order_value": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_average_order_value": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cost_per_user": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "active_user_by_event": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_customer_service": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_low_quality": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_missing_features": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_switched_service": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_too_complex": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_too_expensive": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_unused": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_other": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "annual_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_annual_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "checkouts_conversion": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "ltv": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "gross_margin": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "gross_margin_percentage": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cashflow": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_seats_per_customer": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seat_utilization_rate": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

start_date

string<date>

required

Start date.

end_date

string<date>

required

End date.

timezone

enum<string>

default:UTC

Timezone to use for the timestamps. Default is UTC.

Available options:

Africa/Abidjan,

Africa/Accra,

Africa/Addis_Ababa,

Africa/Algiers,

Africa/Asmara,

Africa/Asmera,

Africa/Bamako,

Africa/Bangui,

Africa/Banjul,

Africa/Bissau,

Africa/Blantyre,

Africa/Brazzaville,

Africa/Bujumbura,

Africa/Cairo,

Africa/Casablanca,

Africa/Ceuta,

Africa/Conakry,

Africa/Dakar,

Africa/Dar_es_Salaam,

Africa/Djibouti,

Africa/Douala,

Africa/El_Aaiun,

Africa/Freetown,

Africa/Gaborone,

Africa/Harare,

Africa/Johannesburg,

Africa/Juba,

Africa/Kampala,

Africa/Khartoum,

Africa/Kigali,

Africa/Kinshasa,

Africa/Lagos,

Africa/Libreville,

Africa/Lome,

Africa/Luanda,

Africa/Lubumbashi,

Africa/Lusaka,

Africa/Malabo,

Africa/Maputo,

Africa/Maseru,

Africa/Mbabane,

Africa/Mogadishu,

Africa/Monrovia,

Africa/Nairobi,

Africa/Ndjamena,

Africa/Niamey,

Africa/Nouakchott,

Africa/Ouagadougou,

Africa/Porto-Novo,

Africa/Sao_Tome,

Africa/Timbuktu,

Africa/Tripoli,

Africa/Tunis,

Africa/Windhoek,

America/Adak,

America/Anchorage,

America/Anguilla,

America/Antigua,

America/Araguaina,

America/Argentina/Buenos_Aires,

America/Argentina/Catamarca,

America/Argentina/ComodRivadavia,

America/Argentina/Cordoba,

America/Argentina/Jujuy,

America/Argentina/La_Rioja,

America/Argentina/Mendoza,

America/Argentina/Rio_Gallegos,

America/Argentina/Salta,

America/Argentina/San_Juan,

America/Argentina/San_Luis,

America/Argentina/Tucuman,

America/Argentina/Ushuaia,

America/Aruba,

America/Asuncion,

America/Atikokan,

America/Atka,

America/Bahia,

America/Bahia_Banderas,

America/Barbados,

America/Belem,

America/Belize,

America/Blanc-Sablon,

America/Boa_Vista,

America/Bogota,

America/Boise,

America/Buenos_Aires,

America/Cambridge_Bay,

America/Campo_Grande,

America/Cancun,

America/Caracas,

America/Catamarca,

America/Cayenne,

America/Cayman,

America/Chicago,

America/Chihuahua,

America/Ciudad_Juarez,

America/Coral_Harbour,

America/Cordoba,

America/Costa_Rica,

America/Coyhaique,

America/Creston,

America/Cuiaba,

America/Curacao,

America/Danmarkshavn,

America/Dawson,

America/Dawson_Creek,

America/Denver,

America/Detroit,

America/Dominica,

America/Edmonton,

America/Eirunepe,

America/El_Salvador,

America/Ensenada,

America/Fort_Nelson,

America/Fort_Wayne,

America/Fortaleza,

America/Glace_Bay,

America/Godthab,

America/Goose_Bay,

America/Grand_Turk,

America/Grenada,

America/Guadeloupe,

America/Guatemala,

America/Guayaquil,

America/Guyana,

America/Halifax,

America/Havana,

America/Hermosillo,

America/Indiana/Indianapolis,

America/Indiana/Knox,

America/Indiana/Marengo,

America/Indiana/Petersburg,

America/Indiana/Tell_City,

America/Indiana/Vevay,

America/Indiana/Vincennes,

America/Indiana/Winamac,

America/Indianapolis,

America/Inuvik,

America/Iqaluit,

America/Jamaica,

America/Jujuy,

America/Juneau,

America/Kentucky/Louisville,

America/Kentucky/Monticello,

America/Knox_IN,

America/Kralendijk,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Louisville,

America/Lower_Princes,

America/Maceio,

America/Managua,

America/Manaus,

America/Marigot,

America/Martinique,

America/Matamoros,

America/Mazatlan,

America/Mendoza,

America/Menominee,

America/Merida,

America/Metlakatla,

America/Mexico_City,

America/Miquelon,

America/Moncton,

America/Monterrey,

America/Montevideo,

America/Montreal,

America/Montserrat,

America/Nassau,

America/New_York,

America/Nipigon,

America/Nome,

America/Noronha,

America/North_Dakota/Beulah,

America/North_Dakota/Center,

America/North_Dakota/New_Salem,

America/Nuuk,

America/Ojinaga,

America/Panama,

America/Pangnirtung,

America/Paramaribo,

America/Phoenix,

America/Port-au-Prince,

America/Port_of_Spain,

America/Porto_Acre,

America/Porto_Velho,

America/Puerto_Rico,

America/Punta_Arenas,

America/Rainy_River,

America/Rankin_Inlet,

America/Recife,

America/Regina,

America/Resolute,

America/Rio_Branco,

America/Rosario,

America/Santa_Isabel,

America/Santarem,

America/Santiago,

America/Santo_Domingo,

America/Sao_Paulo,

America/Scoresbysund,

America/Shiprock,

America/Sitka,

America/St_Barthelemy,

America/St_Johns,

America/St_Kitts,

America/St_Lucia,

America/St_Thomas,

America/St_Vincent,

America/Swift_Current,

America/Tegucigalpa,

America/Thule,

America/Thunder_Bay,

America/Tijuana,

America/Toronto,

America/Tortola,

America/Vancouver,

America/Virgin,

America/Whitehorse,

America/Winnipeg,

America/Yakutat,

America/Yellowknife,

Antarctica/Casey,

Antarctica/Davis,

Antarctica/DumontDUrville,

Antarctica/Macquarie,

Antarctica/Mawson,

Antarctica/McMurdo,

Antarctica/Palmer,

Antarctica/Rothera,

Antarctica/South_Pole,

Antarctica/Syowa,

Antarctica/Troll,

Antarctica/Vostok,

Arctic/Longyearbyen,

Asia/Aden,

Asia/Almaty,

Asia/Amman,

Asia/Anadyr,

Asia/Aqtau,

Asia/Aqtobe,

Asia/Ashgabat,

Asia/Ashkhabad,

Asia/Atyrau,

Asia/Baghdad,

Asia/Bahrain,

Asia/Baku,

Asia/Bangkok,

Asia/Barnaul,

Asia/Beirut,

Asia/Bishkek,

Asia/Brunei,

Asia/Calcutta,

Asia/Chita,

Asia/Choibalsan,

Asia/Chongqing,

Asia/Chungking,

Asia/Colombo,

Asia/Dacca,

Asia/Damascus,

Asia/Dhaka,

Asia/Dili,

Asia/Dubai,

Asia/Dushanbe,

Asia/Famagusta,

Asia/Gaza,

Asia/Harbin,

Asia/Hebron,

Asia/Ho_Chi_Minh,

Asia/Hong_Kong,

Asia/Hovd,

Asia/Irkutsk,

Asia/Istanbul,

Asia/Jakarta,

Asia/Jayapura,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kashgar,

Asia/Kathmandu,

Asia/Katmandu,

Asia/Khandyga,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuching,

Asia/Kuwait,

Asia/Macao,

Asia/Macau,

Asia/Magadan,

Asia/Makassar,

Asia/Manila,

Asia/Muscat,

Asia/Nicosia,

Asia/Novokuznetsk,

Asia/Novosibirsk,

Asia/Omsk,

Asia/Oral,

Asia/Phnom_Penh,

Asia/Pontianak,

Asia/Pyongyang,

Asia/Qatar,

Asia/Qostanay,

Asia/Qyzylorda,

Asia/Rangoon,

Asia/Riyadh,

Asia/Saigon,

Asia/Sakhalin,

Asia/Samarkand,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tel_Aviv,

Asia/Thimbu,

Asia/Thimphu,

Asia/Tokyo,

Asia/Tomsk,

Asia/Ujung_Pandang,

Asia/Ulaanbaatar,

Asia/Ulan_Bator,

Asia/Urumqi,

Asia/Ust-Nera,

Asia/Vientiane,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yangon,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Bermuda,

Atlantic/Canary,

Atlantic/Cape_Verde,

Atlantic/Faeroe,

Atlantic/Faroe,

Atlantic/Jan_Mayen,

Atlantic/Madeira,

Atlantic/Reykjavik,

Atlantic/South_Georgia,

Atlantic/St_Helena,

Atlantic/Stanley,

Australia/ACT,

Australia/Adelaide,

Australia/Brisbane,

Australia/Broken_Hill,

Australia/Canberra,

Australia/Currie,

Australia/Darwin,

Australia/Eucla,

Australia/Hobart,

Australia/LHI,

Australia/Lindeman,

Australia/Lord_Howe,

Australia/Melbourne,

Australia/NSW,

Australia/North,

Australia/Perth,

Australia/Queensland,

Australia/South,

Australia/Sydney,

Australia/Tasmania,

Australia/Victoria,

Australia/West,

Australia/Yancowinna,

Brazil/Acre,

Brazil/DeNoronha,

Brazil/East,

Brazil/West,

CET,

CST6CDT,

Canada/Atlantic,

Canada/Central,

Canada/Eastern,

Canada/Mountain,

Canada/Newfoundland,

Canada/Pacific,

Canada/Saskatchewan,

Canada/Yukon,

Chile/Continental,

Chile/EasterIsland,

Cuba,

EET,

EST,

EST5EDT,

Egypt,

Eire,

Etc/GMT,

Etc/GMT+0,

Etc/GMT+1,

Etc/GMT+10,

Etc/GMT+11,

Etc/GMT+12,

Etc/GMT+2,

Etc/GMT+3,

Etc/GMT+4,

Etc/GMT+5,

Etc/GMT+6,

Etc/GMT+7,

Etc/GMT+8,

Etc/GMT+9,

Etc/GMT-0,

Etc/GMT-1,

Etc/GMT-10,

Etc/GMT-11,

Etc/GMT-12,

Etc/GMT-13,

Etc/GMT-14,

Etc/GMT-2,

Etc/GMT-3,

Etc/GMT-4,

Etc/GMT-5,

Etc/GMT-6,

Etc/GMT-7,

Etc/GMT-8,

Etc/GMT-9,

Etc/GMT0,

Etc/Greenwich,

Etc/UCT,

Etc/UTC,

Etc/Universal,

Etc/Zulu,

Europe/Amsterdam,

Europe/Andorra,

Europe/Astrakhan,

Europe/Athens,

Europe/Belfast,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Busingen,

Europe/Chisinau,

Europe/Copenhagen,

Europe/Dublin,

Europe/Gibraltar,

Europe/Guernsey,

Europe/Helsinki,

Europe/Isle_of_Man,

Europe/Istanbul,

Europe/Jersey,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Kirov,

Europe/Kyiv,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Luxembourg,

Europe/Madrid,

Europe/Malta,

Europe/Mariehamn,

Europe/Minsk,

Europe/Monaco,

Europe/Moscow,

Europe/Nicosia,

Europe/Oslo,

Europe/Paris,

Europe/Podgorica,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/San_Marino,

Europe/Sarajevo,

Europe/Saratov,

Europe/Simferopol,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Tirane,

Europe/Tiraspol,

Europe/Ulyanovsk,

Europe/Uzhgorod,

Europe/Vaduz,

Europe/Vatican,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zaporozhye,

Europe/Zurich,

Factory,

GB,

GB-Eire,

GMT,

GMT+0,

GMT-0,

GMT0,

Greenwich,

HST,

Hongkong,

Iceland,

Indian/Antananarivo,

Indian/Chagos,

Indian/Christmas,

Indian/Cocos,

Indian/Comoro,

Indian/Kerguelen,

Indian/Mahe,

Indian/Maldives,

Indian/Mauritius,

Indian/Mayotte,

Indian/Reunion,

Iran,

Israel,

Jamaica,

Japan,

Kwajalein,

Libya,

MET,

MST,

MST7MDT,

Mexico/BajaNorte,

Mexico/BajaSur,

Mexico/General,

NZ,

NZ-CHAT,

Navajo,

PRC,

PST8PDT,

Pacific/Apia,

Pacific/Auckland,

Pacific/Bougainville,

Pacific/Chatham,

Pacific/Chuuk,

Pacific/Easter,

Pacific/Efate,

Pacific/Enderbury,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Funafuti,

Pacific/Galapagos,

Pacific/Gambier,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Johnston,

Pacific/Kanton,

Pacific/Kiritimati,

Pacific/Kosrae,

Pacific/Kwajalein,

Pacific/Majuro,

Pacific/Marquesas,

Pacific/Midway,

Pacific/Nauru,

Pacific/Niue,

Pacific/Norfolk,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Palau,

Pacific/Pitcairn,

Pacific/Pohnpei,

Pacific/Ponape,

Pacific/Port_Moresby,

Pacific/Rarotonga,

Pacific/Saipan,

Pacific/Samoa,

Pacific/Tahiti,

Pacific/Tarawa,

Pacific/Tongatapu,

Pacific/Truk,

Pacific/Wake,

Pacific/Wallis,

Pacific/Yap,

Poland,

Portugal,

ROC,

ROK,

Singapore,

Turkey,

UCT,

US/Alaska,

US/Aleutian,

US/Arizona,

US/Central,

US/East-Indiana,

US/Eastern,

US/Hawaii,

US/Indiana-Starke,

US/Michigan,

US/Mountain,

US/Pacific,

US/Samoa,

UTC,

Universal,

W-SU,

WET,

Zulu

Minimum string length: 1

interval

enum<string>

required

Interval between two timestamps.

Available options:

year,

month,

week,

day,

hour

organization_id

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

product_id

Filter by product ID. The product ID.

billing_type

Filter by billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.

Available options:

one_time,

recurring

customer_id

Filter by customer ID. The customer ID.

metrics

string[] | null

List of metric slugs to focus on. When provided, only the queries needed for these metrics will be executed, improving performance. If not provided, all metrics are returned.

Response

Successful Response

Metrics response schema.

periods

MetricPeriod · object[]

required

List of data for each timestamp.

Show child attributes

totals

MetricsTotals · object

required

Totals for the whole selected period.

Show child attributes

metrics

Metrics · object

required

Information about the returned metrics.

Show child attributes

Read Metrics

curl --request GET \
  --url https://api.getruba.com/v1/metrics/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/metrics/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/metrics/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/metrics/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/metrics/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "periods": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "active_subscriptions": 123,
      "committed_subscriptions": 123,
      "monthly_recurring_revenue": 123,
      "trial_monthly_recurring_revenue": 123,
      "committed_monthly_recurring_revenue": 123,
      "trial_committed_monthly_recurring_revenue": 123,
      "average_revenue_per_user": 123,
      "checkouts": 123,
      "succeeded_checkouts": 123,
      "churned_subscriptions": 123,
      "churn_rate": 123,
      "seats_total": 123,
      "seats_claimed": 123,
      "seats_pending": 123,
      "seat_customers": 123,
      "new_seat_customers": 123,
      "churned_seat_customers": 123,
      "orders": 123,
      "revenue": 123,
      "net_revenue": 123,
      "cumulative_revenue": 123,
      "net_cumulative_revenue": 123,
      "costs": 123,
      "cumulative_costs": 123,
      "average_order_value": 123,
      "net_average_order_value": 123,
      "cost_per_user": 123,
      "active_user_by_event": 123,
      "one_time_products": 123,
      "one_time_products_revenue": 123,
      "one_time_products_net_revenue": 123,
      "new_subscriptions": 123,
      "new_subscriptions_revenue": 123,
      "new_subscriptions_net_revenue": 123,
      "renewed_subscriptions": 123,
      "renewed_subscriptions_revenue": 123,
      "renewed_subscriptions_net_revenue": 123,
      "canceled_subscriptions": 123,
      "canceled_subscriptions_customer_service": 123,
      "canceled_subscriptions_low_quality": 123,
      "canceled_subscriptions_missing_features": 123,
      "canceled_subscriptions_switched_service": 123,
      "canceled_subscriptions_too_complex": 123,
      "canceled_subscriptions_too_expensive": 123,
      "canceled_subscriptions_unused": 123,
      "canceled_subscriptions_other": 123,
      "annual_recurring_revenue": 123,
      "committed_annual_recurring_revenue": 123,
      "checkouts_conversion": 123,
      "ltv": 123,
      "gross_margin": 123,
      "gross_margin_percentage": 123,
      "cashflow": 123,
      "average_seats_per_customer": 123,
      "seat_utilization_rate": 123
    }
  ],
  "totals": {
    "active_subscriptions": 123,
    "committed_subscriptions": 123,
    "monthly_recurring_revenue": 123,
    "trial_monthly_recurring_revenue": 123,
    "committed_monthly_recurring_revenue": 123,
    "trial_committed_monthly_recurring_revenue": 123,
    "average_revenue_per_user": 123,
    "checkouts": 123,
    "succeeded_checkouts": 123,
    "churned_subscriptions": 123,
    "churn_rate": 123,
    "seats_total": 123,
    "seats_claimed": 123,
    "seats_pending": 123,
    "seat_customers": 123,
    "new_seat_customers": 123,
    "churned_seat_customers": 123,
    "orders": 123,
    "revenue": 123,
    "net_revenue": 123,
    "cumulative_revenue": 123,
    "net_cumulative_revenue": 123,
    "costs": 123,
    "cumulative_costs": 123,
    "average_order_value": 123,
    "net_average_order_value": 123,
    "cost_per_user": 123,
    "active_user_by_event": 123,
    "one_time_products": 123,
    "one_time_products_revenue": 123,
    "one_time_products_net_revenue": 123,
    "new_subscriptions": 123,
    "new_subscriptions_revenue": 123,
    "new_subscriptions_net_revenue": 123,
    "renewed_subscriptions": 123,
    "renewed_subscriptions_revenue": 123,
    "renewed_subscriptions_net_revenue": 123,
    "canceled_subscriptions": 123,
    "canceled_subscriptions_customer_service": 123,
    "canceled_subscriptions_low_quality": 123,
    "canceled_subscriptions_missing_features": 123,
    "canceled_subscriptions_switched_service": 123,
    "canceled_subscriptions_too_complex": 123,
    "canceled_subscriptions_too_expensive": 123,
    "canceled_subscriptions_unused": 123,
    "canceled_subscriptions_other": 123,
    "annual_recurring_revenue": 123,
    "committed_annual_recurring_revenue": 123,
    "checkouts_conversion": 123,
    "ltv": 123,
    "gross_margin": 123,
    "gross_margin_percentage": 123,
    "cashflow": 123,
    "average_seats_per_customer": 123,
    "seat_utilization_rate": 123
  },
  "metrics": {
    "active_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "trial_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "trial_committed_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_revenue_per_user": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "checkouts": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "succeeded_checkouts": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "churned_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "churn_rate": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seats_total": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seats_claimed": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seats_pending": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seat_customers": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_seat_customers": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "churned_seat_customers": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "orders": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "costs": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_costs": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_order_value": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_average_order_value": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cost_per_user": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "active_user_by_event": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_customer_service": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_low_quality": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_missing_features": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_switched_service": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_too_complex": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_too_expensive": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_unused": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_other": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "annual_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_annual_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "checkouts_conversion": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "ltv": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "gross_margin": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "gross_margin_percentage": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cashflow": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_seats_per_customer": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "seat_utilization_rate": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Read Metrics

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Query Parameters

Response