---
title: "EvaluateDataPolicy"
method: POST
path: "/v1alpha/data-policies/{dataPolicyId}/{platformId}/evaluate"
tags: ["DataPoliciesService"]
---

# EvaluateDataPolicy

`POST /v1alpha/data-policies/{dataPolicyId}/{platformId}/evaluate`

Evaluates a previously upserted DataPolicy against a provided data sample. Platform-specific data types, transforms
 and nested fields are not supported.

## Path parameters

- `dataPolicyId` string, required
- `platformId` string, required

## Request body

- EvaluateDataPolicyRequest
  - `dataPolicyId` string
  - `fullEvaluation` EvaluateDataPolicyRequestFullEvaluation
    - `sampleCsv` string — CSV-formatted sample data to evaluate the policy against. The first row must be a header row.
  - `platformId` string

## Response `200`

OK

- EvaluateDataPolicyResponse
  - `fullEvaluationResult` EvaluateDataPolicyResponseFullEvaluationResult
    - `ruleSetResults` FullEvaluationResultRuleSetResult[] — The results of the evaluation, grouped by rule set.
      - `principalEvaluationResults` RuleSetResultPrincipalEvaluationResult[] — A result is returned for each principal specified in the rule set, as well as the case where there is no matching principal.
        - `csv` string — The result of the evaluation in CSV format, including headers.
        - `principal` DataPolicyPrincipal
          - `group` string
      - `target` DataPolicyTarget
        - `fullname` string — The full and unique name to be used in the target platform. E.g. the view name.
        - `type` 'TARGET_TYPE_UNSPECIFIED' | 'SQL_VIEW', enum

## Other responses

- `default` — Default error response

## Changes

- **2023-11-29** `8ae5870420f4` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/getstrm/apis/pace-api/changes/v1alpha/data-policies/:dataPolicyId/:platformId/evaluate/post.md)

---

[API](https://skmtc.dev/getstrm/apis/pace-api.md) · [All operations](https://skmtc.dev/getstrm/apis/pace-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getstrm/pace-api/revisions/df7ee7e702db/schema)
