CRM Analytics REST API 開発者ガイド
Winter '25 (API version 62.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Action Input
Advanced Property Value Input
Analytics App Setting Collection Input
Analytics App Setting Input
Annotation Input
Asset Reference Input
Asset Revert History Input
Auto-Install App Configuration Input
Auto-Install Configuration
Auto-Install Request Insert Input
Auto-Install Request Update Input
Base Asset Input
Base Asset Reference Input
Base Auto-Install Request Input
Base Notification Action Configuration Input
Base Subscription Input
Base Wave Folder Input
Collaboration Room Notification Recipient Input
Collection Subscription Source Input
Conditional Formatting Property
Constant Input
Daily Schedule Input
Daily Scheduled Item Input
Dashboard Subscription Source Input
Dashboard Widget Item Input
Data Connector Input
Data Connector Property
Dataflow Input
Dataflow Job Input
Dataset Input
Dataset Version Input
Event Based Schedule Input
Featured Assets Input
Geo Data Input
Hourly Schedule Input
Json Transformation Input
License Attributes Input
Live Connection Input
Macro Input
Map Bounding Box Input
Map Input
Minutely Schedule Input
Monthly Relative Schedule Input
Monthly Specific Schedule Input
Notification Action Input
Post To Slack Notification Action Configuration Input
Replicated Dataset Input
Replicated Field Collection Input
Replicated Field Input
Restore Dataset Version Input
Rule Definition Input
Rule Input
SAQL Query Input
Schedule Details Input
Schedule Input
Scheduled Item Input
Scheduled Time Input
Scheduled Timezone Input
Send To Email Notification Action Configuration Input
Slack Reference Input
Source Details Input
Source Object Data Input
Subscription Daily Schedule Input
Subscription Input
Subscription Schedule Input
Subscription Source Input
Subscription Weekly Schedule Input
Subscription Widget Input
Template Input
Template Options Input
Template Validate Input
Time Input
Trended Report Input
Typed Asset Reference Input
Visual Parameters Input
Watchlist Input
Watchlist Item Input
Watchlist Item Metadata Input
Watchlist Schedule Input
Wave Collection Input
Wave Collection Item Input
Wave Collection Item List Input
Wave Collection Pin Input
Wave Folder Input
Wave Folder Schedule Input
Wave Folder Share Input
Wave Folder Template Input
Weekly Schedule Input
Weekly Scheduled Item Input
Widget Subscription Source Input
Base Xmd Dimension Custom Action Input
Base Xmd Dimension Input
Base Xmd Measure Input
Xmd Currency Settings Input
Xmd Dataset Input
Xmd Date Field Input
Xmd Date Input
Xmd Derived Dimension Custom Action Input
Xmd Derived Dimension Input
Xmd Derived Dimension Member Input
Xmd Derived Dimension Salesforce Action Input
Xmd Derived Measure Format Input
Xmd Derived Measure Input
Xmd Dimension Custom Action Input
Xmd Dimension Input
Xmd Dimension Member Input
Xmd Dimension Salesforce Action Input
Xmd Input
Xmd Measure Format Input
Xmd Measure Input
Xmd Organization Input
CRM Analytics REST API リクエストボディ
POST、PATCH、または PUT 要求を実行するには、クエリパラメータを渡すか、XML または JSON 形式のリクエストボディを作成します。この章には、リクエストボディのリストが記載されています。クエリパラメータは、各リソースと一緒にリストに含まれています。
JSON リクエストボディを作成するには、JSON 形式でリクエストボディのプロパティを指定します。
Comment リクエストボディの例を次に示します。
1{
2 "body" : "Let's look for a new solution."
3}最上位レベルのリクエストボディの場合は、ルート XML タグが表示されます。XML リクエストボディを作成するには、プロパティをルート XML タグの内部に XML タグとしてネストします。
同じ Analytics リクエストボディに XML 形式を使用すると次のようになります。
1<comment>
2 <body>Let's look for a new solution.</body>
3</comment>-
Action Input
JSON 変換時に実行するルールまたはマクロのアクション。 -
Advanced Property Value Input
詳細プロパティの名前と値のペア。 -
Analytics App Setting Collection Input
Analytics アプリケーション設定のコレクション。 -
Analytics App Setting Input
Analytics アプリケーションの設定。 -
Annotation Input
Analytics のアノテーション。 -
Asset Reference Input
Analytics アセットの参照。 -
Asset Revert History Input
元に戻す要求に使用する Analytics アセット履歴。 -
Auto-Install App Configuration Input
自動インストールアプリケーションの設定。 -
Auto-Install Configuration
自動インストールアプリケーションの設定。 -
Auto-Install Request Insert Input
自動インストール要求の挿入。 -
Auto-Install Request Update Input
自動インストール要求の更新。 -
Base Asset Input
基本 Analytics アセット入力。 -
Base Asset Reference Input
基本 Analytics アセット。 -
Base Auto-Install Request Input
基本自動インストール要求入力。 -
Base Notification Action Configuration Input
基本分析通知アクションの設定。 -
Base Subscription Input
基本登録要求の入力。 -
Base Wave Folder Input
基本 Analytics フォルダアセット。 -
Collaboration Room Notification Recipient Input
通知の Slack 受信者。 -
Collection Subscription Source Input
コレクション登録ソース。 -
Conditional Formatting Property
Xmd ディメンションおよび基準の条件付き書式のプロパティ。 -
Constant Input
JSON 変換ルールの定数の定義。 -
Daily Schedule Input
Analytics アセットの 1 日のスケジュールを指定します。 -
Daily Scheduled Item Input
データ更新用の日次スケジュール。 -
Dashboard Subscription Source Input
ダッシュボード登録ソース。 -
Dashboard Widget Item Input
基本ダッシュボードウィジェット項目。 -
Data Connector Input
Analytics データコネクタ。 -
Data Connector Property
Analytics データコネクタのプロパティ。 -
Dataflow Input
Analytics データフロー。 -
Dataflow Job Input
Analytics データフロージョブ。 -
Dataset Input
Analytics データセット。 -
Dataset Version Input
Analytics データセットの特定のバージョン。 -
Event Based Schedule Input
Analytics アセットのイベント駆動型スケジュールを指定します。 -
Featured Assets Input
Analytics アプリケーションの主要アセット。 -
Geo Data Input
地図で使用される地理データ。 -
Hourly Schedule Input
Analytics アセットの 1 日の部分的なスケジュールを指定します。 -
Json Transformation Input
変換ルールの実行対象となる JSON 要求。 -
License Attributes Input
Analytics ライセンスの属性。 -
Live Connection Input
Analytics ライブデータセットの接続の詳細。 -
Macro Input
JSON 変換ルールに使用するマクロ。 -
Map Bounding Box Input
地図の境界ボックス。 -
Map Input
Eclair チャートの地図。 -
Minutely Schedule Input
Analytics アセットの時間未満の単位のスケジュールを指定します。 -
Monthly Relative Schedule Input
Analytics アセットの月次スケジュールを相対的な日にちで指定します。 -
Monthly Specific Schedule Input
Analytics アセットの月次スケジュールを固定の数値の日付で指定します。 -
Notification Action Input
Analytics サブスクリプションの通知アクション。 -
Post To Slack Notification Action Configuration Input
Slack に投稿するための通知アクション設定。 -
Replicated Dataset Input
Analytics 複製データセット (接続済みオブジェクトとも呼ばれる)。 -
Replicated Field Collection Input
Analytics 複製データセット (接続済みオブジェクトとも呼ばれる) の項目のコレクション。 -
Replicated Field Input
Analytics 複製データセット (接続済みオブジェクトとも呼ばれる) の項目。 -
Restore Dataset Version Input
Analytics データセットを復元する特定のバージョン。 -
Rule Definition Input
JSON 変換に使用するルール定義。 -
Rule Input
JSON 変換ルール定義のルール。 -
SAQL Query Input
SAQL または SQL で記述された Analytics クエリ。 -
Schedule Details Input
基本 Analytics スケジュールの詳細。 -
Schedule Input
スケジュール。これに従って何らかの種別の Analytics アセットが実行されます。 -
Scheduled Item Input
データ更新用の基本スケジュール。 -
Scheduled Time Input
データ更新用の基本スケジュール。 -
Scheduled Timezone Input
スケジュールのタイムゾーンの情報。 -
Send To Email Notification Action Configuration Input
メール送信の通知アクション設定。 -
Slack Reference Input
Slack エンティティの参照。 -
Source Details Input
登録のための抽象的なソースの詳細。 -
Source Object Data Input
項目と詳細プロパティのリストに基づいて取得元オブジェクトからデータを取得するための要求。 -
Subscription Daily Schedule Input
Analytics サブスクリプションを実行する 1 日のスケジュール。 -
Subscription Input
Analytics サブスクリプション。 -
Subscription Schedule Input
Analytics サブスクリプションの入力。 -
Subscription Source Input
登録ソース。 -
Subscription Weekly Schedule Input
Analytics サブスクリプションを実行する 1 週間のスケジュール。 -
Subscription Widget Input
Analytics ウィジェットサブスクリプションは、ベースとなる Dashboard Widget Item Input からプロパティを継承します。 -
Template Input
Analytics テンプレート。 -
Template Options Input
テンプレート Analytics アプリケーションのアップグレードに使用されるテンプレートオプション。 -
Template Validate Input
Analytics テンプレートを検証するための入力。 -
Time Input
何らかの処理が (通常は Analytics スケジュールに関連して) 行われる時刻。 -
Trended Report Input
Analytics トレンドレポート。 -
Typed Asset Reference Input
型付けされた Analytics アセットの参照。 -
Visual Parameters Input
Analytics ウォッチリスト項目の視覚的パラメータ。 -
Watchlist Input
Analytics ウォッチリスト。 -
Watchlist Item Input
Analytics ウォッチリスト項目。 -
Watchlist Item Metadata Input
Analytics ウォッチリスト項目のメタデータ。 -
Watchlist Schedule Input
Analytics ウォッチリストスケジュール。 -
Wave Collection Input
Analytics リソースのコレクション。 -
Wave Collection Item Input
Analytics リソースのコレクション内の項目。 -
Wave Collection Item List Input
Analytics リソースのコレクション内の項目のリスト。 -
Wave Collection Pin Input
Analytics コレクションの固定ルール。 -
Wave Folder Input
分析フォルダ。BaseWaveFolderInput を実装します。 -
Wave Folder Schedule Input
分析フォルダのスケジュール。 -
Wave Folder Share Input
分析フォルダの共有ルール。 -
Wave Folder Template Input
テンプレート分析フォルダ。BaseWaveFolderInput を実装します。 -
Weekly Schedule Input
Analytics アセットの週次スケジュールを指定します。 -
Weekly Scheduled Item Input
データ更新用の週次スケジュール。 -
Widget Subscription Source Input
ウィジェットサブスクリプションソース。 -
Base Xmd Dimension Custom Action Input
Xmd ディメンションの基本カスタムアクション。 -
Base Xmd Dimension Input
ディメンションと派生ディメンションの基本 Xmd ディメンション。 -
Base Xmd Measure Input
基準と派生基準の基本 Xmd 基準。 -
Xmd Currency Settings Input
通貨項目の通貨設定用の拡張メタデータ (Xmd)。 -
Xmd Dataset Input
Analytics データセット用の拡張メタデータ (Xmd)。 -
Xmd Date Field Input
日付項目の書式設定用の拡張メタデータ (Xmd)。 -
Xmd Date Input
日付用の拡張メタデータ (Xmd)。 -
Xmd Derived Dimension Custom Action Input
Xmd 派生ディメンションのカスタムアクション。 -
Xmd Derived Dimension Input
Analytics データセットの派生ディメンション用の拡張メタデータ (Xmd)。 -
Xmd Derived Dimension Member Input
Analytics データセットの派生ディメンションのメンバー用の拡張メタデータ (Xmd)。 -
Xmd Derived Dimension Salesforce Action Input
Analytics データセットの派生ディメンションの Saleforce アクション用の拡張メタデータ (Xmd)。 -
Xmd Derived Measure Format Input
Analytics データセットの派生基準の形式用の拡張メタデータ (Xmd)。 -
Xmd Derived Measure Input
Analytics データセットの派生基準用の拡張メタデータ (Xmd)。 -
Xmd Dimension Custom Action Input
Xmd ディメンションのカスタムアクション。 -
Xmd Dimension Input
Analytics データセットのディメンション用の拡張メタデータ (Xmd)。 -
Xmd Dimension Member Input
Analytics データセットのディメンションにリンクされているメンバー用の拡張メタデータ (Xmd)。 -
Xmd Dimension Salesforce Action Input
Analytics データセットのディメンションの Saleforce アクション用の拡張メタデータ (Xmd)。 -
Xmd Input
Analytics データセットバージョン用の拡張メタデータ (Xmd)。 -
Xmd Measure Format Input
Analytics データセットの基準の形式用の拡張メタデータ (Xmd)。 -
Xmd Measure Input
Analytics データセットの基準用の拡張メタデータ (Xmd)。 -
Xmd Organization Input
Analytics データセットの組織用の拡張メタデータ (Xmd)。