GET /api/v1/insight/metadata/{ci-name}
Retrieves detailed metadata for a specific calculated insight in your Data Cloud instance. This endpoint returns information about dimensions, measures, and relationships for the specified calculated insight.
- HTTP Method: GET
- Availability: Data Cloud v1.0, Salesforce v51.0
- Format: REST
- URI:
/api/v1/insight/metadata/{ci-name}
Parameter | Type | Description |
---|---|---|
ci-name | string | Required. The unique identifier of the calculated insight. Example: IndividualChildrenCount__cio |
The response includes a metadata object containing:
name
: The unique identifier of the calculated insightdisplayName
: The human-readable name of the calculated insightdimensions
: Array of dimension objects with name, displayName, and typemeasures
: Array of measure objects with name, displayName, type, and rollupable flagrelationships
: Array of relationship objects showing connections between entitiespartitionBy
: The field used for partitioning the data
- 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