Mappings
Get result manifest
GET
/
results
/
{id}
/
manifest
Returns the manifest for a result, providing the most important high-level information about the data in a structured format.
Explanation
The response contains an array of property manifests, with each item representing a target property. The manifest provides detailed information about how the data is mapped and processed:
-
Property Manifest Structure:
- Each item in the
items
array corresponds to a single target property. - The
property
object contains the name and schema of the target property.
- Each item in the
-
Dependencies:
- The
dependencies
object shows what data is used to map to the target property:source_properties
: An array of source keys used for mapping.default_values
: Any default values applied if the source data is not present.
- If there’s conditional mapping, all possible source keys across all conditionals will be listed.
- The
-
Lookup Mappings:
- The
lookup_mappings
array shows before and after lookup values with a confidence level. - Lookups are present for properties that have:
- Enums (which trigger classification)
- Cleaning instructions
- Each lookup mapping includes:
source_value
: The original value before lookupmapped_value
: The resulting value after lookupconfidence
: The confidence level of the mapping (e.g., “Confident”)
- The
Example response
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
id
string
requiredQuery Parameters
include
string[] | null
Metadata to include in the manifest
page
integer
default: 1Page number
size
integer
default: 50Page size
Response
200 - application/json
items
object[]
requiredtotal
integer | null
requiredpage
integer | null
requiredsize
integer | null
requiredpages
integer | null