メインコンテンツへスキップ
POST
/
trace
/
usage
トレース使用量
curl --request POST \
  --url https://api.example.com/trace/usage \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filter": {
    "call_ids": [
      "<string>"
    ],
    "input_refs": [
      "<string>"
    ],
    "op_names": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "parent_ids": [
      "<string>"
    ],
    "thread_ids": [
      "<string>"
    ],
    "trace_ids": [
      "<string>"
    ],
    "trace_roots_only": true,
    "turn_ids": [
      "<string>"
    ],
    "wb_run_ids": [
      "<string>"
    ],
    "wb_user_ids": [
      "<string>"
    ]
  },
  "include_costs": false,
  "limit": 10000,
  "query": {
    "$expr": {
      "$and": [
        {
          "$literal": "<string>"
        }
      ]
    }
  }
}
'
import requests

url = "https://api.example.com/trace/usage"

payload = {
    "project_id": "<string>",
    "filter": {
        "call_ids": ["<string>"],
        "input_refs": ["<string>"],
        "op_names": ["<string>"],
        "output_refs": ["<string>"],
        "parent_ids": ["<string>"],
        "thread_ids": ["<string>"],
        "trace_ids": ["<string>"],
        "trace_roots_only": True,
        "turn_ids": ["<string>"],
        "wb_run_ids": ["<string>"],
        "wb_user_ids": ["<string>"]
    },
    "include_costs": False,
    "limit": 10000,
    "query": { "$expr": { "$and": [{ "$literal": "<string>" }] } }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    filter: {
      call_ids: ['<string>'],
      input_refs: ['<string>'],
      op_names: ['<string>'],
      output_refs: ['<string>'],
      parent_ids: ['<string>'],
      thread_ids: ['<string>'],
      trace_ids: ['<string>'],
      trace_roots_only: true,
      turn_ids: ['<string>'],
      wb_run_ids: ['<string>'],
      wb_user_ids: ['<string>']
    },
    include_costs: false,
    limit: 10000,
    query: {$expr: {$and: [{$literal: '<string>'}]}}
  })
};

fetch('https://api.example.com/trace/usage', 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/trace/usage",
  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>',
    'filter' => [
        'call_ids' => [
                '<string>'
        ],
        'input_refs' => [
                '<string>'
        ],
        'op_names' => [
                '<string>'
        ],
        'output_refs' => [
                '<string>'
        ],
        'parent_ids' => [
                '<string>'
        ],
        'thread_ids' => [
                '<string>'
        ],
        'trace_ids' => [
                '<string>'
        ],
        'trace_roots_only' => true,
        'turn_ids' => [
                '<string>'
        ],
        'wb_run_ids' => [
                '<string>'
        ],
        'wb_user_ids' => [
                '<string>'
        ]
    ],
    'include_costs' => false,
    'limit' => 10000,
    'query' => [
        '$expr' => [
                '$and' => [
                                [
                                                                '$literal' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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/trace/usage"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"call_ids\": [\n      \"<string>\"\n    ],\n    \"input_refs\": [\n      \"<string>\"\n    ],\n    \"op_names\": [\n      \"<string>\"\n    ],\n    \"output_refs\": [\n      \"<string>\"\n    ],\n    \"parent_ids\": [\n      \"<string>\"\n    ],\n    \"thread_ids\": [\n      \"<string>\"\n    ],\n    \"trace_ids\": [\n      \"<string>\"\n    ],\n    \"trace_roots_only\": true,\n    \"turn_ids\": [\n      \"<string>\"\n    ],\n    \"wb_run_ids\": [\n      \"<string>\"\n    ],\n    \"wb_user_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"include_costs\": false,\n  \"limit\": 10000,\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  }\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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/trace/usage")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"call_ids\": [\n      \"<string>\"\n    ],\n    \"input_refs\": [\n      \"<string>\"\n    ],\n    \"op_names\": [\n      \"<string>\"\n    ],\n    \"output_refs\": [\n      \"<string>\"\n    ],\n    \"parent_ids\": [\n      \"<string>\"\n    ],\n    \"thread_ids\": [\n      \"<string>\"\n    ],\n    \"trace_ids\": [\n      \"<string>\"\n    ],\n    \"trace_roots_only\": true,\n    \"turn_ids\": [\n      \"<string>\"\n    ],\n    \"wb_run_ids\": [\n      \"<string>\"\n    ],\n    \"wb_user_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"include_costs\": false,\n  \"limit\": 10000,\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/trace/usage")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"call_ids\": [\n      \"<string>\"\n    ],\n    \"input_refs\": [\n      \"<string>\"\n    ],\n    \"op_names\": [\n      \"<string>\"\n    ],\n    \"output_refs\": [\n      \"<string>\"\n    ],\n    \"parent_ids\": [\n      \"<string>\"\n    ],\n    \"thread_ids\": [\n      \"<string>\"\n    ],\n    \"trace_ids\": [\n      \"<string>\"\n    ],\n    \"trace_roots_only\": true,\n    \"turn_ids\": [\n      \"<string>\"\n    ],\n    \"wb_run_ids\": [\n      \"<string>\"\n    ],\n    \"wb_user_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"include_costs\": false,\n  \"limit\": 10000,\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "call_usage": {},
  "unfinished_call_ids": [
    "<string>"
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

承認

​
Authorization
string
header
必須

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

ボディ

application/json

子孫のロールアップを含めて、trace の call ごとの使用量を計算するためのリクエストです。

この Endpoint は、trace 内の各 call の使用量メトリクスを返します。各 call のメトリクスには、その call 自身の使用量に加えて、すべての子孫の使用量の合計が含まれます。 call ごとにロールアップされたメトリクスを確認したい Trace view で使用してください。

注: 一致するすべての calls は、集約のためにメモリに読み込まれます。結果セットが非常に大きい場合 （>10k calls）は、より具体的なフィルターを使用するか、application レイヤーでページネーションを検討してください。

​
project_id
string
必須
​
filter
CallsFilter · object | null

calls を選択するためのフィルター。通常は、trace 内のすべての calls を取得するために trace_ids を使用します。

​
include_costs
boolean
デフォルト:false

true の場合、使用量にコスト計算を含めます。

​
limit
integer
デフォルト:10000

処理する calls の最大数。際限のないメモリ使用を防ぐための安全上の上限として機能します。

​
query
Query · object | null

calls をフィルタリングするための追加のクエリ条件。

レスポンス

成功レスポンス

call ごとの使用量メトリクスを含むレスポンス（各メトリクスには子孫の寄与を含みます）。

​
call_usage
Call Usage · object
​
unfinished_call_ids
string[]