フィードバック統計

時間バケットごとの集約済みフィードバック統計を返します。

POST /feedback/stats

フィードバック統計

cURL

curl --request POST \
  --url https://api.example.com/feedback/stats \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "feedback_type": "<string>",
  "trigger_ref": "<string>",
  "granularity": 123,
  "timezone": "UTC",
  "metrics": [
    {
      "json_path": "<string>",
      "value_type": "numeric",
      "aggregations": [
        "sum"
      ],
      "percentiles": [
        123
      ]
    }
  ]
}
'

200

{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "granularity": 123,
  "timezone": "<string>",
  "buckets": [
    {}
  ],
  "window_stats": {}
}

承認

Authorization · string · header · 必須

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

ボディ

application/json

時間バケットごとの集約フィードバック統計のリクエスト。

project_id · string · 必須

start · string<date-time> · 必須

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

end · string<date-time> | null

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

feedback_type · string | null

feedback_type でフィルターします。

trigger_ref · string | null

trigger_ref でフィルターします（all-versions では完全一致またはプレフィックス一致）。

granularity · integer | null

バケット サイズ（秒単位）。省略した場合は、時間範囲に基づいて自動選択されます。

timezone · string · デフォルト: UTC

バケットの位置合わせに使用する IANA タイムゾーン。

metrics · FeedbackMetricSpec · object[]

payload_dump から集約するメトリクス。

Show child attributes

レスポンス

200

application/json

正常なレスポンス

時系列フィードバック統計を含むResponse。

start · string<date-time> · 必須

確定した開始時刻（要求したタイムゾーンに関係なく、常に UTC）。

end · string<date-time> · 必須

確定した終了時刻（要求したタイムゾーンに関係なく、常に UTC）。

granularity · integer · 必須

使用されたバケット サイズ（秒単位）

timezone · string · 必須

バケットの位置合わせに使用されたタイムゾーン

buckets · Buckets · object[]

時間バケットごとの集約。各dict には、'timestamp'（ISO 文字列）、'count'（int）、およびリクエストされた各メトリクス+集約に対応する '{agg}_{slug}' キーが含まれます。

window_stats · Window Stats · object

クエリ期間全体に対する集約。メトリクス slug（例: 'output_score'）をキーにします。各値は agg 名から結果へのマッピングです。

Show child attributes