Get Calculated Insight Metadata

Retrieves detailed metadata for a specific calculated insight in your Data 360 instance. This endpoint returns information about dimensions, measures, and relationships for the specified calculated insight.

Syntax 

  • HTTP Method: GET
  • Availability: Data 360 v1.0, Salesforce v51.0
  • Format: REST
  • URI: /api/v1/insight/metadata/{ci-name}

Path Parameters 

ParameterTypeDescription
ci-namestringRequired. The unique identifier of the calculated insight. Example: IndividualChildrenCount__cio

Response Structure 

The response includes a metadata object containing:

  • name: The unique identifier of the calculated insight
  • displayName: The human-readable name of the calculated insight
  • dimensions: Array of dimension objects with name, displayName, and type
  • measures: Array of measure objects with name, displayName, type, and rollupable flag
  • relationships: Array of relationship objects showing connections between entities
  • partitionBy: The field used for partitioning the data

Examples 

Request 

1GET https://{TSE}.360a.salesforce.com/api/v1/insight/metadata/Avg_Spends__cio

Response 

1{
2  "metadata": [
3    {
4      "name": "Avg_Spends__cio",
5      "displayName": "Avg Spends",
6      "dimensions": [
7        {
8          "name": "Id__c",
9          "displayName": "Id",
10          "type": "STRING"
11        },
12        {
13          "name": "FirstName__c",
14          "displayName": "First Name",
15          "type": "STRING"
16        }
17      ],
18      "measures": [
19        {
20          "name": "Avg_Spend__c",
21          "displayName": "Avg Spend",
22          "type": "NUMBER",
23          "rollupable": true
24        }
25      ],
26      "relationships": [
27        {
28          "fromEntity": "ssot__Individual__dlm",
29          "toEntity": "Avg_Spends__cio"
30        }
31      ],
32      "partitionBy": "Id__c"
33    }
34  ]
35}

Notes 

  • The response includes detailed metadata for the specified calculated insight only
  • All dimensions and measures available for the insight are included in the response
  • Relationship information shows how the insight connects to other entities
  • The partitionBy field indicates the primary key used for data organization