Getting started
reports
This page is the command reference for @orchestor-inc/cli.
Commands
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
Usage
orc reports visibility get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report visibility
Help
orc reports visibility get --helporc reports citations get
Citations report
Usage
orc reports citations get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report citations
Help
orc reports citations get --helporc reports sentiment get
Sentiment report
Usage
orc reports sentiment get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report sentiment
Help
orc reports sentiment get --helporc reports query-fanouts get
Query fanouts report
Usage
orc reports query-fanouts get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report query-fanouts
Help
orc reports query-fanouts get --helporc reports web-search-results get
Web search results report
Usage
orc reports web-search-results get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report web-search-results
Help
orc reports web-search-results get --helporc reports perception get
Perception report
Usage
orc reports perception get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report perception
Help
orc reports perception get --helporc reports perception-rankings get
Perception attribute rankings report
Usage
orc reports perception-rankings get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--scope | string | No | Body field: scope; enum: brand|topic|prompt|project |
--scope-id | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | UTC date-time range using the half-open interval [start, end).; (JSON object, e.g. '{"custom_id":"x"}') |
--granularity | string | No | UTC report grain governed by the versionless historical date/time contract.; enum: hour|day|week|month |
--group-by | string | No | 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 | No | true の場合、各 dimension group ごとに最大 10 件の example quote を evidence_examples に同梱する。sentiment / theme / accuracy 系 metric 使用時に推奨。 |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report perception-rankings
Help
orc reports perception-rankings get --helporc reports perception sources list
Lists citation URLs observed in the same AI answers as the selected perception attribute and brand. This is answer-level co-occurrence evidence; it does not claim that a URL caused the attribute.
Usage
orc reports perception sources list --brand-id <brand-id> --attribute <attribute> [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--attribute | string | Yes | Attribute source_label or current display label |
--brand-id | string | Yes | Target brand ID |
--start-date | string | No | Inclusive UTC start date |
--end-date | string | No | Inclusive UTC end date |
--filter[platform] | string | No | Comma-separated platform identifiers |
--filter[topic-id] | string | No | Comma-separated topic identifiers |
--filter[country-code] | string | No | Comma-separated country codes |
--limit | number | No | Items per page, from 1 to 100 (default 10) |
--cursor | string | No | Opaque cursor for the next page |
--page-all forwards each server cursor unchanged and streams every page as NDJSON. See global flags for output and request options.
Help
orc reports perception sources list --helporc reports shopping-performance get
Retrieve product visibility and appearance counts from existing shopping observations. This command does not start a measurement.
Usage
orc reports shopping-performance get --workspace YOUR_WORKSPACE_ID --stdin --json < shopping-report.jsonPass a ShoppingReportOptions JSON object as the request body. You can set scope, scope_id, dimensions, metrics, filters, where, order_by, date_range, granularity, group_by, limit, cursor, and include_examples. Set filters.product_id to a product ID in the selected Workspace.
Omit dimensions or metrics, or pass an empty array, to use the server defaults for this report. The API schema validator receives filters without client-side reinterpretation.
Help
orc reports shopping-performance get --helporc reports shopping-demand get
Retrieve search demand from existing shopping fanout queries. This command does not start a measurement.
Usage
orc reports shopping-demand get [flags]Use the same --scope, --scope-id, --dimensions, --metrics, --filters, --where, --order-by, --date-range, --granularity, --group-by, --limit, --cursor, and --include-examples flags as other body-first reports. You can also pass a complete ReportOptions JSON object with --stdin.
Omit dimensions or metrics, or pass an empty array, to use the server defaults for this report.
Help
orc reports shopping-demand get --helporc reports shopping-trend get
Retrieve product visibility trends from existing shopping observations. This command does not start a measurement.
Usage
orc reports shopping-trend get --workspace YOUR_WORKSPACE_ID --stdin --json < shopping-report.jsonPass a ShoppingReportOptions JSON object as the request body. Set filters.product_id to a product ID in the selected Workspace. Omit dimensions or metrics, or pass an empty array, to use the server defaults for this report.
Help
orc reports shopping-trend get --helporc reports merchants get
Retrieve appearance counts by merchant from existing shopping observations. This command does not start a measurement.
Usage
orc reports merchants get [flags]Use the same --scope, --scope-id, --dimensions, --metrics, --filters, --where, --order-by, --date-range, --granularity, --group-by, --limit, --cursor, and --include-examples flags as other body-first reports. You can also pass a complete ReportOptions JSON object with --stdin.
Omit dimensions or metrics, or pass an empty array, to use the server defaults for this report.
Help
orc reports merchants get --helporc reports bots get
Bot / AI crawler traffic report
Usage
orc reports bots get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--domain | string | No | (required) Registered domain to query (e.g. example.com). Must belong to the Workspace selected by X-Workspace-ID (when provided). |
--metrics | string | No | (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 | No | (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 | No | 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 | No | 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 | No | 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 | No | List of column filters. Combined with AND.; JSON array of objects (use --stdin for large resources) |
--order-by | string | No | Custom ordering. Key = metric or dimension name, value = asc | desc. Default: first metric descending.; (JSON object, e.g. '{"custom_id":"x"}') |
--pagination | string | No | Offset-based pagination.; (JSON object, e.g. '{"custom_id":"x"}') |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report bots
Help
orc reports bots get --helporc reports referrals get
AI assistant referral traffic report
Usage
orc reports referrals get [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--domain | string | No | (required) Registered domain to query (e.g. example.com). Must belong to the Workspace selected by X-Workspace-ID (when provided). |
--metrics | string | No | (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 | No | (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 | No | 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 | No | 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 | No | 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 | No | List of column filters. Combined with AND.; JSON array of objects (use --stdin for large resources) |
--order-by | string | No | Custom ordering. Key = metric or dimension name, value = asc | desc. Default: first metric descending.; (JSON object, e.g. '{"custom_id":"x"}') |
--pagination | string | No | Offset-based pagination.; (JSON object, e.g. '{"custom_id":"x"}') |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc report referrals
Help
orc reports referrals get --help