Analyze a sample
Runs an analysis pipeline against a named sample for a given asset. The pipeline profiles the data and, where the sample contains address, email, or phone columns, enriches it with verified/parsed output columns. By default, returns both the profile and the enriched rows; pass includeOutput=false to build a simpler linear pipeline that returns only the profile. Optionally compose the sample with an existing pipeline by providing a pipelineId; the sample will be run through that pipeline first before analysis, if its input schema matches the sample's schema.
Request
- Base URL: https://api.cloud.precisely.com
- URL: https://api.cloud.precisely.com/v2/quality/samples/analyze/{sampleName}
- Auth: HTTP bearer
Path parameters
Query parameters
Optional asset type path; defaults to "[File]" if not provided
Optional asset name path; defaults to "[sampleName]" if not provided
Optional id of an existing pipeline to run the sample through before analysis; the pipeline's declared input schema must match the sample's schema
Optional flag controlling whether the full output (enriched rows) is returned; defaults to true. When true, the pipeline is built with a broadcaster that returns both the profile and the enriched rows. When false, the pipeline is built as a simpler linear pipeline that only returns the profile.
Optional maximum number of columns the sample may have for analysis; defaults to 50 if not provided
Response
Analyze execution results
Example response
{
"score": {
"issues": [
{
"impact": 8.3
}
],
"overall": 62.4,
"scoreVersion": 1,
"totalWeight": 7.5
}
}Changes
No recorded changes to this operation across all 1 revision of this API.