Skip to main content
POST
このレポートは、プロンプトに対して ChatGPT がショッピング結果を返す頻度を示します。 総実行数、ショッピングがトリガーされた実行数、トリガー率がわかります。
  • 指標: total_runs、shopping_triggered_runs、trigger_rate_percentage。trigger_rate_percentage は shopping_triggered_runs / total_runs です。値は 0–100 ではなく 0–1 の割合 です。パーセントで表すには、値に 100 を掛けてください。
  • group_by: date、topic、region、persona、prompt。
  • フィルタフィールド: topic、region、persona、prompt、tag。
プロンプトごとの率を取得するには、group_by に prompt を追加します。トピックごとの率を 取得するには、topic を追加します。時系列を取得するには、date を追加して interval を設定します。
ショッピングデータは ChatGPT のみから取得されます。ショッピングレポートには model の group_by や model フィルタはありません。
v2 レポートは共通のリクエスト形式を使用します。フィルタツリー、グループ化、 ページネーションについては、フィルタリングと概念 を参照してください。
POST /v2/reports/shopping/trigger-rate/stream は 同じリクエスト ボディ を使用します。Server-Sent Events を返し、 まず 1 つの summary イベント (info ブロック) が送信され、続いて行ごとに 1 つの result イベントが送信されます。 ストリームは limit と cursor を受け付けません。デフォルトではすべての行が返されます。 上限を設定するには max_results (最大 50000) を使用します。

承認

X-API-Key
string
header
必須

ボディ

application/json
category_id
string<uuid>
必須
start_date
string
必須

YYYY-MM-DD, ET, inclusive

end_date
string
必須

YYYY-MM-DD, ET, inclusive

group_by
enum<string>[]

Group by prompt/topic for the per-prompt/-topic trigger rate.

利用可能なオプション:
date,
topic,
region,
persona,
prompt
metrics
enum<string>[] | null
利用可能なオプション:
total_runs,
shopping_triggered_runs,
trigger_rate_percentage
interval
enum<string>
デフォルト:day
利用可能なオプション:
day,
week,
month
filter
FilterNode · object | null

A leaf (field/op/value) or an and/or/not group.

limit
integer | null

Page size; default 10, max 50.

必須範囲: 0 < x <= 50
max_results
integer | null

Stream endpoint only: cap streamed rows.

必須範囲: 0 < x <= 50000
cursor
string | null

レスポンス

Successful Response

info
ShoppingTriggerRateV2Info · object
必須
data
ShoppingTriggerRateRow · object[]
必須