GET
/
v4
/
applications
/
{application_spec_id}
/
metrics
/
scalar
/
{metric_id}
import SGPClient from 'sgp';

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

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

  console.log(scalarData.value);
}

main();
{
  "value": 123,
  "unit": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

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_faithfulness,
average_relevance,
average_users,
aggregated_tokens,
feedback,
engagement_faithfulness,
engagement_relevance,
execution_input_response_tokens,
execution_average_latency_per_variant,
execution_error_rate,
execution_latency_percentile,
execution_average_latency_per_node,
total_guardrail_triggers,
guardrail_triggers_timeseries,
guardrail_severity_timeseries

Query Parameters

​
variants
string[] | null

Which variants to filter on

​
account_id
string | null

Account ID used for authorization

​
from_ts
integer
default:
1739915688

The starting (oldest) timestamp window in seconds.

Required range: x > 1
​
to_ts
integer
default:
1740002088

The ending (most recent) timestamp in seconds.

Required range: x > 1

Response

200
application/json
Successful Response
​
value
required
​
unit
string
Get Dashboard SchemaGet Timeseries Metric