Skip to main content
POST
カテゴリ内で引用された YouTube チャンネル、またはそれらが公開している動画カテゴリをランク付けします。 YouTube のアナリティクスではなく、Profound の引用データから算出されます。
  • ソースタイプ: video、short、channel、playlist、または other。 source_types を省略すると、video、short、channel、playlist が含まれます。 空でないリストを指定してください。重複する値は排除されます。other の引用には チャンネルがないため、集計に other を含めることはできません。
  • group_by: channel (デフォルト)、video_category、または source_type。 サポートされるクロス集計は ["channel", "video_category"]、 ["channel", "source_type"]、["channel", "model"] です。重複する ディメンションは拒否されます。
  • 時系列: interval を day、week、または month に設定すると、エンティティと期間ごとに 1 行が返されます。date は ET でのバケットの開始日のため、週次または 月次のバケットは start_date より前に開始する場合があります。期間全体の合計を取得するには省略します。
  • 行: フィールドは条件付きです。date、model、source_type、 video_category は、対応する interval または group_by を指定した場合にのみ表示されます。 group_by: ["video_category"] の場合、カテゴリは video_category ではなく name で 返されます。解決できない動画カテゴリは null ではなく "" として 返されます。rank はランク付けされた全体の中での先頭チャンネルの順位で、 そのチャンネルのクロス集計行全体で繰り返されます。
  • ページネーション: limit のデフォルトは 10 で、1–50 を指定できます。不透明な info.next_cursor をリクエストの cursor として渡すと次のページを取得できます。 2 ページ目以降では、info に指定した cursor がエコーされます。レスポンスの info には、category_id、実際に適用された limit、interval がエコーされます。
  • 合計: total_results は期間内の異なるチャンネルの数で、 count は返された行の数です。単位が異なります。
  • フィルタ: プロンプトレベルのフィールドは model、topic、region、prompt、 persona、tag、analysis_type です。channel フィルタは is、 in、contains、not_contains、contains_case_insensitive、 not_contains_case_insensitive を受け付けます。is/in は完全一致のハンドルを選択し、 その他の演算子はチャンネルのタイトルまたはハンドルに一致します。 domain と page は拒否されます。channel のリーフは、プロンプトレベルのリーフと同じ or や not に含めることはできません。異なるレイヤーは and 句に分けてください。
クロス集計では、limit は返される行ではなく先頭チャンネルの数をカウントします。 例えば、group_by: ["channel", "video_category"] で limit: 25 を指定すると、 25 チャンネルが返されますが、行数は 25 を超える場合があります。
v2 レポートは共通のリクエスト形式とフィルタツリーを使用します。フィルタ 演算子、グループ化、期間、ページネーション、フィルタの深さについては、 フィルタリングと概念 を参照してください。

承認

​
X-API-Key
string
header
必須

ボディ

application/json

Channel and category rollups.

​
category_id
string<uuid>
必須
​
start_date
string
必須

YYYY-MM-DD, ET, inclusive

​
end_date
string
必須

YYYY-MM-DD, ET, inclusive

​
filter
FilterNode · object | null

Advanced filter tree. Prompt-level dimensions are model, topic, region, prompt, persona, tag, analysis_type. channel covers both channel cases: in with a list of handles selects exactly those channels, resolving each handle to its channel so a renamed channel is never returned in pieces; contains matches a channel's title or handle by name. Combine with and/or/not up to 3 deep. An exact channel selection must be its own and clause, and a channel leaf cannot share an or or not with a prompt-level leaf, because those compile at different stages of the query. domain and page are rejected rather than approximated: every row here is one domain, and page is not a video id.

​
limit
integer | null

Page size; default 10, max 50.

必須範囲: 0 < x <= 50
​
cursor
string | null
​
source_types
enum<string>[] | null

Limit results to YouTube source types: video, short, channel, playlist, or other. Omit to include video, short, channel, and playlist; other is excluded because those citations have no channel. Requests containing other are rejected.

利用可能なオプション:
video,
short,
channel,
playlist,
other
​
group_by
enum<string>[]

What each row represents. Empty or ["channel"] ranks channels; ["video_category"] ranks content categories; ["source_type"] ranks source types; ["channel", "video_category"], ["channel", "source_type"] and ["channel", "model"] return cross-tabs — a row per channel per category, or per answer engine. limit counts leading channels in every case, so ten channels across nine engines is ten channels and ninety rows.

利用可能なオプション:
channel,
video_category,
model,
source_type
​
interval
enum<string> | null

Return a time series instead of window totals: one row per entity per period, each carrying date. citation_share is then relative to that period, so the series is comparable across periods. Omit for window totals.

利用可能なオプション:
day,
week,
month

レスポンス

Successful Response

​
info
YoutubeChannelsInfo · object
必須

Channel report metadata, including effective paging and grouping settings.

​
data
YoutubeChannelRow · object[]
必須