Get run metrics

Get metrics for orchestration runs

POST /orchestration/runs/metrics

Get run metrics

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/runs/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAfter": "<string>",
  "createdBefore": "<string>"
}
'

import requests

url = "https://api.getcargo.io/v1/orchestration/runs/metrics"

payload = {
    "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAfter": "<string>",
    "createdBefore": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflowUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    releaseUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    batchUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    createdAfter: '<string>',
    createdBefore: '<string>'
  })
};

fetch('https://api.getcargo.io/v1/orchestration/runs/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcargo.io/v1/orchestration/runs/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workflowUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'releaseUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'batchUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'createdAfter' => '<string>',
    'createdBefore' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcargo.io/v1/orchestration/runs/metrics"

	payload := strings.NewReader("{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/orchestration/runs/metrics")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/runs/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "runMetrics": [
    {
      "nodeUuid": "<string>",
      "totalExecutionsCount": 123,
      "idleExecutionsCount": 123,
      "pendingExecutionsCount": 123,
      "runningExecutionsCount": 123,
      "successExecutionsCount": 123,
      "errorExecutionsCount": 123,
      "cancellingExecutionsCount": 123,
      "cancelledExecutionsCount": 123,
      "skippedExecutionsCount": 123,
      "creditsUsedCount": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

workflowUuid · string<uuid> · required

Workflow identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

releaseUuid · string<uuid>

Release identifier to filter by.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

batchUuid · string<uuid>

Batch identifier to filter by.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

createdAfter · string

Include runs created after this timestamp.

createdBefore · string

Include runs created before this timestamp.

Response

200

application/json

Successful response

runMetrics · Run metrics · object[] · required

Aggregated run metrics.

Show child attributes