Skip to main content
POST
アセットが AI の回答に表示される頻度に加えて、シェア・オブ・ボイスと平均 順位を示します。assets でアセットを選択し、group_by で結果を分割して、 各指標を行内の名前付きフィールドとして読み取ります。
  • 指標: visibility_score (アセットが表示された回答の割合)、share_of_voice (全言及に占める割合)、average_position (言及されたときの平均順位。低いほど良い)。
  • group_by: date、model、topic、region、prompt、persona。
  • アセットの選択 は assets パラメータ (名前、リスト、または { op, value }) で行います。scope: "all" はすべてのアセットをランク付けし、"owned" は自社のアセットのみを返します。
  • sort では、リクエストした任意の指標で並べ替えられます。例: { "field": "visibility_score" }。
v2 レポートを初めて使用する場合は、共通のリクエスト形式、フィルタツリー、グループ化、ページネーションについて フィルタリングと概念 を参照してください。
POST /v2/reports/visibility/stream は 同じリクエストボディ を受け取り、 Server-Sent Events を返します。 まず 1 つの summary イベント (info ブロック) が送信され、続いて行ごとに 1 つの result イベントが送信されます。 limit/cursor は無視され、デフォルトではすべての結果が返されます。上限を設けるには max_results を指定します。
Response (text/event-stream)

承認

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>[]
利用可能なオプション:
date,
model,
topic,
region,
prompt,
persona
metrics
enum<string>[] | null
利用可能なオプション:
visibility_score,
share_of_voice,
average_position
interval
enum<string>
デフォルト:day
利用可能なオプション:
day,
week,
month
scope
enum<string>
デフォルト:owned
利用可能なオプション:
owned,
all
assets

A name (is), a list (in), or {op,value} with op is/in/not_in.

filter
FilterNode · object | null

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

sort
SortSpec · object
limit
integer | null

Page size; default 10, max 50.

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

Stream endpoint only: cap the number of streamed rows (default: all).

必須範囲: x > 0
cursor
string | null

レスポンス

Successful Response

info
VisibilityV2Info · object
必須
data
VisibilityRow · object[]
必須