Version 2.0

Json Experiment Series

GET/api/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/json

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Retrieve raw time-series data for a single series in JSON format. Results are paginated with a default page size of 200 and a maximum of 1000.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-read.

Path parameters

modelRid

string

The Resource Identifier (RID) of a Model.

experimentRid

string

The Resource Identifier (RID) of an Experiment.

experimentSeriesName

string

The name of a series (metrics tracked over time).

Query parameters

pageSize

integeroptional

Maximum number of values to return per page. Default is 200, maximum is 1000.

offset

integeroptional

Number of values to skip from the beginning. Defaults to 0.

preview

booleanoptional

Enables the use of preview functionality.

Response body

Series

union

A series of values logged over time.

Hide child attributes

doubleV1

objectoptional

A series of double values.

Show child attributes

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/json?preview=true"

Response

Copied!

{
  "type": "doubleV1",
  "series": [
    {
      "value": 0.42,
      "timestamp": 1715212800000,
      "step": 1
    }
  ]
}

Error responses

Error Name
`ExperimentSeriesNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested series was not found in the experiment.
	Parameters	`modelRid, experimentRid, seriesName`
`ModelExperimentNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested experiment was not found or the user lacks permission to access it.
	Parameters	`modelRid, experimentRid`
`JsonExperimentSeriesPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not json the ExperimentSeries.
	Parameters	`experimentSeriesName, experimentRid, modelRid`

See Errors for a general overview of errors in the platform.