Skip to main content
GET
/
api
/
v1
/
meters
/
{meter}

Path Parameters

meter
string
required

Query Parameters

groupingFields
string[]
required

Fields to group by, example: ['userId', 'agentId', 'sessionId', 'runId', 'modelName', 'modelProvider', 'type', 'env']

source
string
required

Source of the meter, for now can be only chat-engine, this can be helpfully if same metering system is used by multiple sources

userId
string
required

Chat-engine User's id, can have multiple agents attached to it

agentId
string
required

Agent id, can have multiple sessions attached to it

sessionId
string
required

Session id, can have multiple message attached to it

runId
string
required

Run id, a run represent a session send+reply (input output) message, can have multiple generations attached to it, with inputs and outputs

modelName
string
required

Model name, example: gpt-4o-mini, gpt-4o ....

modelProvider
string
required

Model provider, example: openai, anthropic ....

type
string
required

Type of the meter, input or output

env
string
required

Environment of the meter, example: dev, prod ....

window
string
required

Even sum aggregations window

startDate
string<date-time>
required

Start date in UTC, bellow minute precision will be ignored

endDate
string<date-time>
required

End date in UTC, bellow minute precision will be ignored, should greater than Start date

Response

200

Return all meters.