この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

GET /api/v1/insight/calculated-insights/(ci-name)

この API は、計算済みインサイトを照会するために使用します。異なるディメンション、基準、検索条件を選択することで絞り込みを行うことができます。

構文

HTTP のメソッド
GET
使用可能なバージョン
Data Cloud v1.0、Salesforce v51.0
形式
REST
URI
/api/v1/insight/calculated-insight/(ci-name)

要求パラメーター

項目名 説明
ci_name
項目の型
string
説明

必須。

計算済みインサイトの名前。
dimensions
項目の型
string
説明
投影するディメンションのカンマ区切りのリスト。デフォルトでは、このパラメーターには使用可能なすべてのディメンションが含まれます。例: GenderId__c
measures
項目の型
string
説明
投影する基準のカンマ区切りのリスト。デフォルトでは、このパラメーターには使用可能なすべての基準が含まれます。例: TotalSales__c
limit
項目の型
int
説明
返される項目の数。デフォルトでは、最大値である 4999 件の項目が返されます。例: 1000
offset
項目の型
int
説明
結果を返す最初の行までスキップする行数。例: 100
filters
項目の型
string
説明
このパラメーターをクエリに追加することで、特定のデータ型の結果のみを返すことができます。例: [GenderId__c=Male,FirstName__c=Angel]
orderby
項目の型
string
説明
結果セットを昇順または降順に���び替えるための値のカンマ区切りリスト。例: GenderId__c ASC, Occupation__c DESC
timeGranularity
項目の型
string
説明
このパラメーターにより、基準をさまざまな時間範囲で積み上げ集計できます。可能な値: HOUR、DAY、MONTH、QUARTER、YEAR

この項目は、API バージョン 53.0 以降で使用できます。

要求
1https://{TSE}.360a.salesforce.com/api/v1/insights/calculated-insights​/{ci-name}
応答
1{
2  "data": [
3    {
4      "Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
5      "FirstName__c": "Don",
6      "Avg_Spend__c": 1335.15
7    },
8    {
9      "Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
10      "FirstName__c": "Wensei",
11      "Avg_Spend__c": 942.67
12    },
13    {
14      "Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
15      "FirstName__c": "Ryan",
16      "Avg_Spend__c": 2886.50
17    }
18  ],
19  done: true
20}

HTTP 応答

応答 理由
200 OK コールバックが正常に検証されました。
400 Bad Request 無効な要求です。
403 Forbidden 承認の受け渡しに失敗しました。
404 Not Found コールバック ID または検証キー、あるいはその両方が正しくありません。
422 Unprocessable Entity 項目または検索条件パラメーターで使用されている属性名が存在しません。
500 Server Error 内部エラー。