Get All Calculated Insights Metadata

Retrieves metadata for all available calculated insights in your Data 360 instance. This endpoint returns detailed information about dimensions, measures, and relationships for each calculated insight.

Syntax

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

Response Structure

The response includes an array of metadata objects, each 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

Response

{
  "metadata": [
    {
      "name": "runner_ci__cio",
      "displayName": "runner ci",
      "dimensions": [
        {
          "name": "runner_id__c",
          "displayName": "runner id",
          "type": "NUMBER"
        }
      ],
      "measures": [
        {
          "name": "total_exercises__c",
          "displayName": "total exercises",
          "type": "NUMBER",
          "rollupable": true
        },
        {
          "name": "total_km__c",
          "displayName": "total km",
          "type": "NUMBER",
          "rollupable": true
        }
      ],
      "relationships": [
        {
          "fromEntity": "runner__dlm",
          "toEntity": "runner_ci__cio"
        },
        {
          "fromEntity": "Exercises__dlm",
          "toEntity": "runner_ci__cio"
        }
      ],
      "partitionBy": "runner_id__c"
    },
    {
      "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 all calculated insights available to the authenticated user
• Each insight's metadata includes all available dimensions and measures
• Relationship information helps understand data connections between different entities
• The partitionBy field indicates how the data is organized for efficient querying