GET /api/v1/insight/metadata

The metadata includes the dimension and measure that are part of the calculated insight.

Syntax

HTTP method
GET
Availability
Salesforce CDP v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/insight/metadata

Examples

Request
1https://{TSE}.360a.salesforce.com/api/v1/insight/metadata
Response
1{
2    "metadata": [
3        {
4            "name": "runner_ci__cio",
5            "displayName": "runner ci",
6            "dimensions": [
7                {
8                    "name": "runner_id__c",
9                    "displayName": "runner id",
10                    "type": "NUMBER"
11                }
12            ],
13            "measures": [
14                {
15                    "name": "total_exercises__c",
16                    "displayName": "total exercises",
17                    "type": "NUMBER",
18                    "rollupable": true
19                },
20                {
21                    "name": "total_km__c",
22                    "displayName": "total km",
23                    "type": "NUMBER",
24                    "rollupable": true
25                }
26            ],
27            "relationships": [
28                {
29                    "fromEntity": "runner__dlm",
30                    "toEntity": "runner_ci__cio"
31                },
32                {
33                    "fromEntity": "Exercises__dlm",
34                    "toEntity": "runner_ci__cio"
35                }
36            ],
37            "partitionBy": "runner_id__c"
38        },
39        {
40           "name": "Avg_Spends__cio",
41           "displayName": "Avg Spends",
42           "dimensions": [
43              {
44                 "name": "Id__c",
45                 "displayName": "Id",
46                 "type": "STRING"
47              },
48              {
49                 "name": "FirstName__c",
50                 "displayName": "First Name",
51                 "type": "STRING"
52              }
53           ],
54           "measures": [
55              {
56                 "name": "Avg_Spend__c",
57                 "displayName": "Avg Spend",
58                 "type": "NUMBER",
59                 "rollupable": true
60              }
61           ],
62           "relationships": [
63              {
64                 "fromEntity": "ssot__Individual__dlm",
65                 "toEntity": "Avg_Spends__cio"
66              }
67           ],
68           "partitionBy": "Id__c"
69        }
70    ]
71}

HTTP Responses

Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
500 Server Error Internal error