Data Cloud Resources

Get metadata and query data. Get, create, update, run, and delete calculated insights. Look up objects by source ID. Get, create, update, and delete segments. Get, create, run, update, and delete identity resolution rulesets.

Note

Connect REST API authentication is different from the authentication for other Data Cloud APIs. See OAuth and Connect REST API for more information.

For limit information, see API Limits for Profile, Query, and Calculated Insights.

Available resources are:

ResourceDescription
/ssot/metadataGet all metadata, including Calculated Insights, Engagement, Profile, and other objects, as well as their relationships to other objects.
ResourceDescription
/ssot/profile/metadataGet metadata for data model objects in the profile category, including Individual, Contact Point Email, Unified Individual, and Contact Point Address objects. Metadata includes the objects, their fields, and category.
/ssot/profile/metadata/{dataModelName}Get metadata for a data model object in the profile category, such as Individual, Contact Point Email, Unified Individual, and Contact Point Address. Metadata includes the list of fields, data types, and indexes available for lookup.
/ssot/profile/{dataModelName}Query a Profile data model object using filters.
/ssot/profile/{dataModelName}/{id}Query a Profile data model object using filters and a search key.
/ssot/profile/{dataModelName}/{id}/{childDataModelName}Query a Profile data model object and a child object using filters and a search key.
/ssot/profile/{dataModelName}/{id}/calculated-insights/{ciName}Query a Profile data model object using filters and a search key.
ResourceDescription
/ssot/querySynchronously query data across data model, lake, unified, and linked objects.
/ssot/queryv2Query up to 8 MB of data across data model, lake, unified, and linked objects.
/ssot/queryv2/{nextBatchId}Get the next batch of data across data model, lake, unified, and linked objects.
ResourceDescription
/ssot/insight/metadataGet Insight metadata, including Calculated Insight objects, their dimensions and measures.
/ssot/insight/metadata/{ciName}Get metadata for a Calculated Insight object. Metadata includes dimensions and measures.
/ssot/insight/calculated-insights/{ciName}Query a Calculated Insight object.
/ssot/calculated-insightsGet calculated insights. Create a calculated insight.
/ssot/calculated-insights/{apiName}Get, update, or delete a calculated insight.
/ssot/calculated-insights/{apiName}/actions/runTrigger a run for a calculated insight.
ResourceDescription
/ssot/universalIdLookup/{entityName}/{dataSourceId}/{dataSourceObjectId}/{sourceRecordId}Look up objects by source ID.
ResourceDescription
/ssot/segmentsGet segments or create a segment.
/ssot/segments/{segmentApiName}Get, update, or delete a segment.
/ssot/segments/{segmentApiName}/membersGet segment members.
/ssot/segments/{segmentId}/actions/publishPublish a segment.
ResourceDescription
/ssot/identity-resolutionsGet identity resolution rulesets. Create an identity resolution ruleset.
/ssot/identity-resolutions/{identityResolution}Get, update, and delete an identity resolution ruleset.
/ssot/identity-resolutions/{identityResolution}/actions/run-nowRun an identity resolution ruleset job on demand.
ResourceDescription
/ssot/data-transformsGet a list of data transforms. Create a data transform.
/ssot/data-transforms/{dataTransformNameOrId}Get, update, and delete a data transform.
/ssot/data-transforms/{dataTransformNameOrId}/actions/cancelCancel a data transform.
/ssot/data-transforms/{dataTransformNameOrId}/actions/refresh-statusRefresh the status of a data transform.
/ssot/data-transforms/{dataTransformNameOrId}/actions/retryRetry running a data transform.
/ssot/data-transforms/{dataTransformNameOrId}/actions/runRun a data transform.
/ssot/data-transforms/{dataTransformNameOrId}/scheduleGet and update a data transform's schedule.