---
title: "Analyze a sample"
method: POST
path: "/v2/quality/samples/analyze/{sampleName}"
tags: ["Quality Samples"]
---

# Analyze a sample

`POST /v2/quality/samples/analyze/{sampleName}`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v2/quality/samples/analyze/{sampleName}`
- Auth: HTTP bearer

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.

## Path parameters

- `sampleName` string, required

## Query parameters

- `maxRows` integer
- `assetTypePath` string
- `assetNamePath` string
- `pipelineId` string
- `includeOutput` boolean
- `maxColumns` integer

## Response `200`

Analyze execution results

- AnalyzeSampleResponse: Profiling metrics and data quality assessment for an analyzed sample
  - `profile` object
  - `rows` object[]
  - `score` AnalyzeScore: Data quality assessment for an analyzed sample
    - `components` Component[]: The individual scores the overall score is composed of
      - `attainable` number, double
      - `detail` object
      - `dimensionBreakdown` Dimension[]
        - `applicable` boolean
        - `evidence` Evidence: The measured counts behind a dimension's score
          - `blankCount` integer
          - `blankCredit` number, double
          - `distinctCount` integer
          - `dominantCount` integer
          - `dominantSignature` string
          - `excluded` integer
          - `formatBucketCount` integer
          - `nullCount` integer
          - `scored` integer
          - `total` integer
        - `name` string
        - `score` number, double
        - `weight` number, double
      - `dimensions` object: Superseded by dimensionBreakdown, which is the corrected view. Retained for compatibility; may contain a value for a dimension that does not apply to this column's semantic type and therefore did not contribute to the score.
      - `examples` Example[]
        - `reason` string
        - `value` string
      - `expectationType` string
      - `kind` string
      - `name` string
      - `notApplicableDimensions` string[]: Superseded by dimensionBreakdown's applicable=false entries. Retained for compatibility.
      - `score` number, double
      - `weight` number, double
    - `issues` Issue[]: Quality shortfalls, ordered by impact descending
      - `component` string
      - `detail` union
        - DuplicateDetail: What duplicate detection did, and what it found
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
          - `rules` Rule[]
            - `fields` string[]
            - `name` string
          - `algorithmPerField` object
          - `blockingKey` BlockingKey: The blocking key duplicate detection generated
            - `algorithm` string
            - `sourceField` string
          - `threshold` integer
          - `missingDataMethod` string
          - `normalizedFields` NormalizedFields: Raw column to normalized column, keyed by semantic category
            - `address` object
            - `email` object
            - `phone` object
          - `duplicateGroups` integer
          - `affectedRows` integer
          - `surplusRows` integer
        - FieldGroupDetail: The columns a field-group issue covers
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
          - `fields` string[]
        - HygieneDetail: The measured facts behind a hygiene issue
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
          - `dimension` string
          - `expectation` string
          - `dominantSignature` string
          - `dominantCount` integer
          - `formatBucketCount` integer
          - `nullCount` integer
          - `blankCount` integer
          - `total` integer
      - `impact` number, double
      - `kind` string
      - `message` string
      - `remediable` boolean
      - `severity` string
    - `overall` number, double: Overall data quality score, 0-100, or null when it could not be determined
    - `remediations` Remediation[]: Deterministic, already-computed fixes -- distinct from issues, which only describe a shortfall
      - `id` string
      - `remediation` union
        - Detail
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
        - DuplicateDetail: What duplicate detection did, and what it found
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
          - `rules` Rule[]
            - `fields` string[]
            - `name` string
          - `algorithmPerField` object
          - `blockingKey` BlockingKey: The blocking key duplicate detection generated
            - `algorithm` string
            - `sourceField` string
          - `threshold` integer
          - `missingDataMethod` string
          - `normalizedFields` NormalizedFields: Raw column to normalized column, keyed by semantic category
            - `address` object
            - `email` object
            - `phone` object
          - `duplicateGroups` integer
          - `affectedRows` integer
          - `surplusRows` integer
        - FieldGroupDetail: The columns a field-group issue covers
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
          - `fields` string[]
        - HygieneDetail: The measured facts behind a hygiene issue
          - `implied_operators` string[]
          - `intent` string
          - `parameters` object
          - `dimension` string
          - `expectation` string
          - `dominantSignature` string
          - `dominantCount` integer
          - `formatBucketCount` integer
          - `nullCount` integer
          - `blankCount` integer
          - `total` integer
    - `scoreVersion` integer: Increments whenever the scoring arithmetic or response shape changes
    - `summary` Summary: Counts describing what was assessed
      - `columnCount` integer
      - `componentCount` integer
      - `issueCount` integer
      - `rowCount` integer
    - `totalWeight` number, double: The denominator of the overall score: the sum of all component weights. Null when no positive-weight component exists -- null exactly when overall is null, since one computation produces both.

## Other responses

- `400`: Invalid request parameters
- `500`: Internal server error

---

[API](https://skmtc.dev/precisely/apis/verify-api-portal.md) · [All operations](https://skmtc.dev/precisely/apis/verify-api-portal/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/verify-api-portal/revisions/380735465266?raw)