Getting started
sources
This page is the command reference for @orchestor-inc/cli.
Commands
orc sources gaps list— List locally derived source gapsorc sources domains list— List source domainsorc sources domains get— Get source domain detailorc sources urls list— List source URLsorc sources urls get— Get source URL detailorc sources citations list— List source citation aggregates
orc sources gaps list
List locally derived source gaps
Usage
orc sources gaps list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--view | string | No | enum: domain|host|url |
--min-competitors | number | No | Minimum distinct configured competitors found in an answer. |
--start-date | string | No | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | No | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--search | string | No | Case-insensitive source hostname, URL, or title search. |
--filter[platform] | string | No | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | No | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | No | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | No | Comma-separated prompt tag names for the answer cohort. |
--filter[mentioned-brand-id] | string | No | Comma-separated competitor Brand IDs that must be mentioned in qualifying answers. |
--filter[country] | string | No | Comma-separated ISO 3166-1 alpha-2 country codes for qualifying prompts. |
--mentioned-brand-operator | string | No | Whether any or all selected mentioned Brand IDs must occur in a qualifying answer.; enum: or|and |
--filter[domain-classification] | string | No | Comma-separated SourceDomainClassification values. |
--filter[url-classification] | string | No | Comma-separated SourceUrlClassification values. |
--sort | string | No | Field used to order the derived gap rows.; enum: source|competitor_count|retrieval_count|retrieved_percentage|retrieval_rate|citation_rate|gap_score |
--order | string | No | Sort direction.; enum: asc|desc |
--page | number | No | value |
--limit | number | No | Maximum number of items to return |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc source list-gaps
Help
orc sources gaps list --helporc sources domains list
List source domains
Usage
orc sources domains list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | No | Optional project filter for web callers. |
--view | string | No | Rollup axis for source evidence rows; domain uses registrable domains and host uses normalized hostnames.; enum: domain|host |
--start-date | string | No | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | No | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--cohort | string | No | Source mover view over the union of retrieval evidence and citation events; top includes either current retrievals or citations, while new, trending, and losing use retrieval observations only. Cohorts are overlapping views, not exclusive buckets.; enum: top|new|trending|losing |
--filter[platform] | string | No | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | No | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | No | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | No | Comma-separated prompt tag names for the answer cohort. |
--filter[classification] | string | No | Comma-separated SourceDomainClassification values. |
--sort | string | No | enum: hostname|classification|retrieval_count|retrieval_change|retrieval_rate|retrieval_frequency|citation_count|citation_rate|url_count|share_of_voice|first_seen_at|last_seen_at |
--order | string | No | enum: asc|desc |
--page | number | No | value |
--limit | number | No | Maximum number of items to return |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc source list-domains
Help
orc sources domains list --helporc sources domains get
Get source domain detail
Usage
orc sources domains get <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Source-domain hostname from the host view of the list endpoint. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc source get-domain
Help
orc sources domains get --helporc sources urls list
List source URLs
Usage
orc sources urls list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | No | value |
--start-date | string | No | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | No | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--cohort | string | No | Source mover view over the union of retrieval evidence and citation events; top includes either current retrievals or citations, while new, trending, and losing use retrieval observations only. Cohorts are overlapping views, not exclusive buckets.; enum: top|new|trending|losing |
--filter[platform] | string | No | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | No | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | No | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | No | Comma-separated prompt tag names for the answer cohort. |
--filter[classification] | string | No | Comma-separated SourceUrlClassification values. |
--sort | string | No | enum: url|hostname|retrieval_count|retrieval_change|citation_count|share_of_voice|first_seen_at|last_seen_at |
--order | string | No | enum: asc|desc |
--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 source list-urls
Help
orc sources urls list --helporc sources urls get
Get source URL detail
Usage
orc sources urls get <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | URL-encoded source URL from the list endpoint. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc source get-url
Help
orc sources urls get --helporc sources citations list
List source citation aggregates
Usage
orc sources citations list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | No | value |
--start-date | string | No | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | No | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--group-by | string | Yes | Comma-separated SourceCitationGroupBy values. |
--bucket-width | string | No | Required when group_by includes date.; enum: day|week|month |
--classification-scope | string | No | Selects whether group_by=classification returns domain classifications or URL classifications.; enum: domain|url |
--filter[hostname] | string | No | Comma-separated hostnames. |
--filter[domain] | string | No | Comma-separated registrable domains; subdomains are normalized to their registrable domain. |
--filter[url] | string | No | Comma-separated URLs. |
--filter[classification] | string | No | Comma-separated classification values matching classification_scope. |
--filter[platform] | string | No | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | No | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | No | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | No | Comma-separated prompt tag names for the answer cohort. |
--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 source list-citations
Help
orc sources citations list --help