Connect REST API Developer Guide
jNewer Version Available
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.
For limit information, see API Limits for Profile, Query, and Calculated Insights.
Available resources are:
Metadata
| Resource | Description |
|---|---|
| /ssot/metadata | Get all metadata, including Calculated Insights, Engagement, Profile, and other objects, as well as their relationships to other objects. |
Profile Library
| Resource | Description |
|---|---|
| /ssot/profile/metadata | Get 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/calculatedInsightName | Query a Profile data model object using filters and a search key. |
Query Library
| Resource | Description |
|---|---|
| /ssot/query | Synchronously query data across data model, lake, unified, and linked objects. |
| /ssot/queryv2 | Query 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. |
Calculated Insights Library
| Resource | Description |
|---|---|
| /ssot/insight/metadata | Get Insight metadata, including Calculated Insight objects, their dimensions and measures. |
| /ssot/insight/metadata/calculatedInsightName | Get metadata for a Calculated Insight object. Metadata includes dimensions and measures. |
| /ssot/insight/calculated-insights/calculated-insight-name | Query a Calculated Insight object. |
| /ssot/calculated-insights | Get calculated insights. Create a calculated insight. |
| /ssot/calculated-insights/apiName | Get, update, or delete a calculated insight. |
| /ssot/calculated-insights/apiName/actions/run | Trigger a run for a calculated insight. |
Universal ID Lookup
| Resource | Description |
|---|---|
| /ssot/universalIdLookup/entityName/dataSourceId/dataSourceObjectId/sourceRecordId | Look up objects by source ID. |
Segments
| Resource | Description |
|---|---|
| /ssot/segments | Get segments or create a segment. |
| /ssot/segments/segmentApiName | Get, update, or delete a segment. |
| /ssot/segments/segmentId/actions/publish | Publish a segment. |
Identity Resolution Rulesets
| Resource | Description |
|---|---|
| /ssot/identity-resolutions | Get identity resolution rulesets. Create an identity resolution ruleset. |
| /ssot/identity-resolutions/identityResolutionRuleset | Get, update, and delete an identity resolution ruleset. |
| /ssot/identity-resolutions/identityResolutionRuleset/actions/run | Run an identity resolution ruleset job on demand. |