Analytics REST API 開発者ガイド
jAnalytics REST API リソースの概要
Analytics REST API は、Analytics データにアクセスするためのリソースを提供します。
すべての Analytics REST API リソースには、以下を使用してアクセスします。
- 会社の基本 URI (https://yourInstance.salesforce.com など)
- バージョン情報 (/services/data/v41.0 など)
- 名前付きリソース (/wave など)
1https://yourInstance.salesforce.com/services/data/v41.0/wave組織とオブジェクトの識別子
Salesforce および Analytics UI の ID 項目は、一般的に base-62 の 15 文字であり、大文字と小文字を区別します。JSON XMD にもこれは当てはまります。ただし、Dataset リソース /wave/datasets/<データセット ID> の Id プロパティのように、多くの Salesforce API は、Analytics REST API も含めて、18 文字を使用して、大文字と小文字を区別しません。最後の 3 桁は、前の 15 文字のチェックサムです。大文字と小文字を区別しない ID を使用すると、大文字と小文字を区別しない参照を使用する外部アプリケーションや開発環境とのやり取りが簡単になります。18 文字の ID を 15 文字の ID に変換するには、最後の 3 文字を削除します。
| リソース | 説明 | サポートされている HTTP メソッド | リソース URL |
|---|---|---|---|
| Wave リソース | Analytics で使用できる最上位のリソースをリストします。 | GET | /wave |
| Query リソース | Salesforce Analytics Query Language (SAQL) で記述されたクエリを実行します。 | POST | /wave/query |
| Datasets List リソース | Analytics データセットのリストを返します。 | GET | /wave/datasets |
| Dataset リソース | 指定された ID を持つ Analytics データセットを返すか、データセットを削除 (DELETE) するか、データセットを更新 (PATCH) します。 | GET、DELETE、PATCH | /wave/datasets/<dataset ID> |
| Dataset Versions List リソース | 特定のデータセットのデータセットバージョンのコレクションを返します。 | GET | /wave/datasets/<dataset ID>/versions |
| Dataset Version リソース | Analytics データセットのバージョンを返す (GET) か、述語を更新 (PATCH) します。 | GET、PATCH | /wave/datasets/<dataset ID>/versions/<version ID> |
| File リソース | データセットファイルのバイナリコンテンツへのアクセスを提供します。 | GET | /wave/datasets/<dataset ID>/versions/<version ID> /files/<file ID> |
| XMD List リソース | データセットのバージョンの XMD リソースのリストを返します。 | GET | /wave/datasets/<dataset ID>/versions/<version ID>/xmds |
| XMD リソース | データセットのバージョンの拡張メタデータ (XMD) を返し (GET)、ユーザ XMD ファイルを置き換えます (PUT)。 | GET、PUT | /wave/datasets/<dataset ID>/versions/<version ID>/xmds/<XMD type> |
| Lenses List リソース | Analytics レンズのリストを返す (GET) か、レンズを作成 (POST) します。 | GET、POST | /wave/lenses |
| Lens リソース | 指定された ID を持つ Analytics レンズの構造が記述されている JSON ファイルを返す (GET) か、レンズを削除 (DELETE) するか、レンズを更新 (PATCH) します。 | GET、DELETE、POST | /wave/lenses/<lens ID> |
| Lens File リソース | Analytics レンズに含まれるファイルを返します。 | GET、PUT | /wave/lenses/<lenses ID>/files/<files ID> |
| Dashboards List リソース | Analytics ダッシュボードのリストを返すか、ダッシュボードを作成します。 | GET��POST | /wave/dashboards |
| Dashboard リソース | 指定された ID または API 参照名を持つダッシュボードを返したり更新したりします。 | GET、DELETE、PATCH | /wave/dashboards/<dashboard ID> |
| Dependencies リソース | アプリケーション (フォルダ) の連動関係を返します。 | GET | /wave/dependencies/<folder ID> |
| Folders List リソース | Analytics データセット、レンズ、ダッシュボードが含まれるフォルダである Analytics アプリケーションを作成 (POST) するか、アプリケーションまたはフォルダのコレクションを返します (GET)。 | GET、POST | /wave/folders |
| Folder リソース | Analytics アプリケーションまたはフォルダの表現を返す (GET) か、アプリケーションまたはフォルダを置換 (PUT) するか、更新 (PATCH) するか、削除 (DELETE) します。 | GET、PUT、PATCH、DELETE | /wave/folders/<folder ID> |
| Replicated Datasets リソース | 外部ソースオブジェクトのデータをデータセットとして Analytics に複製します。複製データセットは直接視覚化するようには意図されていません。同じソースオブジェクトを参照する他のワークフローを高速化するために、キャッシュのように使用されます。 | GET、PATCH、DELETE | /wave/replicatedDatasets/<ID> |
| Replicated Datasets List リソース | 複製データセットのリストを返します。 | GET、POST | wave/replicatedDatasets |
| Replicated Dataset Fields リソース | 特定の複製データセットの複製項目のリスト。 | GET、PATCH | /wave/replicatedDatasets/<ID>/fields |
| Templates List リソース | Analytics テンプレートのリストを返すか、テンプレートを追加します。 | GET | /wave/templates |
| Templates リソース | Analytics テンプレートのリストを返すか、テンプレートを追加します。 | GET | /wave/templates/<templateIdOrApiName> |
| Templates Configuration リソース | Analytics テンプレートの設定を返します。 | GET | /wave/templates/<templateIdOrApiName>/configuration |
| Trended Reports List リソース | トレンド分析レポートのコレクションを返すか追加します。 | GET、POST | /wave/trendedreports |
| Trended Reports リソース | トレンド分析レポートを返したり、削除したり、更新したりします。 | DELETE、GET、PATCH | /wave/trendedreports/<Id> |
| Lens File Metadata リソース | Analytics レンズファイルのメタデータを管理するためのリソース。 | GET、POST | /wave/lenses/<lensId>/files |
| Features Configuration リソース | ユーザが使用できる Analytics 機能です。 | GET | /wave/config/features |
| Annotations List リソース | アノテーションのコレクションです。 | GET、POST | /wave/annotations |
| Annotations リソース | アセットのアノテーションです。 | GET、PATCH | /wave/annotations/<Annotation ID> |
| Template Release Notes リソース | 1 つの Analytics テンプレートのリリースノートを取得するリソースです。 | GET | /wave/templates/<templateIdOrApiName>/releasenotes |
| Charts Maps List リソース | 地図のコレクションを取得したり、新しい地図を投稿したりします。 | GET POST | /eclair/maps |
| Charts Maps リソース | 特定の地図の取得、更新、削除を行います。 | DELETE GET PATCH | /eclair/maps/<id> |
| Charts Geodata リソース | 特定の地理データ定義の取得、更新、削除を行います。 | DELETE GET PATCH | /eclair/geodata/<id> |
| Charts Geodata List リソース | 地理データの定義のコレクションを取得したり、新しい地理データの定義を投稿したりします。 | GET POST | /eclair/geodata |
| Charts Geodata File List リソース | 地理データの定義に関連付けられたバイナリファイルを取得します。 | GET | /eclair/geodata/<id>/file |
| Data Connector リソース | データコネクタを操作する。 | GET DELETE PATCH POST |
|
| Recipe のリソース | レシピを取得または更新する。 | GET DELETE PATCH |
|
| Security のリソース | オブジェクトおよび特定のデータセットバージョンが継承共有をサポートしているかどうかを確認する。 | GET |
|
REST 応答の絞り込み
Analytics アプリケーションまたはフォルダの表現を返す (GET) か、アプリケーションまたはフォルダを置換 (PUT) するか、更新 (PATCH) するか、削除 (DELETE) します。
Analytics REST API 入力パラメータに加え、Chatter REST API 入力パラメータを使用して、filterGroup、external、および internal 要求から返された結果を絞り込むことができます。詳細は、『Chatter REST API 開発者ガイド』の「応答サイズの指定」を参照してください。