Skip to main content
PUT
/
experiments
/
{id}
/
metrics
Error
A valid request URL is required to generate request examples
{
  "jobs": [
    {
      "state": "unknown",
      "jobId": "<string>",
      "jobConfig": {
        "id": "<string>"
      },
      "hostname": "<string>",
      "result": {
        "jobConfigId": "<string>",
        "jobRunId": "<string>",
        "docsWritten": 123,
        "exception": {
          "job": {
            "type": "APPKIT_APP",
            "id": "<string>",
            "canonicalName": "<string>",
            "uri": "<string>"
          },
          "jobRunId": "<string>",
          "httpStatusCode": 123,
          "error": "<string>",
          "message": "<string>",
          "details": "<string>",
          "cause": {
            "cause": "<unknown>",
            "stackTrace": [
              {
                "methodName": "<string>",
                "fileName": "<string>",
                "lineNumber": 123,
                "className": "<string>",
                "nativeMethod": false
              }
            ],
            "message": "<string>",
            "localizedMessage": "<string>",
            "suppressed": "<array>"
          },
          "stackTrace": [
            {
              "methodName": "<string>",
              "fileName": "<string>",
              "lineNumber": 123,
              "className": "<string>",
              "nativeMethod": false
            }
          ],
          "localizedMessage": "<string>",
          "suppressed": [
            {
              "cause": "<unknown>",
              "stackTrace": [
                {
                  "methodName": "<string>",
                  "fileName": "<string>",
                  "lineNumber": 123,
                  "className": "<string>",
                  "nativeMethod": false
                }
              ],
              "message": "<string>",
              "localizedMessage": "<string>",
              "suppressed": "<array>"
            }
          ],
          "httpStatusMessage": "<string>",
          "class": "<string>",
          "requestId": "<string>"
        }
      },
      "startTime": "<string>",
      "endTime": "<string>",
      "duration": 123
    }
  ]
}

Path Parameters

​
id
string
required

The experiment ID

Query Parameters

​
sync
boolean
default:false

When true, run the job synchronously; the request will not return until the metrics calculations jobs are complete

​
syncWaitSeconds
integer<int32>
default:300

The maximum amount of time to wait for metrics calculation jobs to complete, in seconds. Applicable only if syncis 'true'

Response

200 - application/json

successful operation

​
jobs
object[]