Genai Custom Attrs Schema

Discover typed custom attribute keys on matching agent spans.

POST /agents/spans/custom-attrs/schema

Genai Custom Attrs Schema

cURL

curl --request POST \
  --url https://api.example.com/agents/spans/custom-attrs/schema \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "query": {
    "$expr": {
      "$and": [
        {
          "$literal": "<string>"
        }
      ]
    }
  },
  "started_after": "2023-11-07T05:31:56Z",
  "started_before": "2023-11-07T05:31:56Z",
  "limit": 200,
  "offset": 0
}
'

import requests

url = "https://api.example.com/agents/spans/custom-attrs/schema"

payload = {
    "project_id": "<string>",
    "query": { "$expr": { "$and": [{ "$literal": "<string>" }] } },
    "started_after": "2023-11-07T05:31:56Z",
    "started_before": "2023-11-07T05:31:56Z",
    "limit": 200,
    "offset": 0
}
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>',
    query: {$expr: {$and: [{$literal: '<string>'}]}},
    started_after: '2023-11-07T05:31:56Z',
    started_before: '2023-11-07T05:31:56Z',
    limit: 200,
    offset: 0
  })
};

fetch('https://api.example.com/agents/spans/custom-attrs/schema', 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/custom-attrs/schema",
  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>',
    'query' => [
        '$expr' => [
                '$and' => [
                                [
                                                                '$literal' => '<string>'
                                ]
                ]
        ]
    ],
    'started_after' => '2023-11-07T05:31:56Z',
    'started_before' => '2023-11-07T05:31:56Z',
    'limit' => 200,
    'offset' => 0
  ]),
  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/custom-attrs/schema"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"started_after\": \"2023-11-07T05:31:56Z\",\n  \"started_before\": \"2023-11-07T05:31:56Z\",\n  \"limit\": 200,\n  \"offset\": 0\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/custom-attrs/schema")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"started_after\": \"2023-11-07T05:31:56Z\",\n  \"started_before\": \"2023-11-07T05:31:56Z\",\n  \"limit\": 200,\n  \"offset\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/spans/custom-attrs/schema")

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  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"started_after\": \"2023-11-07T05:31:56Z\",\n  \"started_before\": \"2023-11-07T05:31:56Z\",\n  \"limit\": 200,\n  \"offset\": 0\n}"

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

200

{
  "attributes": [
    {
      "key": "<string>",
      "span_count": 123
    }
  ],
  "limit": 200,
  "offset": 0,
  "has_more": false
}

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

Body

application/json

Request to discover typed custom attribute keys for matching spans.

project_id · string · required

query · Query · object | null

Show child attributes

started_after · string<date-time> | null

started_before · string<date-time> | null

limit · integer · default: 200

Required range: 1 <= x <= 2000

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

Successful Response

Typed custom attribute keys available for spans query/group/stats APIs.

attributes · AgentCustomAttrSchemaItem · object[]

Show child attributes

limit · integer · default: 200

offset · integer · default: 0

has_more · boolean · default: false