Count traces

Count orchestration traces matching the filter.

POST /orchestration/traces/count

Count traces

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/traces/count \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startedAfter": "<string>",
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statuses": [],
  "startedBefore": "<string>"
}
'

import requests

url = "https://api.getcargo.io/v1/orchestration/traces/count"

payload = {
    "startedAfter": "<string>",
    "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "statuses": [],
    "startedBefore": "<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({
    startedAfter: '<string>',
    workflowUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    statuses: [],
    startedBefore: '<string>'
  })
};

fetch('https://api.getcargo.io/v1/orchestration/traces/count', 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/traces/count",
  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([
    'startedAfter' => '<string>',
    'workflowUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'statuses' => [
        
    ],
    'startedBefore' => '<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/traces/count"

	payload := strings.NewReader("{\n  \"startedAfter\": \"<string>\",\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statuses\": [],\n  \"startedBefore\": \"<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/traces/count")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startedAfter\": \"<string>\",\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statuses\": [],\n  \"startedBefore\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/traces/count")

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  \"startedAfter\": \"<string>\",\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statuses\": [],\n  \"startedBefore\": \"<string>\"\n}"

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

200

{
  "count": 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.

startedAfter · string · required

Include traces whose first execution started after this timestamp (ISO string). Required.

workflowUuid · string<uuid>

When set, restrict traces to this workflow. Omit to search across workflows in the workspace.

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})$

statuses · enum<string>[]

Filter traces by their derived status (pending if any span anywhere in the trace is still pending, error if any of the root run's spans has errored, otherwise success).

Available options: pending, error, success

startedBefore · string

Include traces whose first execution started on or before this timestamp (ISO string).

Response

200

application/json

Successful response

count · number · required

Number of traces matching the filter.