Create Meter

Intent

Creates a meter from the values supplied in the request.

When to call it

Call this when your application has collected the required values and is ready to create a meter.

Access boundary

Authorize the request with a token that carries meters:write.

Successful result

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

Operational notes

Create a meter.

Scopes: meters:write

POST

meters

Create Meter

curl --request POST \
  --url https://api.getruba.com/v1/meters/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "filter": {
    "clauses": [
      {
        "property": "<string>",
        "value": "<string>"
      }
    ]
  },
  "aggregation": {
    "func": "count"
  },
  "metadata": {},
  "unit": "scalar",
  "custom_label": "<string>",
  "custom_multiplier": 1,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

import requests

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

payload = {
    "name": "<string>",
    "filter": { "clauses": [
            {
                "property": "<string>",
                "value": "<string>"
            }
        ] },
    "aggregation": { "func": "count" },
    "metadata": {},
    "unit": "scalar",
    "custom_label": "<string>",
    "custom_multiplier": 1,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    filter: {clauses: [{property: '<string>', value: '<string>'}]},
    aggregation: {func: 'count'},
    metadata: {},
    unit: 'scalar',
    custom_label: '<string>',
    custom_multiplier: 1,
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.getruba.com/v1/meters/', 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/meters/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'filter' => [
        'clauses' => [
                [
                                'property' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'aggregation' => [
        'func' => 'count'
    ],
    'metadata' => [
        
    ],
    'unit' => 'scalar',
    'custom_label' => '<string>',
    'custom_multiplier' => 1,
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"filter\": {\n    \"clauses\": [\n      {\n        \"property\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"aggregation\": {\n    \"func\": \"count\"\n  },\n  \"metadata\": {},\n  \"unit\": \"scalar\",\n  \"custom_label\": \"<string>\",\n  \"custom_multiplier\": 1,\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getruba.com/v1/meters/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"filter\": {\n    \"clauses\": [\n      {\n        \"property\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"aggregation\": {\n    \"func\": \"count\"\n  },\n  \"metadata\": {},\n  \"unit\": \"scalar\",\n  \"custom_label\": \"<string>\",\n  \"custom_multiplier\": 1,\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"filter\": {\n    \"clauses\": [\n      {\n        \"property\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"aggregation\": {\n    \"func\": \"count\"\n  },\n  \"metadata\": {},\n  \"unit\": \"scalar\",\n  \"custom_label\": \"<string>\",\n  \"custom_multiplier\": 1,\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

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

{
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "unit": "scalar",
  "filter": {
    "conjunction": "and",
    "clauses": [
      {
        "property": "<string>",
        "operator": "eq",
        "value": "<string>"
      }
    ]
  },
  "aggregation": {
    "func": "count"
  },
  "organization_id": "<string>",
  "custom_label": "<string>",
  "custom_multiplier": 123,
  "archived_at": "2023-11-07T05:31:56Z"
}

{
  "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.

Body

application/json

name

string

required

The name of the meter. Will be shown on customer's invoices and usage.

Minimum string length: 3

filter

Filter · object

required

The filter to apply on events that'll be used to calculate the meter.

Show child attributes

aggregation

CountAggregation · object

required

The aggregation to apply on the filtered events to calculate the meter.

CountAggregation
PropertyAggregation
UniqueAggregation

Show child attributes

metadata

Metadata · object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

unit

enum<string>

default:scalar

The unit of the meter.

Available options:

scalar,

token,

custom

custom_label

string | null

The label for the custom unit, e.g. 'request'. Required when unit is 'custom'.

custom_multiplier

integer | null

The multiplier to convert from the base unit to display scale, e.g. 1000 to display per 1000 units. Defaults to 1 when not provided.

Required range: x > 0

organization_id

string<uuid4> | null

The organization ID.

Example:

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

Response

Meter created.

metadata

object

required

Show child attributes

created_at

string<date-time>

required

The time Ruba created this record.

modified_at

string<date-time> | null

required

The time this record last changed.

string<uuid4>

required

The stable identifier for this record.

name

string

required

The name of the meter. Will be shown on customer's invoices and usage.

unit

enum<string>

required

The unit of the meter.

Available options:

scalar,

token,

custom

filter

Filter · object

required

The filter to apply on events that'll be used to calculate the meter.

Show child attributes

aggregation

CountAggregation · object

required

The aggregation to apply on the filtered events to calculate the meter.

CountAggregation
PropertyAggregation
UniqueAggregation

Show child attributes

organization_id

string<uuid4>

required

The ID of the organization owning the meter.

custom_label

string | null

The label for the custom unit.

custom_multiplier

integer | null

The multiplier to convert from base unit to display scale.

archived_at

string<date-time> | null

Whether the meter is archived and the time it was archived.

Create Meter

curl --request POST \
  --url https://api.getruba.com/v1/meters/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "filter": {
    "clauses": [
      {
        "property": "<string>",
        "value": "<string>"
      }
    ]
  },
  "aggregation": {
    "func": "count"
  },
  "metadata": {},
  "unit": "scalar",
  "custom_label": "<string>",
  "custom_multiplier": 1,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

import requests

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

payload = {
    "name": "<string>",
    "filter": { "clauses": [
            {
                "property": "<string>",
                "value": "<string>"
            }
        ] },
    "aggregation": { "func": "count" },
    "metadata": {},
    "unit": "scalar",
    "custom_label": "<string>",
    "custom_multiplier": 1,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    filter: {clauses: [{property: '<string>', value: '<string>'}]},
    aggregation: {func: 'count'},
    metadata: {},
    unit: 'scalar',
    custom_label: '<string>',
    custom_multiplier: 1,
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.getruba.com/v1/meters/', 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/meters/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'filter' => [
        'clauses' => [
                [
                                'property' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'aggregation' => [
        'func' => 'count'
    ],
    'metadata' => [
        
    ],
    'unit' => 'scalar',
    'custom_label' => '<string>',
    'custom_multiplier' => 1,
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"filter\": {\n    \"clauses\": [\n      {\n        \"property\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"aggregation\": {\n    \"func\": \"count\"\n  },\n  \"metadata\": {},\n  \"unit\": \"scalar\",\n  \"custom_label\": \"<string>\",\n  \"custom_multiplier\": 1,\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getruba.com/v1/meters/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"filter\": {\n    \"clauses\": [\n      {\n        \"property\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"aggregation\": {\n    \"func\": \"count\"\n  },\n  \"metadata\": {},\n  \"unit\": \"scalar\",\n  \"custom_label\": \"<string>\",\n  \"custom_multiplier\": 1,\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"filter\": {\n    \"clauses\": [\n      {\n        \"property\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"aggregation\": {\n    \"func\": \"count\"\n  },\n  \"metadata\": {},\n  \"unit\": \"scalar\",\n  \"custom_label\": \"<string>\",\n  \"custom_multiplier\": 1,\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

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

{
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "unit": "scalar",
  "filter": {
    "conjunction": "and",
    "clauses": [
      {
        "property": "<string>",
        "operator": "eq",
        "value": "<string>"
      }
    ]
  },
  "aggregation": {
    "func": "count"
  },
  "organization_id": "<string>",
  "custom_label": "<string>",
  "custom_multiplier": 123,
  "archived_at": "2023-11-07T05:31:56Z"
}

{
  "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

Create Meter

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Body

Response