Skip to main content
GET
/
v4
/
applications
/
{application_spec_id}
/
metrics
/
scalar
/
{metric_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const scalarData = await client.applications.metrics.scalar.retrieve('application_spec_id', 'total_requests');

console.log(scalarData.value);
{
  "value": 123,
  "unit": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string

Path Parameters

​
application_spec_id
string
required
​
metric_id
enum<string>
required
Available options:
total_requests,
total_errors,
total_tokens,
average_latency,
p95_latency,
error_rate,
average_users,
aggregated_tokens,
feedback,
execution_input_response_tokens,
execution_average_latency_per_variant,
execution_error_rate,
execution_latency_percentile,
execution_average_latency_per_node

Query Parameters

​
variants
string[]

Which variants to filter on

​
account_id
string

Account ID used for authorization

​
from_ts
integer

The starting (oldest) timestamp window in seconds.

​
to_ts
integer

The ending (most recent) timestamp in seconds.

Response

Successful Response

​
value
required
​
unit
string