CLI を使い始める
reports
@orchestor-inc/cli のコマンドリファレンスです。
コマンド一覧
orc reports visibility get— Visibility reportorc reports citations get— Citations reportorc reports sentiment get— Sentiment reportorc reports query-fanouts get— Query fanouts reportorc reports web-search-results get— Web search results reportorc reports perception get— Perception reportorc reports perception-rankings get— Perception attribute rankings reportorc reports perception sources list— Perception attribute source evidenceorc reports shopping-performance get— Shopping performance reportorc reports shopping-demand get— Shopping demand reportorc reports shopping-trend get— Shopping trend reportorc reports merchants get— Merchant appearance reportorc reports bots get— Bot / AI crawler traffic reportorc reports referrals get— AI assistant referral traffic report
orc reports visibility get
Visibility report
構文
orc reports visibility get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report visibility
ヘルプ
orc reports visibility get --helporc reports citations get
Citations report
構文
orc reports citations get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report citations
ヘルプ
orc reports citations get --helporc reports sentiment get
Sentiment report
構文
orc reports sentiment get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report sentiment
ヘルプ
orc reports sentiment get --helporc reports query-fanouts get
Query fanouts report
構文
orc reports query-fanouts get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report query-fanouts
ヘルプ
orc reports query-fanouts get --helporc reports web-search-results get
Web search results report
構文
orc reports web-search-results get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report web-search-results
ヘルプ
orc reports web-search-results get --helporc reports perception get
Perception report
構文
orc reports perception get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report perception
ヘルプ
orc reports perception get --helporc reports perception-rankings get
Perception attribute rankings report
構文
orc reports perception-rankings get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--scope | string | いいえ | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | いいえ | Required when scope != project. Each result row retains its own scope field; clients must not infer row scope solely from this request selector. |
--dimensions | string | いいえ | Dimensions used to group rows. For visibility and sentiment reports, an exact [brand] request uses persisted normalized comparison-brand mentions. It does not group by the Brand that owns each Prompt.; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--metrics | string | いいえ | Metric set. Surface-specific validity: - /v1/reports/visibility: visibility_rate, mention_count, share_of_voice, average_position - /v1/reports/citations: citation_count, citation_rate - /v1/reports/sentiment: sentiment_score, mention_count - /v1/reports/query-fanouts: fanout_count, citation_count - /v1/reports/web-search-results: search_share, web_search_result_count - /v1/reports/perception: attribute_mention_count, answer_count - /v1/reports/perception-rankings: attribute_mention_count - shopping reports: rendered_visibility, appearances, average_position, win_rate attribute_mention_count and answer_count are Orchestor extensions derived from the analyzed answers corpus. Omit or send an empty array to use endpoint-specific server defaults.; 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 |
--filters | string | いいえ | Flat key→value (or value[]) filters. Applied as AND-of-equality. Use this for the simple common cases (platform, model, brand_id, topic_id, prompt_id, country_code, persona, brand_mentioned, source_domain, sentiment_type, accuracy_flag, funnel (top|bottom), hallucination (true|false)). Tag filters use tag_ids with tag_operator (or by default); an empty tag_ids array is equivalent to omitting the tag filter. For composable boolean expressions (AND/OR nesting, prefix/suffix matching, range comparisons, etc.) use where instead. Both can be combined: server applies filters AND where (logical AND).; (JSON object, e.g. '{"custom_id":"x"}') |
--where | string | いいえ | Composable boolean filter expression. 3 形態のいずれか: - condition: { field, op, value } の単一条件 - and: { and: [expr, expr, ...] } で全条件 AND - or: { or: [expr, expr, ...] } で任意条件 OR ネスト可能 (and 内に or、or 内に and など、最大 5 level)。 |
--order-by | string | いいえ | Multi-key sort specification. field は dimensions / metrics の enum 値 (例: 'date' / 'visibility_rate' / 'mention_count') で、 request の dimensions または metrics に含める必要がある。; JSON array of objects (use --stdin for large resources) |
--date-range | string | いいえ | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | いいえ | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | いいえ | Body field: group_by; csv of: date|platform|model|brand|product|topic|prompt|competitor|source_domain|source_page|search_query|result_url|result_hostname|result_rank|adopted|persona|attribute|merchant |
--include-examples | string | いいえ | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report perception-rankings
ヘルプ
orc reports perception-rankings get --helporc reports perception sources list
選択したブランド認識属性と同じ AI 回答で観測された引用 URL を一覧表示します。この結果は回答単位の共起根拠であり、URL が属性を生じさせたことを示すものではありません。
構文
orc reports perception sources list --brand-id <brand-id> --attribute <attribute> [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--attribute | string | はい | 属性の source_label または現在の表示ラベル |
--brand-id | string | はい | 対象ブランド ID |
--start-date | string | いいえ | UTC 日付の開始日（この日を含む） |
--end-date | string | いいえ | UTC 日付の終了日（この日を含む） |
--filter[platform] | string | いいえ | カンマ区切りのプラットフォーム ID |
--filter[topic-id] | string | いいえ | カンマ区切りのトピック ID |
--filter[country-code] | string | いいえ | カンマ区切りの国コード |
--limit | number | いいえ | 1 ページの件数（1〜100、既定値 10） |
--cursor | string | いいえ | 次ページ用の不透明カーソル |
--page-all は API が返したカーソルをそのまま次のリクエストへ渡し、全ページを NDJSON で出力します。出力とリクエストの共通オプションはグローバルオプションを参照してください。
ヘルプ
orc reports perception sources list --helporc reports shopping-performance get
既存のショッピング観測から商品の表示率と表示回数を取得します。このコマンドは計測を開始しません。
構文
orc reports shopping-performance get --workspace YOUR_WORKSPACE_ID --stdin --json < shopping-report.jsonリクエスト本文は ShoppingReportOptions の JSON オブジェクトです。scope、scope_id、dimensions、metrics、filters、where、order_by、date_range、granularity、group_by、limit、cursor、include_examples を指定できます。filters.product_id には選択した Workspace の商品 ID を指定します。
dimensions または metrics を省略するか空配列にすると、サーバーがこのレポートの既定値を選択します。フィルターは API のスキーマ検証へそのまま渡されます。
ヘルプ
orc reports shopping-performance get --helporc reports shopping-demand get
既存のショッピング fanout query から検索需要を取得します。このコマンドは計測を開始しません。
構文
orc reports shopping-demand get [flags]他の body-first レポートと同じ --scope、--scope-id、--dimensions、--metrics、--filters、--where、--order-by、--date-range、--granularity、--group-by、--limit、--cursor、--include-examples を使用できます。完全な ReportOptions JSON は --stdin でも渡せます。
dimensions または metrics を省略するか空配列にすると、サーバーがこのレポートの既定値を選択します。
ヘルプ
orc reports shopping-demand get --helporc reports shopping-trend get
既存のショッピング観測から商品の表示率の推移を取得します。このコマンドは計測を開始しません。
構文
orc reports shopping-trend get --workspace YOUR_WORKSPACE_ID --stdin --json < shopping-report.jsonリクエスト本文は ShoppingReportOptions の JSON オブジェクトです。filters.product_id には選択した Workspace の商品 ID を指定します。dimensions または metrics を省略するか空配列にすると、サーバーがこのレポートの既定値を選択します。
ヘルプ
orc reports shopping-trend get --helporc reports merchants get
既存のショッピング観測から販売元別の表示回数を取得します。このコマンドは計測を開始しません。
構文
orc reports merchants get [flags]他の body-first レポートと同じ --scope、--scope-id、--dimensions、--metrics、--filters、--where、--order-by、--date-range、--granularity、--group-by、--limit、--cursor、--include-examples を使用できます。完全な ReportOptions JSON は --stdin でも渡せます。
dimensions または metrics を省略するか空配列にすると、サーバーがこのレポートの既定値を選択します。
ヘルプ
orc reports merchants get --helporc reports bots get
Bot / AI crawler traffic report
構文
orc reports bots get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--domain | string | いいえ | (required) Registered domain to query (e.g. example.com). Must belong to the Workspace selected by X-Workspace-ID (when provided). |
--metrics | string | いいえ | (required) Metric set. Surface-specific (see schema description). x-enum-values listed for documentation; validation is loose to avoid breaking changes when new bot/referral signals are added.; csv |
--start-date | string | いいえ | (required) UTC lower bound. A YYYY-MM-DD value names an inclusive calendar date; a date-time value is inclusive. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or ISO 8601 date-time. |
--end-date | string | いいえ | UTC upper bound. A YYYY-MM-DD value names an inclusive calendar date; a date-time value is exclusive. Same formats as start_date; defaults to now (UTC) when omitted. |
--granularity | string | いいえ | Aggregation interval (only applied when dimensions includes date or hour). hour requires the underlying hourly MV.; enum: hour|day|week|month|quarter|year|relative_week |
--dimensions | string | いいえ | Group-by dimensions. Surface-specific. x-enum-values: bots: [date, hour, path, bot_name, bot_provider, bot_type] referrals: [date, hour, path, referral_source, referral_type]; csv |
--filters | string | いいえ | List of column filters. Combined with AND.; JSON array of objects (use --stdin for large resources) |
--order-by | string | いいえ | Custom ordering. Key = metric or dimension name, value = asc | desc. Default: first metric descending.; (JSON object, e.g. '{"custom_id":"x"}') |
--pagination | string | いいえ | Offset-based pagination.; (JSON object, e.g. '{"custom_id":"x"}') |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report bots
ヘルプ
orc reports bots get --helporc reports referrals get
AI assistant referral traffic report
構文
orc reports referrals get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--domain | string | いいえ | (required) Registered domain to query (e.g. example.com). Must belong to the Workspace selected by X-Workspace-ID (when provided). |
--metrics | string | いいえ | (required) Metric set. Surface-specific (see schema description). x-enum-values listed for documentation; validation is loose to avoid breaking changes when new bot/referral signals are added.; csv |
--start-date | string | いいえ | (required) UTC lower bound. A YYYY-MM-DD value names an inclusive calendar date; a date-time value is inclusive. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or ISO 8601 date-time. |
--end-date | string | いいえ | UTC upper bound. A YYYY-MM-DD value names an inclusive calendar date; a date-time value is exclusive. Same formats as start_date; defaults to now (UTC) when omitted. |
--granularity | string | いいえ | Aggregation interval (only applied when dimensions includes date or hour). hour requires the underlying hourly MV.; enum: hour|day|week|month|quarter|year|relative_week |
--dimensions | string | いいえ | Group-by dimensions. Surface-specific. x-enum-values: bots: [date, hour, path, bot_name, bot_provider, bot_type] referrals: [date, hour, path, referral_source, referral_type]; csv |
--filters | string | いいえ | List of column filters. Combined with AND.; JSON array of objects (use --stdin for large resources) |
--order-by | string | いいえ | Custom ordering. Key = metric or dimension name, value = asc | desc. Default: first metric descending.; (JSON object, e.g. '{"custom_id":"x"}') |
--pagination | string | いいえ | Offset-based pagination.; (JSON object, e.g. '{"custom_id":"x"}') |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc report referrals
ヘルプ
orc reports referrals get --help