List Run Events

Returns a paginated JSON list of stored run events. Ascending order uses since_seq as an inclusive cursor. Descending order uses before_seq as an exclusive cursor and starts at the newest event when before_seq is omitted.

GET /api/v1/runs/{id}/events

List Run Events

cURL

curl --request GET \
  --url https://api.example.com/api/v1/runs/{id}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/runs/{id}/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/runs/{id}/events', 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.example.com/api/v1/runs/{id}/events",
  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: Bearer <token>"
  ],
]);

$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.example.com/api/v1/runs/{id}/events"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.example.com/api/v1/runs/{id}/events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/runs/{id}/events")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "data": [
    {
      "seq": 42,
      "id": "<string>",
      "ts": "2023-11-07T05:31:56Z",
      "run_id": "<string>",
      "event": "stage.started",
      "node_id": "<string>",
      "node_label": "<string>",
      "stage_id": "<string>",
      "parallel_group_id": "<string>",
      "parallel_branch_id": "review_fork@3:1",
      "session_id": "<string>",
      "parent_session_id": "<string>",
      "tool_call_id": "<string>",
      "actor": {
        "kind": "user",
        "identity": {
          "issuer": "<string>",
          "subject": "<string>"
        },
        "login": "<string>",
        "avatar_url": "<string>"
      },
      "properties": {}
    }
  ],
  "meta": {
    "has_more": true,
    "total": true
  }
}

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "Run not found.",
      "code": "access_token_expired",
      "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "leftover_env_keys": [
    "<string>"
  ],
  "removed_env_keys": [
    "<string>"
  ]
}

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "Run not found.",
      "code": "access_token_expired",
      "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "leftover_env_keys": [
    "<string>"
  ],
  "removed_env_keys": [
    "<string>"
  ]
}

Authorizations

BearerAuthSessionCookie

Authorization · string · header · required

Raw dev token passed as Authorization: Bearer fabro_dev_... when server.auth.methods includes dev-token.

Path Parameters

id · string · required

Unique run identifier (ULID).

Query Parameters

since_seq · integer · default: 1

First event sequence number to include.

Required range: x >= 1

limit · integer · default: 100

Maximum number of events to return.

Required range: 1 <= x <= 1000

before_seq · integer

Exclusive upper event sequence cursor for descending order. Omit on the first descending request to start from the newest event.

Required range: x >= 1

order · enum<string> · default: asc

Event sequence order. since_seq is valid only with asc; before_seq is valid only with desc.

Available options: asc, desc

Response

200

application/json

Paginated list of run events

Paginated list of stored run events.

data · object[] · required

Show child attributes

meta · object · required

Pagination metadata included in every paginated response.

Show child attributes