Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Helicone Metrics API

The Metrics API from Helicone — 20 operation(s) for metrics.

Helicone Metrics API is one of 33 APIs that Helicone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an API reference, and an engineering blog.

This API exposes 20 operations across 20 paths, and defines 78 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.helicone.ai/, http://localhost:8585/.

20 operations 20 paths 78 schemas 20 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://ai-gateway.helicone.ai
Authentication
API Key
License
MIT
Resource Areas
1

Authentication & Security 1

Helicone Metrics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

  • api_key — Bearer token authentication. Format: 'Bearer YOURAPIKEY'

Paths & Operations 20

Across 20 paths, the API surfaces 20 operations — 20 POST. Each is listed below with its method, path, parameters, and response codes.

Metrics 20
POST
/v1/metrics/totalRequests
GetTotalRequests body → 200
POST
/v1/metrics/totalCost
GetTotalCost body → 200
POST
/v1/metrics/averageLatency
GetAverageLatency body → 200
POST
/v1/metrics/averageTimeToFirstToken
GetAverageTimeToFirstToken body → 200
POST
/v1/metrics/averageTokensPerRequest
GetAverageTokensPerRequest body → 200
POST
/v1/metrics/totalThreats
GetTotalThreats body → 200
POST
/v1/metrics/activeUsers
GetActiveUsers body → 200
POST
/v1/metrics/requestOverTime
GetRequestsOverTime body → 200
POST
/v1/metrics/costOverTime
GetCostOverTime body → 200
POST
/v1/metrics/tokensOverTime
GetTokensOverTime body → 200
POST
/v1/metrics/latencyOverTime
GetLatencyOverTime body → 200
POST
/v1/metrics/timeToFirstToken
GetTimeToFirstTokenOverTime body → 200
POST
/v1/metrics/usersOverTime
GetUsersOverTime body → 200
POST
/v1/metrics/threatsOverTime
GetThreatsOverTime body → 200
POST
/v1/metrics/errorOverTime
GetErrorsOverTime body → 200
POST
/v1/metrics/requestStatusOverTime
GetRequestStatusOverTime body → 200
POST
/v1/metrics/requestCount
GetRequestCount body → 200
POST
/v1/metrics/models
GetModelMetrics body → 200
POST
/v1/metrics/country
GetCountryMetrics body → 200
POST
/v1/metrics/quantiles
GetQuantiles body → 200

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are Partial_RequestResponseRMTToOperators_ (37 properties), Partial_TablesAndViews_ (24 properties), Partial_CacheMetricsTableToOperators_ (17 properties), Partial_RequestTableToOperators_ (12 properties). Each schema is shown below with its type and property counts.

Result_Quantiles-Array.string_
CountryMetricsBody
object
4 properties 4 required
Result_ModelMetric-Array.string_
UsersOverTime
object
2 properties 2 required
Partial_TextOperators_
object
Make all properties in T optional
6 properties
MetricsFilterBody
object
2 properties 2 required
CountryData
object
2 properties 2 required
RequestsOverTime
object
3 properties 2 required
Result_LatencyOverTime-Array.string_
TokensOverTime
object
3 properties 3 required
Partial_UserMetricsToOperators_
object
Make all properties in T optional
9 properties
Partial_PropertiesV3ToOperators_
object
Make all properties in T optional
3 properties
Partial_TimestampOperatorsTyped_
object
Make all properties in T optional
5 properties
ResultSuccess_number_
object
2 properties 2 required
ResultSuccess_TimeToFirstTokenOverTime-Array_
object
2 properties 2 required
ResultError_string_
object
2 properties 2 required
Result_CountryData-Array.string_
ResultSuccess_UsersOverTime-Array_
object
2 properties 2 required
RequestCountBody
object
2 properties 1 required
ResultSuccess_Quantiles-Array_
object
2 properties 2 required
Partial_JobToOperators_
object
Make all properties in T optional
9 properties
Quantiles
object
5 properties 5 required
Partial_TimestampOperators_
object
Make all properties in T optional
5 properties
Partial_BooleanOperators_
object
Make all properties in T optional
1 property
Partial_NumberOperators_
object
Make all properties in T optional
6 properties
Result_ThreatsOverTime-Array.string_
ResultSuccess_LatencyOverTime-Array_
object
2 properties 2 required
TokensPerRequest
object
3 properties 3 required
Partial_RequestResponseLogToOperators_
object
Make all properties in T optional
11 properties
Partial_ExperimentToOperators_
object
Make all properties in T optional
2 properties
Result_CostOverTime-Array.string_
ErrorOverTime
object
2 properties 2 required
Partial_ExperimentHypothesisRunToOperator_
object
Make all properties in T optional
1 property
Result_number.string_
ResultSuccess_ThreatsOverTime-Array_
object
2 properties 2 required
QuantilesBody
object
5 properties 4 required
Result_RequestsOverTime-Array.string_
Result_TokensOverTime-Array.string_
FilterBranch
object
3 properties 3 required
ResultSuccess_ErrorOverTime-Array_
object
2 properties 2 required
Partial_RequestTableToOperators_
object
Make all properties in T optional
12 properties
Partial_NodesToOperators_
object
Make all properties in T optional
10 properties
TimeToFirstTokenOverTime
object
2 properties 2 required
Partial_TablesAndViews_
object
Make all properties in T optional
24 properties
LatencyOverTime
object
2 properties 2 required
ResultSuccess_RequestsOverTime-Array_
object
2 properties 2 required
Result_UsersOverTime-Array.string_
Partial_PropertyWithResponseV1ToOperators_
object
Make all properties in T optional
5 properties
Partial_RateLimitTableToOperators_
object
Make all properties in T optional
2 properties
ResultSuccess_ModelMetric-Array_
object
2 properties 2 required
Partial_PromptToOperators_
object
Make all properties in T optional
2 properties
ModelMetricsBody
object
4 properties 4 required
CostOverTime
object
2 properties 2 required
Result_ErrorOverTime-Array.string_
ResultSuccess_TokensPerRequest_
object
2 properties 2 required
Partial_PropertiesTableToOperators_
object
Make all properties in T optional
3 properties
Partial_UserViewToOperators_
object
Make all properties in T optional
10 properties
ThreatsOverTime
object
2 properties 2 required
ResultSuccess_CountryData-Array_
object
2 properties 2 required
Partial_RequestResponseRMTToOperators_
object
Make all properties in T optional
37 properties
Partial_SessionsRequestResponseRMTToOperators_
object
Make all properties in T optional
10 properties
Partial_ScoreValueToOperator_
object
Make all properties in T optional
1 property
Result_TimeToFirstTokenOverTime-Array.string_
Partial_UserApiKeysTableToOperators_
object
Make all properties in T optional
2 properties
Partial_ResponseTableToOperators_
object
Make all properties in T optional
5 properties
FilterNode
Partial_FeedbackTableToOperators_
object
Make all properties in T optional
4 properties
TimeIncrement
string
SingleKey_TablesAndViews_
Partial_PromptVersionsToOperators_
object
Make all properties in T optional
4 properties
Partial_CacheMetricsTableToOperators_
object
Make all properties in T optional
17 properties
Partial_OrganizationPropertiesToOperators_
object
Make all properties in T optional
2 properties
MetricsOverTimeBody
object
4 properties 3 required
FilterLeaf
ResultSuccess_CostOverTime-Array_
object
2 properties 2 required
ResultSuccess_TokensOverTime-Array_
object
2 properties 2 required
Result_TokensPerRequest.string_
ModelMetric
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-metrics-api-openapi.yml Raw ↑

Other APIs Helicone publishes across the network.

Helicone Agent API
Helicone API Key API
Helicone Comparison API
Helicone Credits API
Helicone Customer API
Helicone Dashboard API
Helicone Dataset API
Helicone Evals API
Helicone Evaluator API
Helicone Experiment API
Helicone HeliconeSql API
Helicone Integration API