Job

Sets a metric for a Job

Changed on Sep 30, 2026

post/api/v1/jobs/{id}/metrics

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/usnistgov/apis/dioptra-rest-api/docs/api/v1/jobs/:id/metrics/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Fieldsstring mask

An optional fields mask

Request body

namestring required

The name of the metric.

valuenumber required

The value of the metric. Can be a float, NaN, Infinity, or -Infinity. NaN values are represented with the string "nan" and infinite values are represented with the strings "inf" and "-inf".

stepinteger

The step value for the metric, optional. Sequentially increasing step values are used to track how a metric changes over time. Indexed from 0. If not provided, defaults to 0.

timestampstring date-time

A timestamp value to associate with the metric. If not provided, defaults to the server time when the metric is received.

Response

Success