Get Data Graph Data with Lookup Keys
Queries data from a specific data graph using lookup keys. This endpoint allows you to retrieve records based on primary keys or lookup keys from any participating data model object (DMO).
A single request can return one or more data graph records. The result count depends on the lookup criteria and the number of unified records that match the provided lookup keys.
- HTTP Method: GET
- Availability: Data 360 v1.0, Salesforce v51.0
- Format: REST
- URI:
/api/v1/dataGraph/{dataGraphEntityName}?lookupKeys=[]&live=true/false
| Parameter | Type | Description |
|---|---|---|
| dataGraphEntityName | string | Required. The unique identifier of the data graph. Example: individual_eng_dg |
| Parameter | Type | Description |
|---|---|---|
| lookupKeys | string | Required. The lookup key in the format [DMO__dlm.field__c=value]. Example: [UnifiedLinkssotIndividualIr1__dlm.SourceRecordId__c=10000001] |
| live | boolean | Retrieves the latest data graph data if set to true. Retrieves the precalculated data graph data by default. |
Note
You can pass multiple lookup keys in a single request. When multiple lookup keys are provided, the query only returns records that satisfy all specified lookup criteria. When using contact-based lookup, only one contact key (either an email address or a phone number) is supported per request.
You can query your data using a combination of DMO values included in the data graph. For all DMOs, search is supported by primary key and key qualifier. If a lookup key matches more than one unified record, the results will include multiple data graphs. Review these key definitions and search capabilities for data graphs:
- Value DMO: The materialized table in the data graph that contains the full data payload.
- Primary DMO: The DMO the data graph is built from.
- Link table DMO: A junction table that links a unified DMO to another DMO.
- Participating DMO: A DMO used to store many-to-many relationships and perform reverse lookups from the DMO to the data graph.
- Cross table search: A query method using a combination of the primary key and key qualifier from a value DMO with one or more fields from the primary DMO. To use cross table search, pass multiple values to the search call
[primaryKeyFieldOfValueDMO=value, columnOfPrimaryDMO=value], [primaryKeyFieldOfValueDMO=value, column1OfPrimaryDMO=value, column2OfPrimaryDMO=value]. You can also use the primary key of a participating table in cross table search. - Real-time data graphs: Search is only supported by primary key and key qualifier. Non-primary key lookups and cross-table searches are not supported.
| Search Scenario | Primary Key | Primary Key and Key Qualifier | Non-primary Key Fields |
|---|---|---|---|
| Primary DMO | [primaryDMO__dlm.PrimaryKeyField=value] | [primaryDMO__dlm.PrimaryKeyField=value, primaryDMO__dlm.keyQualifierField=value] | \[primaryDMO__dlm.anyField=value, primaryDMO__dlm.anyField2=value] |
| Value DMO | [valueDMO__dlm.PrimaryKeyField=value] | [valueDMO__dlm.PrimaryKeyField=value, valueDMO__dlm.keyQualifierField=value] | Not supported |
| Link Table DMO | [DMO__dlm.primaryKeyField=value] | [DMO__dlm.primaryKeyField=value, DMO__dlm.keyQualifierField=value] | [linkTableDMO__dlm.anyField=value, linkTableDMO__dlm.anyField2=value] |
| Participating DMO | [Participating__dlm.primaryKey=value] | Not supported | Not supported |
To help build lookup keys, use the GET /dataGraph/metadata?entityName={DataGraphName} API to explore a data graph schema and retrieve the full DMO and field definitions.
| Parameter | Type | Description |
|---|---|---|
| dataspace | string | The dataspace that the query executes in. |
The response includes:
data: Array of objects containing the requested data. Multiple data graph records are returned if the lookup criteria match more than one unified record.done: Boolean indicating if all results have been returned
This example shows the data graph UnifiedIndividual_DG queried using the field SourceRecordIdc=10000001 on the related object UnifiedLinkssotIndividualIr1dlm. The request to query the data graph is made using these elements:
- DMO: UnifiedLinkssotIndividualIr1
- Primary Key name: SourceRecordId
- Primary Key value: 10000001
Request
Response
This example shows the data graph Individual_DG queried using the field SourceRecordIdc=10000001 on the related object LinkssotIndividualIr1dlm with the key qualifier kq_id__c=123. The request to query the data graph is made using these elements:
- DMO: LinkssotIndividualIr1
- Primary Key name: SourceRecordId
- Primary Key value: 10000001
- Key Qualifier ID: 123
Request
Response