> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Meters
> ### Intent
Reads the available meters as a pageable collection without changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect meters. Use the filters and paging controls shown below to limit the result.
### Access boundary
Authorize the request with a token that carries `meters:read` or `meters:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const x = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + x + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml get /v1/meters/
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
version: 2026-04
servers:
- url: https://api.getruba.com
description: '**Details:** Production environment.'
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: '**Details:** Sandbox environment.'
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
**Details:** Endpoints shown and documented in the Ruba API documentation
and available in our SDKs.
- name: private
description: >-
**Details:** Endpoints that should appear in the schema only in
development to generate our internal JS SDK.
paths:
/v1/meters/:
get:
tags:
- meters
- public
summary: List Meters
description: >-
### Intent
Reads the available meters as a pageable collection without changing
them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect
meters. Use the filters and paging controls shown below to limit the
result.
### Access boundary
Authorize the request with a token that carries `meters:read` or
`meters:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
operationId: meters:list
parameters:
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid4
description: Identifier of the organization.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: array
items:
type: string
format: uuid4
description: Identifier of the organization.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: 'null'
title: OrganizationID Filter
description: Return only records matching organization ID.
description: Return only records matching organization ID.
- name: query
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Return only records matching name.
title: Query
description: Return only records matching name.
- name: is_archived
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
description: '**Parameter:** Filter on archived meters.'
title: Is Archived
description: '**Parameter:** Filter on archived meters.'
- name: page
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Results page to return. The first page is used by default.
default: 1
title: Page
description: Results page to return. The first page is used by default.
- name: limit
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Records returned per page. Defaults to 10 and accepts up to 100.
default: 10
title: Limit
description: Records returned per page. Defaults to 10 and accepts up to 100.
- name: sorting
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/MeterSortProperty'
- type: 'null'
description: >-
Sort rules applied from left to right. Prefix any rule with `-` to
reverse it into descending order.
default:
- name
title: Sorting
description: >-
Sort rules applied from left to right. Prefix any rule with `-` to
reverse it into descending order.
- name: metadata
in: query
required: false
style: deepObject
schema:
$ref: '#/components/schemas/MetadataQuery'
description: >-
Return only records matching metadata key-value pairs. It uses the
`deepObject` style, e.g. `?metadata[key]=value`.
responses:
'200':
description: Request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ListResource_Meter_'
'422':
description: Request validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- oidc:
- meters:read
- meters:write
- pat:
- meters:read
- meters:write
- oat:
- meters:read
- meters:write
components:
schemas:
MeterSortProperty:
type: string
enum:
- created_at
- '-created_at'
- name
- '-name'
title: MeterSortProperty
MetadataQuery:
anyOf:
- type: object
additionalProperties:
anyOf:
- type: string
- type: integer
- type: boolean
- items:
type: string
type: array
- type: array
items:
type: integer
- type: array
items:
type: boolean
- type: 'null'
title: MetadataQuery
ListResource_Meter_:
properties:
items:
items:
$ref: '#/components/schemas/Meter'
type: array
title: Items
pagination:
$ref: '#/components/schemas/Pagination'
type: object
required:
- items
- pagination
title: ListResource[Meter]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
Meter:
properties:
metadata:
$ref: '#/components/schemas/MetadataOutputType'
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
name:
type: string
title: Name
description: >-
Name assigned to the meter. Will be shown on customer's invoices and
usage.
unit:
$ref: '#/components/schemas/MeterUnit'
description: '**Unit:** Unit of the meter.'
custom_label:
anyOf:
- type: string
- type: 'null'
title: Custom Label
description: '**Custom Label:** Label for the custom unit.'
custom_multiplier:
anyOf:
- type: integer
- type: 'null'
title: Custom Multiplier
description: >-
**Custom Multiplier:** Multiplier to convert from base unit to
display scale.
filter:
$ref: '#/components/schemas/Filter'
description: >-
**Filter:** Filter to apply on events that'll be used to calculate
the meter.
aggregation:
oneOf:
- $ref: '#/components/schemas/CountAggregation'
- $ref: '#/components/schemas/PropertyAggregation'
- $ref: '#/components/schemas/UniqueAggregation'
title: Aggregation
description: >-
**Aggregation:** Aggregation to apply on the filtered events to
calculate the meter.
discriminator:
propertyName: func
mapping:
avg:
$ref: '#/components/schemas/PropertyAggregation'
count:
$ref: '#/components/schemas/CountAggregation'
max:
$ref: '#/components/schemas/PropertyAggregation'
min:
$ref: '#/components/schemas/PropertyAggregation'
sum:
$ref: '#/components/schemas/PropertyAggregation'
unique:
$ref: '#/components/schemas/UniqueAggregation'
organization_id:
type: string
format: uuid4
title: Organization Id
description: Unique identifier for the organization owning the meter.
archived_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Archived At
description: >-
Indicates whether the meter is archived and the time it was
archived.
type: object
required:
- metadata
- created_at
- modified_at
- id
- name
- unit
- filter
- aggregation
- organization_id
title: Meter
Pagination:
properties:
total_count:
type: integer
title: Total Count
max_page:
type: integer
title: Max Page
type: object
required:
- total_count
- max_page
title: Pagination
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
MetadataOutputType:
additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
type: object
MeterUnit:
type: string
enum:
- scalar
- token
- custom
title: MeterUnit
Filter:
properties:
conjunction:
$ref: '#/components/schemas/FilterConjunction'
clauses:
items:
anyOf:
- $ref: '#/components/schemas/FilterClause'
- $ref: '#/components/schemas/Filter'
type: array
title: Clauses
type: object
required:
- conjunction
- clauses
title: Filter
CountAggregation:
properties:
func:
type: string
const: count
title: Func
default: count
type: object
title: CountAggregation
PropertyAggregation:
properties:
func:
type: string
enum:
- sum
- max
- min
- avg
title: Func
property:
type: string
title: Property
type: object
required:
- func
- property
title: PropertyAggregation
UniqueAggregation:
properties:
func:
type: string
const: unique
title: Func
default: unique
property:
type: string
title: Property
type: object
required:
- property
title: UniqueAggregation
FilterConjunction:
type: string
enum:
- and
- or
title: FilterConjunction
FilterClause:
properties:
property:
type: string
title: Property
operator:
$ref: '#/components/schemas/FilterOperator'
value:
anyOf:
- type: string
maxLength: 1000
- type: integer
maximum: 2147483647
minimum: -2147483648
- type: boolean
title: Value
type: object
required:
- property
- operator
- value
title: FilterClause
FilterOperator:
type: string
enum:
- eq
- ne
- gt
- gte
- lt
- lte
- like
- not_like
title: FilterOperator
securitySchemes:
oidc:
type: openIdConnect
openIdConnectUrl: /.well-known/openid-configuration
pat:
type: http
description: >-
**Authentication:** You can generate a **Personal Access Token** from
your [settings](https://getruba.com/settings).
scheme: bearer
oat:
type: http
description: >-
**Authentication:** You can generate an **Organization Access Token**
from your organization's settings.
scheme: bearer
````