Depending on the endpoint you call and the included parameters, the Retrieval API returns the following data:
- RampIDs—Identifiers that allow you to identify and consolidate records across multiple systems.
- Match Metadata—When the Match endpoint is used, information about the components that were used to obtain the match, the matching level of the match cascade, and whether any components were invalid.
RampIDs are identifiers that are tied to a record in the LiveRamp Identity Graph. They allow you to identify and consolidate records across multiple systems.
You can make a call to return only the best match for the input data, or you can choose to receive multiple identifiers (for calls to the Match endpoint).
For more information about RampID types, versions, format, and structure, see "RampIDs".
Match metadata is returned when you send data to the Match endpoint. Match metadata includes information related to the matching process. This information can help optimize data collection through improved understanding of which data types or PII types yield the best results.
Match metadata includes the following:
- The match level in the match cascade (the “matchConfidence” parameter).
- The input components that contributed to the match (the “matchComponents” parameter).
- Whether there are additional maintained RampIDs associated with the components of the input data that were used for the match (the “distinctMatch” parameter).
- Whether part or all of the major name components were used to obtain the match (the “nameMatchIntegrity” parameter).
- Whether any components of the input data are invalid, such as an email address that is not in a valid format (the “invalidParameters” parameter).
Name + Address + ZIP
Name + Email
Name + Phone
Partial Name + Email
Partial Name + Phone
Name + ZIP
See "Metadata Bundles" for more information.
Updated 3 months ago