Runs

Get run metrics

Returns your organization’s finished runs over a window as points: one per hour or day in time_zone (and per group with group_by), each with the runs by how they ended, the success rate, the median and 95th percentile duration, what they cost and the model steps they took. A run counts in the bucket it finished in; runs still going are not counted. The window defaults to the last 7 days and may start at most a year back; hour buckets need a window of 7 days or less.

GET

runs

metrics

Get run metrics

curl --request GET \
  --url https://api.axilio.ai/api/v1/runs/metrics \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/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.axilio.ai/api/v1/runs/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$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.axilio.ai/api/v1/runs/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/runs/metrics")

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

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

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

{
  "points": [
    {
      "cancelled_runs": 123,
      "completed_runs": 123,
      "duration_p50_ms": 123,
      "duration_p95_ms": 123,
      "failed_runs": 123,
      "model_steps": 123,
      "period_start_at": "2023-11-07T05:31:56Z",
      "runs": 123,
      "success_rate": 0.5,
      "total_cost_microdollars": 123,
      "agent": "<string>",
      "device_class": "phone",
      "mode": "agent",
      "revision": "<string>",
      "schedule": "<string>",
      "status": "completed",
      "trigger": "manual"
    }
  ]
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Query Parameters

period_start_at

string<date-time>

Start of the window (RFC 3339). Defaults to 7 days before period_end_at, and may be at most a year before now.

period_end_at

string<date-time>

End of the window (RFC 3339). Defaults to now, and a later time is read as now.

granularity

enum<string>

default:day

Bucket size: hour or day. hour is allowed for windows of 7 days or less.

Available options:

hour,

day

time_zone

string

default:UTC

IANA time zone the buckets follow, such as America/Los_Angeles: a day starts at local midnight and an hour on the local hour. An unknown name is an error.

group_by

enum<string>

Split each bucket by agent, revision, status, trigger, mode, schedule or device_class. Omit for one point per bucket.

Available options:

agent,

revision,

status,

trigger,

mode,

schedule,

device_class

Response

Finished runs over the window, one point per bucket (and per group with group_by).

points

object[] | null

required

One point per bucket, oldest first, and per group within a bucket when grouped. The first bucket starts at or before period_start_at.

Show child attributes

Get run metrics

curl --request GET \
  --url https://api.axilio.ai/api/v1/runs/metrics \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/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.axilio.ai/api/v1/runs/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$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.axilio.ai/api/v1/runs/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/runs/metrics")

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

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

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

{
  "points": [
    {
      "cancelled_runs": 123,
      "completed_runs": 123,
      "duration_p50_ms": 123,
      "duration_p95_ms": 123,
      "failed_runs": 123,
      "model_steps": 123,
      "period_start_at": "2023-11-07T05:31:56Z",
      "runs": 123,
      "success_rate": 0.5,
      "total_cost_microdollars": 123,
      "agent": "<string>",
      "device_class": "phone",
      "mode": "agent",
      "revision": "<string>",
      "schedule": "<string>",
      "status": "completed",
      "trigger": "manual"
    }
  ]
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Argus API

Get run metrics

Authorizations

Query Parameters

Response