Skip to main content
GET
/
v1
/
promotions
/
{promotionId}
/
versions
/
{versionId}
/
evaluation
Get evaluation result for a version
curl --request GET \
  --url https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/evaluation \
  --header 'Authorization: Bearer <token>' \
  --header 'X-External-User-ID: <x-external-user-id>'
{
  "evaluationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "reviewRequired": true,
    "overallAssessment": "<string>",
    "issues": [
      {
        "recommendation": "<string>",
        "rationale": "<string>",
        "severity": "LOW",
        "citedRules": [
          {
            "id": "<string>",
            "name": "<string>",
            "product": "<string>",
            "channel": "<string>"
          }
        ],
        "location": {
          "type": "text",
          "content": "<string>",
          "pageNumber": 123,
          "timestamp": "<string>"
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Unkey API key passed as Bearer token

Headers

X-External-User-ID
string
required

External user identifier from the calling system

X-External-User-Email
string<email>

External user email from the calling system

Path Parameters

promotionId
string<uuid>
required

Promotion ID

versionId
string<uuid>
required

Version ID

Response

Evaluation result

evaluationId
string<uuid>
required
status
string
required
correlationId
string<uuid>
required

Correlation ID for request tracing. Include in support requests.

result
object