メインコンテンツへスキップ
POST
/
calls
/
stats
call統計
curl --request POST \
  --url https://api.example.com/calls/stats \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "call_metrics": [
    {
      "aggregations": [
        "sum"
      ],
      "percentiles": []
    }
  ],
  "end": "2023-11-07T05:31:56Z",
  "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>"
    ]
  },
  "granularity": 123,
  "timezone": "UTC",
  "usage_metrics": [
    {
      "aggregations": [
        "sum"
      ],
      "percentiles": []
    }
  ]
}
'
import requests

url = "https://api.example.com/calls/stats"

payload = {
    "project_id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "call_metrics": [
        {
            "aggregations": ["sum"],
            "percentiles": []
        }
    ],
    "end": "2023-11-07T05:31:56Z",
    "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>"]
    },
    "granularity": 123,
    "timezone": "UTC",
    "usage_metrics": [
        {
            "aggregations": ["sum"],
            "percentiles": []
        }
    ]
}
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>',
    start: '2023-11-07T05:31:56Z',
    call_metrics: [{aggregations: ['sum'], percentiles: []}],
    end: '2023-11-07T05:31:56Z',
    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>']
    },
    granularity: 123,
    timezone: 'UTC',
    usage_metrics: [{aggregations: ['sum'], percentiles: []}]
  })
};

fetch('https://api.example.com/calls/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/calls/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',
    'call_metrics' => [
        [
                'aggregations' => [
                                'sum'
                ],
                'percentiles' => [
                                
                ]
        ]
    ],
    'end' => '2023-11-07T05:31:56Z',
    '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>'
        ]
    ],
    'granularity' => 123,
    'timezone' => 'UTC',
    'usage_metrics' => [
        [
                'aggregations' => [
                                'sum'
                ],
                'percentiles' => [
                                
                ]
        ]
    ]
  ]),
  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/calls/stats"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"call_metrics\": [\n    {\n      \"aggregations\": [\n        \"sum\"\n      ],\n      \"percentiles\": []\n    }\n  ],\n  \"end\": \"2023-11-07T05:31:56Z\",\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  \"granularity\": 123,\n  \"timezone\": \"UTC\",\n  \"usage_metrics\": [\n    {\n      \"aggregations\": [\n        \"sum\"\n      ],\n      \"percentiles\": []\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/calls/stats")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"call_metrics\": [\n    {\n      \"aggregations\": [\n        \"sum\"\n      ],\n      \"percentiles\": []\n    }\n  ],\n  \"end\": \"2023-11-07T05:31:56Z\",\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  \"granularity\": 123,\n  \"timezone\": \"UTC\",\n  \"usage_metrics\": [\n    {\n      \"aggregations\": [\n        \"sum\"\n      ],\n      \"percentiles\": []\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"start\": \"2023-11-07T05:31:56Z\",\n  \"call_metrics\": [\n    {\n      \"aggregations\": [\n        \"sum\"\n      ],\n      \"percentiles\": []\n    }\n  ],\n  \"end\": \"2023-11-07T05:31:56Z\",\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  \"granularity\": 123,\n  \"timezone\": \"UTC\",\n  \"usage_metrics\": [\n    {\n      \"aggregations\": [\n        \"sum\"\n      ],\n      \"percentiles\": []\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "end": "2023-11-07T05:31:56Z",
  "granularity": 123,
  "start": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "call_buckets": [],
  "usage_buckets": []
}
{
  "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

一定期間における集計済みcall統計のリクエスト。

​
project_id
string
必須
​
start
string<date-time>
必須

開始時刻（この時刻を含む）（UTC、ISO 8601）。

​
call_metrics
CallMetricSpec · object[] | null

計算するcallレベルのメトリクス（レイテンシ、件数）。Timestampごとにのみグループ化されます。

​
end
string<date-time> | null

終了時刻（この時刻は含まない）（UTC、ISO 8601）。省略した場合は現在時刻がデフォルトです。

​
filter
CallsFilter · object | null
​
granularity
integer | null

bucketサイズ（秒単位）（例: 1時間の場合は3600）。省略した場合は、期間に基づいて自動的に選択されます。10,000個を超えるbucketが生成される場合は調整されます。

​
timezone
string
デフォルト:UTC

bucketの整列に使用するIANAタイムゾーン（例: 'America/New_York'）

​
usage_metrics
UsageMetricSpec · object[] | null

計算するUsageメトリクス（トークン、コスト）。Timestampとモデルごとにグループ化されます。

レスポンス

正常なレスポンス

時系列のcall統計を含むレスポンス。

​
end
string<date-time>
必須

解決後の終了時刻（UTC）

​
granularity
integer
必須

使用されたbucketサイズ（秒単位）

​
start
string<date-time>
必須

解決後の開始時刻（UTC）

​
timezone
string
必須

bucketの整列に使用されたタイムゾーン

​
call_buckets
Call Buckets · object[]

callレベルのメトリクス。各bucketには 'timestamp' と集計済みメトリクス値が含まれます。

​
usage_buckets
Usage Buckets · object[]

モデルごとのUsageメトリクス。各bucketには 'timestamp'、'model'、および集計済みメトリクス値が含まれます。