コンテンツにスキップ
DimensionKit
Try the app

ツールリファレンス

サーバーは以下のツールを公開しています。各ツールには必要なOAuthスコープが定められており、scorecards:read のみを持つ接続から scorecards:write を要求するツールを呼び出すことはできません。

破壊的(Destructive) と記載されたツールは既存データを上書きまたは削除します。多くのクライアントでは実行前に確認ダイアログが表示されます。

スコアカードの作成や大規模な修正を行う前に参照してください。事前ヒアリング項目、設問設計、インサイトの書き方、テーマ選定指針が含まれます。

スコープ: scorecards:read · 冪等(Idempotent)

引数 型 必須 説明
topics 文字列配列 いいえ 取得したい特定セクション(例: “themes”, “questions”)。省略時は全項目。

アカウント内のスコアカード一覧を取得します(スラッグ、公開ステータス、回答数、埋め込み許可ドメインなど)。

スコープ: scorecards:read · 冪等(Idempotent)

引数 型 必須 説明
status all | published | draft いいえ 公開状態で絞り込み。デフォルトは all。

スコアカードの全容を取得します(基本設定、次元、設問、回答選択肢、ティア設定)。

スコープ: scorecards:read · 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 はい 対象スコアカードのスラッグ。

新しい下書きを作成します(表示設定、ブランド、総合評価ルール、埋め込み設定、メール取得設定を含む)。

スコープ: scorecards:write

引数 型 必須 説明
title 文字列 はい 回答者に表示されるタイトル。
subtitle 文字列 いいえ 対象者や所要時間を示すサブタイトル。
slug 文字列 いいえ URL用の一意なスラッグ。省略時はタイトルから自動生成。
idempotencyKey 文字列 いいえ 再試行時の重複作成を防ぐ一意キー。
ctaText 文字列 いいえ 開始ボタンのテキスト。
version 文字列 いいえ 内部管理用バージョン表記(例: “1.0”)。
theme default | playground | obsidian | brutalist いいえ 適用する視覚テーマ。
overallTierStrategy weakest | average いいえ 総合判定の計算方式(weakest: 最低次元に基づく、average: 平均値)。
tiers オブジェクト配列 いいえ 総合評価ティアの定義。
emailCaptureBeforeQuestions 真偽値 いいえ メール入力を質問の前に配置するかどうか。
privacyPolicyUrl 文字列またはnull いいえ プライバシーポリシーのURL。
termsUrl 文字列またはnull いいえ 利用規約のURL。
embed オブジェクト いいえ iframe埋め込み設定。
branding オブジェクト いいえ ブランドカラー、ロゴ、CTA。
emailCapture オブジェクト いいえ 連絡先取得画面の設定。
detail summary | full いいえ 返却される詳細度(デフォルトは summary)。

次元や設問を変更せずに、スコアカードの全体設定を更新します。

スコープ: scorecards:write · 破壊的

引数 型 必須 説明
slug 文字列 はい 編集対象スコアカードのスラッグ。
newSlug 文字列 いいえ 新しいスラッグ(旧URLからのリダイレクトは作成されません)。
title 文字列 いいえ 新しいタイトル。
subtitle 文字列 いいえ 新しいサブタイトル。
ctaText 文字列 いいえ 開始ボタンのテキスト。
version 文字列 いいえ 新しいバージョン表記。
theme default | playground | obsidian | brutalist いいえ 新しいテーマ。
overallTierStrategy weakest | average いいえ 総合判定の計算方式。
tiers オブジェクト配列 いいえ 総合ティア設定。
emailCaptureBeforeQuestions 真偽値 いいえ メール入力のタイミング。
privacyPolicyUrl 文字列またはnull いいえ プライバシーポリシーURL。
termsUrl 文字列またはnull いいえ 利用規約URL。
embed オブジェクト いいえ 埋め込み設定の変更。
branding オブジェクト いいえ ブランド設定の変更。
emailCapture オブジェクト いいえ 連絡先フォームの変更。
detail summary | full いいえ 返却される詳細度。

スコアカードに評価次元を追加します。

スコープ: scorecards:write

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
label 文字列 はい 次元名(例: 「スコープの明確さ」)。
shortLabel 文字列 いいえ チャート軸などで使用する短いラベル。
key 文字列 いいえ 次元の不変キー。
detail summary | full いいえ 返却される詳細度。

1つの次元に属する質問を一括登録します。各選択肢は最悪から最善への順序で配点されている必要があります。

スコープ: scorecards:write

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
dimensionKey 文字列 はい 対象となる次元キー。
questions オブジェクト配列 はい 質問の配列(推奨: 3〜5問)。
detail summary | full いいえ 返却される詳細度。

次元に単一の質問を追加します。

スコープ: scorecards:write

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
dimensionKey 文字列 はい 対象次元のキー。
text 文字列 はい 質問文。
answers オブジェクト配列 いいえ 配点付き選択肢。
detail summary | full いいえ 返却される詳細度。

次元ごとの判定ティア(名称と診断インサイト)を最下位から最上位の順で設定します。点数範囲は自動計算されます。

スコープ: scorecards:write · 破壊的, 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
dimensionKey 文字列 はい 対象次元のキー。
tiers オブジェクト配列 はい 昇順のティア定義(通常3段階)。
detail summary | full いいえ 返却される詳細度。

次元の名称、短縮名、重み、表示順を更新します。キー自体は変更できません。

スコープ: scorecards:write · 破壊的, 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
dimensionKey 文字列 はい 編集する次元のキー。
label 文字列 いいえ 新しい次元名。
shortLabel 文字列 いいえ 新しい短縮名。
weight 整数 いいえ 総合判定時の相対ウェイト。
position 整数 いいえ 表示位置(0始まり)。
detail summary | full いいえ 返却される詳細度。

質問文、選択肢、または次元内での並び順を変更します。過去の回答データには影響しません。

スコープ: scorecards:write · 破壊的, 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
questionId 文字列 はい 対象の質問ID。
text 文字列 いいえ 新しい質問文。
answers オブジェクト配列 いいえ 新しい選択肢群。
position 整数 いいえ 新しい表示位置。
detail summary | full いいえ 返却される詳細度。

質問を削除します。次元のティア点数範囲は自動再計算されます。

スコープ: scorecards:write · 破壊的

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
questionId 文字列 はい 削除する質問ID。
detail summary | full いいえ 返却される詳細度。

次元とその配下の全質問を削除します。

スコープ: scorecards:write · 破壊的

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
dimensionKey 文字列 はい 削除する次元のキー。
detail summary | full いいえ 返却される詳細度。

スコアカードが公開要件を満たしているか検証し、改善すべきポイントを報告します。

スコープ: scorecards:read · 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。

スコアカードを公開状態にするか、下書きに戻します。

スコープ: scorecards:write · 破壊的, 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 はい スコアカードのスラッグ。
published 真偽値 いいえ 公開時は true、下書きに戻す時は false。
detail summary | full いいえ 返却される詳細度。

回答データを新しい順に一覧取得します(ステータス、ティア、日付での絞り込み対応)。

スコープ: scorecards:read · 冪等(Idempotent)

引数 型 必須 説明
slug 文字列 いいえ 特定スコアカードに限定。省略時はアカウント全体。
status all | completed | partial いいえ 完了または途中離脱で絞り込み。
tier 文字列 いいえ 総合判定ティア名で絞り込み。
dimension 文字列 いいえ 最も低得点だった次元名で絞り込み。
since 文字列 いいえ 開始日(YYYY-MM-DD)。
until 文字列 いいえ 終了日(YYYY-MM-DD)。
search 文字列 いいえ 氏名・メール・会社名の検索。
limit 整数 いいえ 取得件数(デフォルトは25)。

1件の回答詳細をすべて取得します(連絡先情報、総合判定、次元別スコア、送信当時の設問と選択肢)。

スコープ: scorecards:read · 冪等(Idempotent)

引数 型 必須 説明
submissionId 文字列 はい 回答ID。