@openmeter/sdk v1.0.0-beta.72
OpenMeter Node SDK
Install
npm install --save @openmeter/sdk
Example
import { OpenMeter, type Event } from '@openmeter/sdk'
const openmeter = new OpenMeter({ baseUrl: 'http://localhost:8888' })
// Ingesting an event
const event: Event = {
specversion: '1.0',
id: 'id-1',
source: 'my-app',
type: 'my-type',
subject: 'my-awesome-user-id',
time: new Date(),
data: {
api_calls: 1,
},
}
await openmeter.events.ingest(event)
// Fetching a meter
const meter = await openmeter.meters.get('m1')
API
Events
ingest
import { type Event } from '@openmeter/sdk'
const event: Event = {
specversion: '1.0',
id: 'id-1',
source: 'my-app',
type: 'my-type',
subject: 'my-awesome-user-id',
time: new Date(),
data: {
api_calls: 1,
},
}
await openmeter.events.ingest(event)
batch ingest
await openmeter.events.ingest([event1, event2, event3])
list
Retrieve latest raw events. Useful for debugging.
const events = await openmeter.events.list()
Meters
list
List meters.
const meters = await openmeter.meters.list()
get
Get one meter by slug.
const meter = await openmeter.meters.get('m1')
query
Query meter values.
import { WindowSize } from '@openmeter/sdk'
const values = await openmeter.meters.query('my-meter-slug', {
subject: ['user-1'],
groupBy: ['method', 'path'],
from: new Date('2021-01-01'),
to: new Date('2021-01-02'),
windowSize: WindowSize.HOUR,
})
meter subjects
List meter subjects.
const subjects = await openmeter.meters.subjects('my-meter-slug')
Portal
createToken
Create subject specific tokens. Useful to build consumer dashboards.
const token = await openmeter.portal.createToken({ subject: 'customer-1' })
invalidateTokens
Invalidate portal tokens for all or specific subjects.
await openmeter.portal.invalidateTokens()
Subject
Subject mappings. Like display name and metadata.
upsert
Upsert subjects.
const subjects = await openmeter.subjects.upsert([
{
key: 'customer-1',
displayName: 'ACME'
}
])
list
List subjects.
const subjects = await openmeter.subjects.list()
get
Get subject by key.
const subjects = await openmeter.subjects.get('customer-1')
delete
Delete subject by key. It doesn't delete corresponding usage.
await openmeter.subjects.delete('customer-1')
2 days ago
2 days ago
2 days ago
2 days ago
6 days ago
7 days ago
13 days ago
17 days ago
22 days ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
9 months ago
9 months ago
9 months ago
10 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
5 months ago
5 months ago
8 months ago
5 months ago
8 months ago
7 months ago
6 months ago
11 months ago
11 months ago