GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
インデックスと検索条件に基づいてデータモデルオブジェクトと計算済みビューを返します。
構文
- HTTP のメソッド
- GET
- 使用可能なバージョン
- Data Cloud v1.0、Salesforce v51.0
- 形式
- REST
- URI
- /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
要求パラメータ
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| ci_name | string | 必須。計算済みインサイトの名前。例: IndividualChildrenCount__cio |
| dataModelName | string | 必須。データモデルオブジェクトの API 参照名。例: UnifiedIndividual__dlm |
| dimensions | string | 計算済みビューから返される結果に含めるディメンション名のカンマ区切りリスト。デフォルトではすべてのディメンションが含められます。例: Id__c |
| filters | string | 検索条件は親オブジェクトにのみ適用されます。例: [FirstName__c=Angel] |
| id | string | 必須。インデックスが付けられた列の値。例: 003726a3-061d-33e7-a5a5-96ecae866a61 |
| limit | int | 返される項目の数。例: 10 |
| measures | string | 計算済みビューから返される結果に含める基準名のカンマ区切りリスト。デフォルトではすべての基準が含められます。例: TotalSales__c |
| offset | int | 結果を返す最初の行までスキップする行数。例: 100 この項目は、API バージョン 52.0 以降で使用できます。 |
| orderby | string | 結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。例: GenderId__c ASC、Occupation__c DESC この項目は、API バージョン 52.0 以降で使用できます。 |
| searchKey | string | オブジェクト ID がプライマリキーと異なる場合のインデックス名。例: FirstName__c |
| timeGranularity | string | このパラメータにより、基準をさまざまな時間範囲で積み上げ集計できます。可能な値: HOUR、DAY、MONTH、QUARTER、YEAR この項目は、API バージョン 53.0 以降で使用できます。 |
例
- 要求
-
1https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name} - 応答
-
1{ 2 "data": [ 3 { 4 "GenderId__c": "F", 5 "Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f", 6 "Occupation__c": "Staffing", 7 "FirstName__c": "Don" 8 }, 9 { 10 "GenderId__c": "M", 11 "Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c", 12 "Occupation__c": "Operational", 13 "FirstName__c": "Don" 14 }, 15 { 16 "GenderId__c": "M", 17 "Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b", 18 "Occupation__c": "Organizational", 19 "FirstName__c": "Don" 20 } 21 ], 22 "done": false 23}
HTTP 応答
| 応答 | 理由 |
|---|---|
| 200 OK | コールバックが正常に検証されました。 |
| 400 Bad Request | 無効な要求です。 |
| 403 Forbidden | 承認の受け渡しに失敗しました。 |
| 404 Not Found | コールバック ID または検証キー、あるいはその両方が正しくありません。 |
| 422 Unprocessable Entity | 項目/検索条件パラメータで使用されている属性名が存在しません。 |
| 500 Server Error | 内部エラーです。 |