Analytics REST API 開発者ガイド
jAnalytics REST API リソースの概要
Analytics REST API は、Analytics データにアクセスするためのリソースを提供します。
すべての Analytics REST API リソースには、以下を使用してアクセスします。
- 会社のベース URL (https://yourInstance.salesforce.com など)
- バージョン情報 (/services/data/v42.0 など)
- 名前付きリソース (/wave など)
1https://yourInstance.salesforce.com/services/data/v42.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 POST | /wave/datasets |
| Dataset リソース | 指定された ID を持つ Analytics データセットを返すか、データセットを削除 (DELETE) するか、データセットを更新 (PATCH) します。 | GET、DELETE、PATCH | /wave/datasets/<datasetIdOrApiName> |
| Dataset Versions List リソース | 特定のデータセットのデータセットバージョンのコレクションを返します。 | GET | /wave/datasets/<datasetIdOrApiName>/versions |
| Dataset Version リソース | Analytics データセットのバージョンを返す (GET) か、述語を更新 (PATCH) します。 | GET、PATCH | /wave/datasets/<datasetIdOrApiName>/versions/<versionId> |
| File リソース | データセットファイルのバイナリコンテンツへのアクセスを提供します。 | GET | /wave/datasets/<datasetIdOrApiName>/versions/<versionId>/files/<fileId> |
| XMD List リソース | データセットのバージョンの XMD リソースのコレクションを返します。このコレクションは、メイン、システム、ユーザ種別の XMD 用です。アセット種別の XMD を表示するには、「Asset XMD API リソース」を参照してください。 | GET | /wave/datasets/<dataset ID>/versions/<versionId>/xmds |
| XMD リソース | データセットのバージョンの拡張メタデータ (XMD) を返して、ユーザ XMD ファイルを更新します。 | GET、PUT | /wave/datasets/<dataset ID>/versions/<versionId>/xmds/<xmdType> |
| Lenses List リソース | Analytics レンズのコレクションを返したり、レンズを作成したりします。 | GET、POST | /wave/lenses |
| Lens リソース | 指定された ID を持つ Analytics レンズの構造が記述されている JSON ファイルを返したり、レンズを削除または更新したりします。 | GET、DELETE、PATCH | /wave/lenses/<lensIdOrApiName> |
| Lens File リソース | Analytics レンズに含まれるファイルを返します。 | GET、PUT | /wave/lenses/<lensIdOrApiName>/files/<files ID> |
| Dashboards List リソース | Analytics ダッシュボードのコレクションを返したり、ダッシュボードを作成したりします。 | GET、POST | /wave/dashboards |
| Dashboard リソース | 指定された ID または API 参照名を持つダッシュボードを返したり更新したりします。 | GET、DELETE、PATCH | /wave/dashboards/<dashboardIdOrApiName> |
| Dashboard Saved Views リソース | 保存済みビューを操作します。 | GET DELETE PATCH POST |
|
| Dependencies リソース | アセットの連動関係を返します。 | GET | /wave/dependencies/<folderId> |
| Folder リソース | フォルダのコレクションを返したり、フォルダを作成、更新、または削除したりします。 | GET、POST、PATCH、DELETE |
|
| Replicated Datasets リソース | 複製データセット (接続済みオブジェクトともいう) を返したり、更新や削除したりします。データ同期は、Analytics でソースオブジェクトデータを接続済みオブジェクトとして読み込みます。接続済みオブジェクトは直接視覚化できませんが、ソースオブジェクトから取得してデータセットに読み込む他のジョブを加速する目的で、キャッシュと同様に使用されます。 | GET、PATCH、DELETE | /wave/replicatedDatasets/<replicatedDatasetId> |
| Replicated Datasets List リソース | 複製データセット (接続済みオブジェクトともいう) のコレクションを返します。 | GET、POST | wave/replicatedDatasets |
| Replicated Dataset Fields リソース | 指定された接続済みオブジェクトの項目のコレクションを返します。 | GET、PATCH | /wave/replicatedDatasets/<replicatedDatasetId>/fields |
| Templates List リソース | Analytics テンプレートのコレクションを返したり、テンプレートを作成したりします。 | GET POST | /wave/templates |
| Template リソース | Analytics テンプレートのコレクションを返したり、テンプレートを作成したりします。 | GET POST | /wave/templates/<templateIdOrApiName> |
| Template Configuration リソース | Analytics テンプレートの設定を返します。 | GET | /wave/templates/<templateIdOrApiName>/configuration |
| Auto-Install Request リソース | 自動インストール要求のコレクションを返したり、自動インストール要求を作成、更新、または削除したりします。 | GET PATCH POST DELETE | /wave/auto-install-requests /wave/auto-install-requests/<autoInstallRequestId> |
| 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/<annotationId> |
| 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 |
|
| Dataflows リソース | データフローを操作します。 | GET POST PATCH |
|
| Dataflow Jobs リソース | データフロージョブを操作します。 | GET POST PATCH |
|
| Dataflow Jobs Nodes リソース | データフロージョブノードを取得します。 | GET |
|
| Security のリソース | オブジェクトおよび特定のデータセットバージョンが継承共有をサポートしているかどうかを確認する。 | GET |
|
REST 応答の絞り込み
Analytics アプリケーションまたはフォルダの表現を返す (GET) か、アプリケーションまたはフォルダを置換 (PUT) するか、更新 (PATCH) するか、削除 (DELETE) します。
Analytics REST API 入力パラメータに加え、filterGroup、external、および internal の Connect REST API 入力パラメータを使用して、要求から返された結果を絞り込むことができます。詳細は、『Connect REST API 開発者ガイド』の「応答サイズの指定」を参照してください。