CLI を使い始める

metrics

orc metrics list は全データセットを返します。orc metrics get DATASET は1件の定義を返します。各定義には指標の単位・加算可否・意味型、集計軸と許可フィルターが含まれます。orc metrics query はカタログの指標と集計軸を指定してデータを集計します。--date-range は JSON オブジェクトで指定し、--stdin でクエリ全体も渡せます。

使い方

terminal
orc metrics list --workspace YOUR_WORKSPACE_ID --json

指標カタログを読む

サブコマンド

list

List metric datasets

terminal
orc metrics list [options]

get

Get a metric dataset

terminal
orc metrics get <dataset> [options]

query

Query metrics

terminal
orc metrics query [options]

固有のオプション

--dataset

(required) Body field: dataset; enum: visibility|citations|sentiment|query-fanouts|web-search-results|perception

型: string。任意。

terminal
orc metrics query --dataset <value>
--date-range

(required) Body field: date_range

型: string。任意。

terminal
orc metrics query --date-range <value>
--dimensions

(required) Body field: dimensions; csv of: brand|platform|model|topic|prompt|source_domain|source_page|search_query|result_hostname|result_url|attribute|date

型: string。任意。

terminal
orc metrics query --dimensions <value>
--filters

Body field: filters; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc metrics query --filters <value>
--granularity

Body field: granularity; enum: day|week|month

型: string。任意。

terminal
orc metrics query --granularity <value>
--metrics

(required) Body field: metrics; csv of: visibility_rate|share_of_voice|average_position|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|web_search_result_count|search_share|attribute_mention_count|answer_count

型: string。任意。

terminal
orc metrics query --metrics <value>
--order-by

Body field: order_by; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc metrics query --order-by <value>

使用例

可視性の定義を読む

terminal
orc metrics get visibility --workspace YOUR_WORKSPACE_ID --json

可視性の定義を読む

30日間の可視性を集計する

terminal
orc metrics query --dataset visibility --metrics visibility_rate --dimensions date --date-range '{"period":"30d"}' --workspace YOUR_WORKSPACE_ID --json

30日間の可視性を集計する

必要な権限

ログインと Workspace へのアクセスが必要です。

グローバルオプション

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

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