Genai Spans Stats

Query chart-ready aggregations over agent spans.

POST /agents/spans/stats

Genai Spans Stats

cURL

curl --request POST \
  --url https://api.example.com/agents/spans/stats \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "query": {
    "$expr": {
      "$and": [
        {
          "$literal": "<string>"
        }
      ]
    }
  },
  "end": "2023-11-07T05:31:56Z",
  "granularity": 1,
  "timezone": "UTC",
  "group_by": [
    {
      "key": "<string>",
      "source": "field",
      "alias": "<string>"
    }
  ],
  "metrics": [
    {
      "alias": "<string>",
      "value": {
        "key": "<string>",
        "source": "field"
      },
      "aggregations": [],
      "percentiles": [
        123
      ]
    }
  ],
  "group_limit": 50,
  "bucket_by": {
    "type": "time"
  },
  "group_filters": [
    {
      "measure": {
        "alias": "<string>",
        "value": {
          "key": "<string>",
          "source": "field"
        },
        "filter": {
          "$expr": {
            "$and": [
              {
                "$literal": "<string>"
              }
            ]
          }
        }
      },
      "group_by": [
        {
          "key": "<string>",
          "source": "field",
          "alias": "<string>"
        }
      ],
      "min": 123,
      "max": 123
    }
  ]
}
'

import requests

url = "https://api.example.com/agents/spans/stats"

payload = {
    "project_id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "query": { "$expr": { "$and": [{ "$literal": "<string>" }] } },
    "end": "2023-11-07T05:31:56Z",
    "granularity": 1,
    "timezone": "UTC",
    "group_by": [
        {
            "key": "<string>",
            "source": "field",
            "alias": "<string>"
        }
    ],
    "metrics": [
        {
            "alias": "<string>",
            "value": {
                "key": "<string>",
                "source": "field"
            },
            "aggregations": [],
            "percentiles": [123]
        }
    ],
    "group_limit": 50,
    "bucket_by": { "type": "time" },
    "group_filters": [
        {
            "measure": {
                "alias": "<string>",
                "value": {
                    "key": "<string>",
                    "source": "field"
                },
                "filter": { "$expr": { "$and": [{ "$literal": "<string>" }] } }
            },
            "group_by": [
                {
                    "key": "<string>",
                    "source": "field",
                    "alias": "<string>"
                }
            ],
            "min": 123,
            "max": 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({
    project_id: '<string>',
    start: '2023-11-07T05:31:56Z',
    query: {$expr: {$and: [{$literal: '<string>'}]}},
    end: '2023-11-07T05:31:56Z',
    granularity: 1,
    timezone: 'UTC',
    group_by: [{key: '<string>', source: 'field', alias: '<string>'}],
    metrics: [
      {
        alias: '<string>',
        value: {key: '<string>', source: 'field'},
        aggregations: [],
        percentiles: [123]
      }
    ],
    group_limit: 50,
    bucket_by: {type: 'time'},
    group_filters: [
      {
        measure: {
          alias: '<string>',
          value: {key: '<string>', source: 'field'},
          filter: {$expr: {$and: [{$literal: '<string>'}]}}
        },
        group_by: [{key: '<string>', source: 'field', alias: '<string>'}],
        min: 123,
        max: 123
      }
    ]
  })
};

fetch('https://api.example.com/agents/spans/stats', 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/agents/spans/stats",
  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([
    'project_id' => '<string>',
    'start' => '2023-11-07T05:31:56Z',
    'query' => [
        '$expr' => [
                '$and' => [
                                [
                                                                '$literal' => '<string>'
                                ]
                ]
        ]
    ],
    'end' => '2023-11-07T05:31:56Z',
    'granularity' => 1,
    'timezone' => 'UTC',
    'group_by' => [
        [
                'key' => '<string>',
                'source' => 'field',
                'alias' => '<string>'
        ]
    ],
    'metrics' => [
        [
                'alias' => '<string>',
                'value' => [
                                'key' => '<string>',
                                'source' => 'field'
                ],
                'aggregations' => [
                                
                ],
                'percentiles' => [
                                123
                ]
        ]
    ],
    'group_limit' => 50,
    'bucket_by' => [
        'type' => 'time'
    ],
    'group_filters' => [
        [
                'measure' => [
                                'alias' => '<string>',
                                'value' => [
                                                                'key' => '<string>',
                                                                'source' => 'field'
                                ],
                                'filter' => [
                                                                '$expr' => [
                                                                                                                                '$and' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                '$literal' => '<string>'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'group_by' => [
                                [
                                                                'key' => '<string>',
                                                                'source' => 'field',
                                                                'alias' => '<string>'
                                ]
                ],
                'min' => 123,
                'max' => 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.example.com/agents/spans/stats"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"granularity\": 1,\n  \"timezone\": \"UTC\",\n  \"group_by\": [\n    {\n      \"key\": \"<string>\",\n      \"source\": \"field\",\n      \"alias\": \"<string>\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"alias\": \"<string>\",\n      \"value\": {\n        \"key\": \"<string>\",\n        \"source\": \"field\"\n      },\n      \"aggregations\": [],\n      \"percentiles\": [\n        123\n      ]\n    }\n  ],\n  \"group_limit\": 50,\n  \"bucket_by\": {\n    \"type\": \"time\"\n  },\n  \"group_filters\": [\n    {\n      \"measure\": {\n        \"alias\": \"<string>\",\n        \"value\": {\n          \"key\": \"<string>\",\n          \"source\": \"field\"\n        },\n        \"filter\": {\n          \"$expr\": {\n            \"$and\": [\n              {\n                \"$literal\": \"<string>\"\n              }\n            ]\n          }\n        }\n      },\n      \"group_by\": [\n        {\n          \"key\": \"<string>\",\n          \"source\": \"field\",\n          \"alias\": \"<string>\"\n        }\n      ],\n      \"min\": 123,\n      \"max\": 123\n    }\n  ]\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.example.com/agents/spans/stats")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"granularity\": 1,\n  \"timezone\": \"UTC\",\n  \"group_by\": [\n    {\n      \"key\": \"<string>\",\n      \"source\": \"field\",\n      \"alias\": \"<string>\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"alias\": \"<string>\",\n      \"value\": {\n        \"key\": \"<string>\",\n        \"source\": \"field\"\n      },\n      \"aggregations\": [],\n      \"percentiles\": [\n        123\n      ]\n    }\n  ],\n  \"group_limit\": 50,\n  \"bucket_by\": {\n    \"type\": \"time\"\n  },\n  \"group_filters\": [\n    {\n      \"measure\": {\n        \"alias\": \"<string>\",\n        \"value\": {\n          \"key\": \"<string>\",\n          \"source\": \"field\"\n        },\n        \"filter\": {\n          \"$expr\": {\n            \"$and\": [\n              {\n                \"$literal\": \"<string>\"\n              }\n            ]\n          }\n        }\n      },\n      \"group_by\": [\n        {\n          \"key\": \"<string>\",\n          \"source\": \"field\",\n          \"alias\": \"<string>\"\n        }\n      ],\n      \"min\": 123,\n      \"max\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/spans/stats")

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  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"granularity\": 1,\n  \"timezone\": \"UTC\",\n  \"group_by\": [\n    {\n      \"key\": \"<string>\",\n      \"source\": \"field\",\n      \"alias\": \"<string>\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"alias\": \"<string>\",\n      \"value\": {\n        \"key\": \"<string>\",\n        \"source\": \"field\"\n      },\n      \"aggregations\": [],\n      \"percentiles\": [\n        123\n      ]\n    }\n  ],\n  \"group_limit\": 50,\n  \"bucket_by\": {\n    \"type\": \"time\"\n  },\n  \"group_filters\": [\n    {\n      \"measure\": {\n        \"alias\": \"<string>\",\n        \"value\": {\n          \"key\": \"<string>\",\n          \"source\": \"field\"\n        },\n        \"filter\": {\n          \"$expr\": {\n            \"$and\": [\n              {\n                \"$literal\": \"<string>\"\n              }\n            ]\n          }\n        }\n      },\n      \"group_by\": [\n        {\n          \"key\": \"<string>\",\n          \"source\": \"field\",\n          \"alias\": \"<string>\"\n        }\n      ],\n      \"min\": 123,\n      \"max\": 123\n    }\n  ]\n}"

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

200

{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "granularity": 123,
  "bucket_type": "time",
  "columns": [
    {
      "name": "<string>",
      "metric": "<string>",
      "aggregation": "<string>"
    }
  ],
  "rows": [
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json

Request chart-ready aggregations over GenAI agent spans.

project_id · string · required

start · string<date-time> · required

query · Query · object | null

Show child attributes

end · string<date-time> | null

granularity · integer | null

Required range: x > 0

timezone · string · default: UTC

group_by · AgentGroupByRef · object[]

Show child attributes

metrics · AgentSpanStatsMetricSpec · object[]

Show child attributes

group_limit · integer · default: 50

Required range: 1 <= x <= 1000

bucket_by · AgentSpanStatsTimeBucketSpec · object

Bucket stats rows by started_at time intervals.

AgentSpanStatsTimeBucketSpec

AgentSpanStatsNumericBucketSpec

Show child attributes

group_filters · AgentSpanGroupFilter · object[]

Show child attributes

Response

200

application/json

Successful Response

Response containing chart-ready agent span stats rows.

start · string<date-time> · required

end · string<date-time> · required

timezone · string · required

granularity · integer | null

bucket_type · enum<string> · default: time

Available options: time, number

columns · AgentSpanStatsColumn · object[]

Show child attributes

rows · Rows · object[]

Show child attributes