Count spans

Count orchestration execution spans

POST /orchestration/spans/count

Count spans

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/spans/count \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "executionStartedAfter": "<string>",
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recordId": "<string>",
  "recordTitle": "<string>",
  "recordTitleOrId": "<string>",
  "parentRunUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentNodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentAgentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodeSlug": "<string>",
  "nodeIntegrationSlug": "<string>",
  "nodeConnectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodeActionSlug": "<string>",
  "nodeToolUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodeAgentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodeReleaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "executionTitle": "<string>",
  "executionStatuses": [],
  "executionStartedBefore": "<string>"
}
'

import requests

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

payload = {
    "executionStartedAfter": "<string>",
    "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "runUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recordId": "<string>",
    "recordTitle": "<string>",
    "recordTitleOrId": "<string>",
    "parentRunUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentNodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentAgentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nodeSlug": "<string>",
    "nodeIntegrationSlug": "<string>",
    "nodeConnectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nodeActionSlug": "<string>",
    "nodeToolUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nodeAgentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nodeReleaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "executionTitle": "<string>",
    "executionStatuses": [],
    "executionStartedBefore": "<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({
    executionStartedAfter: '<string>',
    workflowUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    userUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    batchUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    runUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    recordId: '<string>',
    recordTitle: '<string>',
    recordTitleOrId: '<string>',
    parentRunUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parentNodeUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parentAgentUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    nodeUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    nodeSlug: '<string>',
    nodeIntegrationSlug: '<string>',
    nodeConnectorUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    nodeActionSlug: '<string>',
    nodeToolUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    nodeAgentUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    nodeReleaseUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    executionTitle: '<string>',
    executionStatuses: [],
    executionStartedBefore: '<string>'
  })
};

fetch('https://api.getcargo.io/v1/orchestration/spans/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/spans/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([
    'executionStartedAfter' => '<string>',
    'workflowUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'userUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'batchUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'runUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'recordId' => '<string>',
    'recordTitle' => '<string>',
    'recordTitleOrId' => '<string>',
    'parentRunUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parentNodeUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parentAgentUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'nodeUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'nodeSlug' => '<string>',
    'nodeIntegrationSlug' => '<string>',
    'nodeConnectorUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'nodeActionSlug' => '<string>',
    'nodeToolUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'nodeAgentUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'nodeReleaseUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'executionTitle' => '<string>',
    'executionStatuses' => [
        
    ],
    'executionStartedBefore' => '<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/spans/count"

	payload := strings.NewReader("{\n  \"executionStartedAfter\": \"<string>\",\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"userUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"runUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"recordId\": \"<string>\",\n  \"recordTitle\": \"<string>\",\n  \"recordTitleOrId\": \"<string>\",\n  \"parentRunUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentNodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentAgentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeSlug\": \"<string>\",\n  \"nodeIntegrationSlug\": \"<string>\",\n  \"nodeConnectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeActionSlug\": \"<string>\",\n  \"nodeToolUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeAgentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeReleaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"executionTitle\": \"<string>\",\n  \"executionStatuses\": [],\n  \"executionStartedBefore\": \"<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/spans/count")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"executionStartedAfter\": \"<string>\",\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"userUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"runUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"recordId\": \"<string>\",\n  \"recordTitle\": \"<string>\",\n  \"recordTitleOrId\": \"<string>\",\n  \"parentRunUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentNodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentAgentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeSlug\": \"<string>\",\n  \"nodeIntegrationSlug\": \"<string>\",\n  \"nodeConnectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeActionSlug\": \"<string>\",\n  \"nodeToolUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeAgentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeReleaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"executionTitle\": \"<string>\",\n  \"executionStatuses\": [],\n  \"executionStartedBefore\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/spans/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  \"executionStartedAfter\": \"<string>\",\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"userUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"runUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"recordId\": \"<string>\",\n  \"recordTitle\": \"<string>\",\n  \"recordTitleOrId\": \"<string>\",\n  \"parentRunUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentNodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentAgentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeSlug\": \"<string>\",\n  \"nodeIntegrationSlug\": \"<string>\",\n  \"nodeConnectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeActionSlug\": \"<string>\",\n  \"nodeToolUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeAgentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nodeReleaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"executionTitle\": \"<string>\",\n  \"executionStatuses\": [],\n  \"executionStartedBefore\": \"<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.

executionStartedAfter · string · required

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

workflowUuid · string<uuid>

When set, restrict spans 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})$

userUuid · string<uuid>

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

runUuid · string<uuid>

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

recordId · string

Record ID to filter by.

recordTitle · string

Record title to filter by (SQL ilike).

recordTitleOrId · string

Match record id or record title (each SQL ilike); same pattern as run list.

parentRunUuid · string<uuid>

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

parentNodeUuid · string<uuid>

Filter by parent node UUID on the run.

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

parentAgentUuid · string<uuid>

When set, restrict spans to rows whose parent agent matches this UUID.

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

nodeUuid · string<uuid>

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

nodeKind · enum<string>

Filter by node kind (native, connector, tool, agent).

Available options: native, connector, tool, agent

nodeSlug · string

Filter by workflow node slug (exact match).

nodeIntegrationSlug · string

Filter by connector integration slug (exact match).

nodeConnectorUuid · string<uuid>

Filter by connector UUID.

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

nodeActionSlug · string

Filter by node action slug (exact match).

nodeToolUuid · string<uuid>

Filter by tool node UUID.

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

nodeAgentUuid · string<uuid>

Filter by agent node UUID.

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

nodeReleaseUuid · string<uuid>

Filter by release UUID referenced on the node.

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

executionTitle · string

Filter by execution title (SQL ilike).

executionStatuses · enum<string>[]

Execution statuses to include.

Available options: pending, success, error

executionStartedBefore · string

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

Response

200

application/json

Successful response

count · number · required

Number of spans matching the filter.