Skip to main content
POST
/
api
/
v1
/
runtime
/
v1
/
observability
/
events
/
query
Query events as a table (SDK)
curl --request POST \
  --url https://api.runflow.ai/api/v1/runtime/v1/observability/events/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventName": "<string>",
  "agentId": "<string>",
  "mode": "raw",
  "columns": [
    "<string>"
  ],
  "groupBy": "<string>",
  "metrics": [
    {
      "alias": "<string>",
      "propertyKey": "<string>"
    }
  ],
  "filters": [
    {
      "propertyKey": "<string>",
      "value": "<unknown>"
    }
  ],
  "dateFrom": "2023-11-07T05:31:56Z",
  "dateTo": "2023-11-07T05:31:56Z",
  "sortBy": "<string>",
  "limit": 123,
  "offset": 123
}
'
import requests

url = "https://api.runflow.ai/api/v1/runtime/v1/observability/events/query"

payload = {
"eventName": "<string>",
"agentId": "<string>",
"mode": "raw",
"columns": ["<string>"],
"groupBy": "<string>",
"metrics": [
{
"alias": "<string>",
"propertyKey": "<string>"
}
],
"filters": [
{
"propertyKey": "<string>",
"value": "<unknown>"
}
],
"dateFrom": "2023-11-07T05:31:56Z",
"dateTo": "2023-11-07T05:31:56Z",
"sortBy": "<string>",
"limit": 123,
"offset": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
eventName: '<string>',
agentId: '<string>',
mode: 'raw',
columns: ['<string>'],
groupBy: '<string>',
metrics: [{alias: '<string>', propertyKey: '<string>'}],
filters: [{propertyKey: '<string>', value: '<unknown>'}],
dateFrom: '2023-11-07T05:31:56Z',
dateTo: '2023-11-07T05:31:56Z',
sortBy: '<string>',
limit: 123,
offset: 123
})
};

fetch('https://api.runflow.ai/api/v1/runtime/v1/observability/events/query', 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.runflow.ai/api/v1/runtime/v1/observability/events/query",
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([
'eventName' => '<string>',
'agentId' => '<string>',
'mode' => 'raw',
'columns' => [
'<string>'
],
'groupBy' => '<string>',
'metrics' => [
[
'alias' => '<string>',
'propertyKey' => '<string>'
]
],
'filters' => [
[
'propertyKey' => '<string>',
'value' => '<unknown>'
]
],
'dateFrom' => '2023-11-07T05:31:56Z',
'dateTo' => '2023-11-07T05:31:56Z',
'sortBy' => '<string>',
'limit' => 123,
'offset' => 123
]),
CURLOPT_HTTPHEADER => [
"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.runflow.ai/api/v1/runtime/v1/observability/events/query"

payload := strings.NewReader("{\n \"eventName\": \"<string>\",\n \"agentId\": \"<string>\",\n \"mode\": \"raw\",\n \"columns\": [\n \"<string>\"\n ],\n \"groupBy\": \"<string>\",\n \"metrics\": [\n {\n \"alias\": \"<string>\",\n \"propertyKey\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"propertyKey\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"dateFrom\": \"2023-11-07T05:31:56Z\",\n \"dateTo\": \"2023-11-07T05:31:56Z\",\n \"sortBy\": \"<string>\",\n \"limit\": 123,\n \"offset\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

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.runflow.ai/api/v1/runtime/v1/observability/events/query")
.header("Content-Type", "application/json")
.body("{\n \"eventName\": \"<string>\",\n \"agentId\": \"<string>\",\n \"mode\": \"raw\",\n \"columns\": [\n \"<string>\"\n ],\n \"groupBy\": \"<string>\",\n \"metrics\": [\n {\n \"alias\": \"<string>\",\n \"propertyKey\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"propertyKey\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"dateFrom\": \"2023-11-07T05:31:56Z\",\n \"dateTo\": \"2023-11-07T05:31:56Z\",\n \"sortBy\": \"<string>\",\n \"limit\": 123,\n \"offset\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.runflow.ai/api/v1/runtime/v1/observability/events/query")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventName\": \"<string>\",\n \"agentId\": \"<string>\",\n \"mode\": \"raw\",\n \"columns\": [\n \"<string>\"\n ],\n \"groupBy\": \"<string>\",\n \"metrics\": [\n {\n \"alias\": \"<string>\",\n \"propertyKey\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"propertyKey\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"dateFrom\": \"2023-11-07T05:31:56Z\",\n \"dateTo\": \"2023-11-07T05:31:56Z\",\n \"sortBy\": \"<string>\",\n \"limit\": 123,\n \"offset\": 123\n}"

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

Body

application/json
eventName
string
required
agentId
string

Agent UUID. Defaults to the agent bound to the API key when omitted.

mode
enum<string>
default:raw
Available options:
raw,
aggregate
columns
string[]
groupBy
string
metrics
object[]
filters
object[]
dateFrom
string<date-time>
dateTo
string<date-time>
sortBy
string
sortOrder
enum<string>
Available options:
asc,
desc
limit
integer
offset
integer

Response

Query result.