レポート
get_visibility_report
ブランドの可視性レポートを取得します。対象、指標、集計軸、期間を指定できます。
操作: 読み取り。hosted 接続の対象ワークスペースは OAuth の認可で決まります。
パラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
scope | string | 任意 | 集計対象の種類。 project / brand / topic / prompt |
scope_id | string | 任意 | 集計対象の ID。 |
metrics | string[] | 任意 | 取得する指標名。 |
dimensions | string[] | 任意 | 集計軸の名前。 |
date_range | object | 任意 | 相対期間、または開始日・終了日。 |
date_range.period | string | 任意 | 相対期間。例: 7d、30d、90d。 |
date_range.start | string | 任意 | 開始日時または日付。境界を含みます。 |
date_range.end | string | 任意 | 終了日時または日付。境界を含みます。 |
granularity | string | 任意 | 時系列の集計単位。 day / week / month |
filters | object | 任意 | 絞り込み条件。利用できる条件はレポートによって異なります。 |
cursor | string | 任意 | 前のレスポンスで取得した次ページのカーソル。 |
limit | integer | 任意 | 取得する最大件数。 最小値: 1; 最大値: 500 |
利用できる指標、集計軸、フィルターはレポートごとに異なります。レポートリファレンスで指定値を確認してください。レポートの行データがある場合、結果には columns、rows、rowCount が含まれます。
レスポンスに次ページのカーソルがある場合は、次のリクエストに渡して取得を続けます。
依頼例
選んだブランドの直近7日間の可視性を調べ、対象期間と根拠を示してください。