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

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

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

Response

{
  "metadata": [
    {
      "name": "Avg_Spends__cio",
      "displayName": "Avg Spends",
      "dimensions": [
        {
          "name": "Id__c",
          "displayName": "Id",
          "type": "STRING"
        },
        {
          "name": "FirstName__c",
          "displayName": "First Name",
          "type": "STRING"
        }
      ],
      "measures": [
        {
          "name": "Avg_Spend__c",
          "displayName": "Avg Spend",
          "type": "NUMBER",
          "rollupable": true
        }
      ],
      "relationships": [
        {
          "fromEntity": "ssot__Individual__dlm",
          "toEntity": "Avg_Spends__cio"
        }
      ],
      "partitionBy": "Id__c"
    }
  ]
}

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