Workflows
Get the workflows overview
Returns a numbered or cursor page of goals with their latest runs, pending attention, connections, and savings aggregates. The response total counts every goal matching the filters, before pagination.
GET
/
api
/
v1
/
tenant
/
automation
/
overview
Get the workflows overview
curl --request GET \
--url https://api.costgraph.ai/api/v1/tenant/automation/overview \
--header 'Authorization: <api-key>' \
--header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'import requests
url = "https://api.costgraph.ai/api/v1/tenant/automation/overview"
headers = {
"X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};
fetch('https://api.costgraph.ai/api/v1/tenant/automation/overview', 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.costgraph.ai/api/v1/tenant/automation/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.costgraph.ai/api/v1/tenant/automation/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.costgraph.ai/api/v1/tenant/automation/overview")
.header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/automation/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"goals": [
{
"allowed_connection_ids": [
"<string>"
],
"goal": {
"autonomy_envelope": {},
"budgets": {},
"constraints": {},
"created_at": "<string>",
"goal_id": "<string>",
"name": "<string>",
"objective": "<string>",
"revision": 123,
"revision_id": "<string>",
"scope": {},
"status": "active",
"trigger_policy": {},
"updated_at": "<string>",
"schedule": {
"kind": "once",
"state": "armed",
"cadence": "<string>",
"last_fired_at": "<string>",
"localTime": "<string>",
"monthWeek": 123,
"next_run_at": "<string>",
"timezone": "<string>",
"weekday": 123
},
"specification": {
"allowedCategories": [
"<string>"
],
"allowedConnectionIds": [
"<string>"
],
"approval": {
"mode": "every_change"
},
"exclusions": [
{
"key": "<string>",
"kind": "tag",
"value": "<string>"
}
],
"limits": {
"maxActiveRuntimeSeconds": 123,
"maxDecisions": 123
},
"schedule": {
"kind": "once",
"cadence": "<string>",
"localTime": "<string>",
"monthWeek": 123,
"timezone": "<string>",
"weekday": 123
}
}
},
"pending_attention_count": 123,
"savings": [
{
"active_estimated_monthly_cents": 123,
"currency": "<string>",
"estimated_accrued_savings_cents": 123,
"pending_projected_monthly_cents": 123
}
],
"used_connection_ids": [
"<string>"
],
"latest_run": {
"active_runtime_used_milliseconds": 123,
"allowed_connection_ids": [
"<string>"
],
"created_at": "<string>",
"decisions_used": 123,
"goal_id": "<string>",
"goal_name": "<string>",
"goal_revision_id": "<string>",
"max_decisions": 123,
"objective": "<string>",
"run_id": "<string>",
"savings": [
{
"active_estimated_monthly_cents": 123,
"currency": "<string>",
"estimated_accrued_savings_cents": 123,
"pending_projected_monthly_cents": 123
}
],
"status": "queued",
"summary": "<string>",
"trigger": {},
"updated_at": "<string>",
"used_connection_ids": [
"<string>"
],
"continued_from_run_id": "<string>",
"duration_milliseconds": 123,
"finished_at": "<string>",
"max_active_runtime_seconds": 123,
"outcome": "advanced",
"started_at": "<string>",
"timed_out_at": "<string>"
}
}
],
"pending_attention": [
{
"checkpoint_id": "<string>",
"created_at": "<string>",
"goal_id": "<string>",
"goal_name": "<string>",
"node_id": "<string>",
"options": [
"<string>"
],
"prompt": "<string>",
"run_id": "<string>",
"status": "pending",
"type": "context",
"version": 123,
"blocker": {
"kind": "connection_missing",
"message": "<string>",
"provider": "<string>",
"retryable": true,
"capabilityId": "<string>",
"code": "<string>",
"connectionId": "<string>",
"operation": "<string>",
"remediation": {
"kind": "reconnect",
"instructions": "<string>",
"url": "<string>"
}
},
"effect": {
"effect_hash": "<string>",
"effective_risk_tier": 123,
"estimated_cost_cents": 123,
"canonical_input": {},
"capability_connection_id": "<string>",
"capability_id": "<string>",
"capability_version": "<string>",
"categories": [
"<string>"
],
"connection_id": "<string>",
"effect_bundle_id": "<string>",
"effect_segment_id": "<string>",
"effects": "<array>",
"financial_impacts": [
{
"asOf": "<string>",
"basis": "<string>",
"currency": "<string>",
"kind": "recurring_savings",
"sourceObservationId": "<string>",
"amountCents": 123,
"confidence": 123,
"monthlyCents": 123,
"sourceRecommendationId": "<string>"
}
],
"preconditions": [
{}
],
"recovery": {},
"segment_hash": "<string>",
"summary": "<string>",
"targets": [
{}
],
"verification": {}
},
"expires_at": "<string>"
}
],
"pending_attention_count": 123,
"savings": [
{
"active_estimated_monthly_cents": 123,
"currency": "<string>",
"estimated_accrued_savings_cents": 123,
"pending_projected_monthly_cents": 123
}
],
"total": 123,
"next_cursor": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}Authorizations
Enter "Bearer {token}"
Headers
Tenant ID
Query Parameters
Goal status filters
Latest run status filters
Only goals that do or do not need attention
Page size (1-100)
1-based page number; cannot be combined with cursor
Opaque pagination cursor
Was this page helpful?
⌘I
Get the workflows overview
curl --request GET \
--url https://api.costgraph.ai/api/v1/tenant/automation/overview \
--header 'Authorization: <api-key>' \
--header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'import requests
url = "https://api.costgraph.ai/api/v1/tenant/automation/overview"
headers = {
"X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};
fetch('https://api.costgraph.ai/api/v1/tenant/automation/overview', 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.costgraph.ai/api/v1/tenant/automation/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.costgraph.ai/api/v1/tenant/automation/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.costgraph.ai/api/v1/tenant/automation/overview")
.header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/automation/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"goals": [
{
"allowed_connection_ids": [
"<string>"
],
"goal": {
"autonomy_envelope": {},
"budgets": {},
"constraints": {},
"created_at": "<string>",
"goal_id": "<string>",
"name": "<string>",
"objective": "<string>",
"revision": 123,
"revision_id": "<string>",
"scope": {},
"status": "active",
"trigger_policy": {},
"updated_at": "<string>",
"schedule": {
"kind": "once",
"state": "armed",
"cadence": "<string>",
"last_fired_at": "<string>",
"localTime": "<string>",
"monthWeek": 123,
"next_run_at": "<string>",
"timezone": "<string>",
"weekday": 123
},
"specification": {
"allowedCategories": [
"<string>"
],
"allowedConnectionIds": [
"<string>"
],
"approval": {
"mode": "every_change"
},
"exclusions": [
{
"key": "<string>",
"kind": "tag",
"value": "<string>"
}
],
"limits": {
"maxActiveRuntimeSeconds": 123,
"maxDecisions": 123
},
"schedule": {
"kind": "once",
"cadence": "<string>",
"localTime": "<string>",
"monthWeek": 123,
"timezone": "<string>",
"weekday": 123
}
}
},
"pending_attention_count": 123,
"savings": [
{
"active_estimated_monthly_cents": 123,
"currency": "<string>",
"estimated_accrued_savings_cents": 123,
"pending_projected_monthly_cents": 123
}
],
"used_connection_ids": [
"<string>"
],
"latest_run": {
"active_runtime_used_milliseconds": 123,
"allowed_connection_ids": [
"<string>"
],
"created_at": "<string>",
"decisions_used": 123,
"goal_id": "<string>",
"goal_name": "<string>",
"goal_revision_id": "<string>",
"max_decisions": 123,
"objective": "<string>",
"run_id": "<string>",
"savings": [
{
"active_estimated_monthly_cents": 123,
"currency": "<string>",
"estimated_accrued_savings_cents": 123,
"pending_projected_monthly_cents": 123
}
],
"status": "queued",
"summary": "<string>",
"trigger": {},
"updated_at": "<string>",
"used_connection_ids": [
"<string>"
],
"continued_from_run_id": "<string>",
"duration_milliseconds": 123,
"finished_at": "<string>",
"max_active_runtime_seconds": 123,
"outcome": "advanced",
"started_at": "<string>",
"timed_out_at": "<string>"
}
}
],
"pending_attention": [
{
"checkpoint_id": "<string>",
"created_at": "<string>",
"goal_id": "<string>",
"goal_name": "<string>",
"node_id": "<string>",
"options": [
"<string>"
],
"prompt": "<string>",
"run_id": "<string>",
"status": "pending",
"type": "context",
"version": 123,
"blocker": {
"kind": "connection_missing",
"message": "<string>",
"provider": "<string>",
"retryable": true,
"capabilityId": "<string>",
"code": "<string>",
"connectionId": "<string>",
"operation": "<string>",
"remediation": {
"kind": "reconnect",
"instructions": "<string>",
"url": "<string>"
}
},
"effect": {
"effect_hash": "<string>",
"effective_risk_tier": 123,
"estimated_cost_cents": 123,
"canonical_input": {},
"capability_connection_id": "<string>",
"capability_id": "<string>",
"capability_version": "<string>",
"categories": [
"<string>"
],
"connection_id": "<string>",
"effect_bundle_id": "<string>",
"effect_segment_id": "<string>",
"effects": "<array>",
"financial_impacts": [
{
"asOf": "<string>",
"basis": "<string>",
"currency": "<string>",
"kind": "recurring_savings",
"sourceObservationId": "<string>",
"amountCents": 123,
"confidence": 123,
"monthlyCents": 123,
"sourceRecommendationId": "<string>"
}
],
"preconditions": [
{}
],
"recovery": {},
"segment_hash": "<string>",
"summary": "<string>",
"targets": [
{}
],
"verification": {}
},
"expires_at": "<string>"
}
],
"pending_attention_count": 123,
"savings": [
{
"active_estimated_monthly_cents": 123,
"currency": "<string>",
"estimated_accrued_savings_cents": 123,
"pending_projected_monthly_cents": 123
}
],
"total": 123,
"next_cursor": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}