​

reports

orc reports は、Workspaceの保存済み観測から可視性・感情・引用・検索・ブランド認識・ショッピング指標を集計するコマンドです。個別の指標、group軸、filter、UTC期間をJSON本文またはflagで指定できます。登録domainのcrawler・referral trafficと、ブランド認識属性の引用根拠も取得できます。

レポート取得は新しい計測を開始しません。全体の短い要約には orc report を使用します。endpointごとに利用できるmetricと集計条件は異なるため、別のレポートのmetricをそのまま流用しないでください。

可視性レポートを取得します。

scope はbrand・topic・prompt・projectです。project以外はscope IDが必須で、projectではscope IDでfilterしません。応答row固有のscopeを保持し、request selectorだけから推定しないでください。dimensionsとmetricsを省略または空arrayにするとendpointの既定値を使います。group_byは追加軸で重複を除きます。persona_idは実行identityで、zero UUIDはpersonaなしです。visibility/sentimentで軸が正確にbrandだけの場合、prompt所有brandではなく正規化された比較brand言及で集計します。

flat filtersはfield間AND、array内anyです。空arrayは条件を加えません。whereとfiltersはANDで合成します。whereは単一condition、and、orのgroupを最大5階層、各group1〜100expressionで指定できます。未知のflat keyは無視され得るため対応keyを使います。order_byは最大20keyで指定順に適用し、fieldは要求した軸またはmetricに含めます。省略時は最初のgroup軸の降順です。

include_examples は互換fieldとして受理されますが、現在のhandlerは捨てており、trueでも evidence_examples は返しません。

可視性・言及数・share of voice・平均順位を集計します。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

引用数と引用率を集計します。既定の軸はdateとsource_domainです。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

感情scoreと言及数を集計します。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

既存回答の検索fanout数と引用数を集計します。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

search shareと検索結果数を集計します。既定の軸はdateとresult_hostnameです。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

観測済み回答からattribute mention数とanswer数を集計します。既定の軸はattributeとbrandです。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

ブランド認識属性の順位を取得します。groupとmetricは固定で、metricはattribute_mention_count、並び順はattribute labelです。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

brand IDとattributeを指定し、同じAI回答で観測された引用URLを取得します。回答単位の共起根拠であり、URLが属性を生んだことは示しません。rename済みのactive definitionは元のsource labelに解決し、hidden definitionは根拠を返しません。

Attribute label or stable source label. An active renamed definition is resolved to its historical source label. A hidden definition yields no evidence.; max 200 chars

型: string。必須。

Brand identifier in the selected workspace. Required; an unavailable brand returns 404.

型: string。必須。

Inclusive UTC calendar date (YYYY-MM-DD). Omit for no lower bound.

型: string。任意。

Inclusive UTC calendar date (YYYY-MM-DD). Omit for no upper bound. Must not precede start_date.

型: string。任意。

Comma-separated platform identifiers.

型: string。任意。

Comma-separated workspace topic identifiers.

型: string。任意。

Comma-separated prompt country codes.

型: string。任意。

登録されたWorkspace所有domainのAI crawler trafficを取得します。metricはcountです。domainは小文字化しHTTP(S) prefix・www.・pathを除き、activeな登録がなければ403になります。

(required) Registered domain owned by the authenticated workspace. The server lowercases it and removes an HTTP(S) prefix, www. prefix and path. Returns 403 if no active domain registration belongs to the workspace.

型: string。任意。

(required) Required metrics. Bots supports count. Referrals supports legacy visits; requesting utm_visits, referred_visits, human_visits or ai_traffic_share enables human page-request aggregation.; csv

型: string。任意。

(required) Inclusive lower calendar-date bound. Use YYYY-MM-DD. The query casts this value to a database date; time-of-day does not provide hourly filtering.

型: string。任意。

Inclusive upper calendar-date bound. Use YYYY-MM-DD. Defaults to the current database date when omitted. A time component does not make this an exclusive timestamp bound.

型: string。任意。

Human referral aggregation supports day, week and month; other intervals are rejected. Legacy reports read daily aggregates.; enum: hour|day|week|month|quarter|year|relative_week

型: string。任意。

Human referral rows group by date and ai_source, optionally landing_path. Other dimensions are rejected. Legacy bots uses date and crawler.; csv

型: string。任意。

Accepted but not applied by the current bots or referrals handler. Omission has the same effect as supplying filters; do not rely on this field to restrict report rows.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Accepted but not applied. Rows are always ordered by date descending, then crawler (bots) or ai_source (referrals) ascending.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Row limit settings. The current handlers apply limit only; offset is ignored. has_more is always false and totals cover only returned rows, so they do not prove that the full date range fits within the limit.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

AI assistantからのreferral trafficを取得します。legacy metricはvisitsです。utm_visits・referred_visits・human_visits・ai_traffic_shareを指定するとhuman page-request集計を使います。

(required) Registered domain owned by the authenticated workspace. The server lowercases it and removes an HTTP(S) prefix, www. prefix and path. Returns 403 if no active domain registration belongs to the workspace.

型: string。任意。

(required) Required metrics. Bots supports count. Referrals supports legacy visits; requesting utm_visits, referred_visits, human_visits or ai_traffic_share enables human page-request aggregation.; csv

型: string。任意。

(required) Inclusive lower calendar-date bound. Use YYYY-MM-DD. The query casts this value to a database date; time-of-day does not provide hourly filtering.

型: string。任意。

Inclusive upper calendar-date bound. Use YYYY-MM-DD. Defaults to the current database date when omitted. A time component does not make this an exclusive timestamp bound.

型: string。任意。

Human referral aggregation supports day, week and month; other intervals are rejected. Legacy reports read daily aggregates.; enum: hour|day|week|month|quarter|year|relative_week

型: string。任意。

Human referral rows group by date and ai_source, optionally landing_path. Other dimensions are rejected. Legacy bots uses date and crawler.; csv

型: string。任意。

Accepted but not applied by the current bots or referrals handler. Omission has the same effect as supplying filters; do not rely on this field to restrict report rows.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Accepted but not applied. Rows are always ordered by date descending, then crawler (bots) or ai_source (referrals) ascending.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Row limit settings. The current handlers apply limit only; offset is ignored. has_more is always false and totals cover only returned rows, so they do not prove that the full date range fits within the limit.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

既存ショッピング観測から商品の表示率と表示回数を取得します。計測を開始しません。ShoppingReportOptions本文を使い、filters.product_idは選択Workspaceの商品IDです。

既存ショッピングfanout queryから検索需要を取得します。計測は開始せず、ReportOptions本文と共通のbody-first flagを使います。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

既存ショッピング観測から商品の表示率推移を取得します。計測は開始せず、ShoppingReportOptions本文のfilters.product_idで対象を選びます。

既存ショッピング観測から販売元別の表示回数を取得します。計測を開始しません。

Select the aggregation scope. project means the active workspace, not a project ID. Defaults to project. brand, topic and prompt require scope_id.; enum: brand|topic|prompt|project

型: string。任意。

Identifier selected by scope: brand ID, topic ID or prompt ID. Required for non-project scopes. Omit for project; project scope does not filter by this value.

型: string。任意。

Grouping axes. Omit or send [] to use endpoint defaults: [date] for visibility, sentiment and query-fanouts; [date, source_domain] for citations; [date, result_hostname] for web-search-results; [attribute, brand] for perception. perception-rankings fixes its own grouping. persona_id refers to execution identity; the zero UUID means no execution persona. Exactly [brand] on visibility or sentiment uses normalized comparison-brand mentions.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Requested metrics. Omit or send [] for endpoint defaults. Use visibility_rate, mention_count, share_of_voice or average_position for visibility; citation_count or citation_rate for citations; sentiment_score or mention_count for sentiment; fanout_count or citation_count for query-fanouts; search_share or web_search_result_count for web-search-results; attribute_mention_count or answer_count for perception. perception-rankings fixes attribute_mention_count. Shopping reports use rendered_visibility, appearances, average_position and win_rate. Unsupported combinations are not guaranteed meaningful values.; csv of: visibility_rate|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|share_of_voice|average_position|web_search_result_count|search_share|attribute_mention_count|answer_count|rendered_visibility|appearances|win_rate

型: string。任意。

Simple equality filters. Values can be strings, string arrays, numbers or booleans. Array values match any supplied item; empty arrays add no condition. Different fields combine with AND, and the result combines with where using AND. Supported common keys include platform, model, brand_id, topic_id, prompt_id, country_code, persona, persona_id, sentiment, brand_mentioned and source_domain. Web-search results additionally support search_query, result_url, result_hostname and result_rank. Unknown flat keys can be ignored; use documented keys.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

One condition, an and group, or an or group. Groups can nest to five levels; each group contains 1–100 expressions.

型: string。任意。

Up to 20 sort keys, applied in array order. Each field must be requested in dimensions, group_by or metrics. Omit or send [] to sort by the first grouping axis descending. Perception ranking rows are always ordered by attribute label.; JSON array of objects (use --stdin for large resources)

型: string。任意。

Supply both start and end for a fixed UTC [start, end) interval, or period for a window ending now. Both explicit bounds take precedence over period. If only one bound accompanies period, the period window is used. Omit the whole object for the last 30 days; an empty object is invalid.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Time bucket for the date grouping axis. Defaults to day; accepted values are hour, day, week and month.; enum: hour|day|week|month

型: string。任意。

Additional grouping axes appended to dimensions, with duplicates removed. Omit for no additional axes.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|persona_id|attribute|merchant

型: string。任意。

Reserved compatibility field. The current report handlers discard this field and do not return evidence_examples; setting true does not enable evidence output.

型: string。任意。

期間とmetricの本文を用意します。

本文を送信してJSONを取得します。

属性と同じ回答に現れた引用根拠を取得します。

登録domainのcrawler数を取得します。

選択Workspaceの商品IDを使ったShoppingReportOptionsを用意します。dimensions・metricsの省略や空配列はendpoint既定値を使います。filterはclientで読み替えずAPI schema検証へ渡します。

既存の本文でショッピング表示率を取得します。

ショッピング表示率の推移を取得します。

body-first reportのdate_rangeは両方のstart/endでUTCの半開区間 [start, end)、またはperiodで現在までの窓を指定します。両境界がperiodより優先し、片方とperiodならperiodを使用します。object省略は直近30日、空objectは不正です。granularityはhour・day・week・monthで既定dayです。

perception sourcesの開始・終了は含むUTC日付で、終了は開始より前にできません。platform・topic・countryで絞り、cursorをそのまま渡します。--page-all で全ページをNDJSONにできます。

bots/referralsは開始・終了を含むcalendar dateで取得し、終了省略はdatabaseの当日です。時刻成分を付けてもhour filterやexclusive upper boundにはなりません。legacy botsはdate・crawler、human referralsはdate・ai_sourceと任意landing_pathでgroup化し、human referralのgrainはday・week・monthです。

traffic handlerはfilters・order_byを適用せず、date降順とcrawler/ai_source昇順です。paginationはlimitのみ適用し、offsetは無視します。has_moreは常にfalseでtotalsは返ったrowだけなので、範囲全体を読み切った証拠にはなりません。

認証し、対象Workspaceを選択して実行します。対象Workspaceへのアクセスが必要です。

orc reports では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。