Skip to content
Qualia Docs

Start a durable bad-data analysis over immutable dataset versions

POST
/v1/datasets/curation/analyses
 
curl --request POST \
  --url https://example.com/v1/datasets/curation/analyses \
  --header 'Content-Type: application/json' \
  --data '{ "idempotency_key": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "base_version_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Enqueue/recover a durable idempotent analysis; source data is immutable.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

Header Parameters

Section titled “Header Parameters ”
x-api-key
string | null

Request Body required

Section titled “Request Body required ”
Media type application/json
StartDatasetCurationAnalysisBody
object
idempotency_key
required
string format: uuid
base_version_ids
required
Array<string>
>= 1 items <= 32 items
Example generated
{
  "idempotency_key": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "base_version_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Successful Response

Media type application/json
DatasetCurationAnalysisModel
object
analysis_id
required
string format: uuid
base_version_ids
required
Array<string>
>= 1 items <= 32 items
engine_revision
required
string
>= 1 characters <= 128 characters
status
required
string
Allowed values: queued running ready failed
phase
required
string
Allowed values: pass1 pass2 ready failed
base_member_count
required
integer
> 0 <= 18446744073709552000
processed_member_count
required
integer
<= 18446744073709552000
recommended_exclusion_count
required
integer
<= 18446744073709552000
threshold_digest
string | null
/^[0-9a-f]{64}$/
evidence_digest
string | null
/^[0-9a-f]{64}$/
recommendation_digest
string | null
/^[0-9a-f]{64}$/
selection_digest
string | null
/^[0-9a-f]{64}$/
audit_repo_id
string | null format: uuid
expected
object
generation
required
integer
> 0
git_hash_algorithm
required
string
Allowed values: sha1 sha256
git_oid
required
string
/^[0-9a-f]+$/
commit_id
required
string format: uuid
pack_digest
required
string
/^[0-9a-f]{64}$/
failure_code
string | null
>= 1 characters <= 128 characters
failure_detail
string | null
>= 1 characters <= 65536 characters
Example 
{
  "status": "queued",
  "phase": "pass1",
  "expected": {
    "git_hash_algorithm": "sha1"
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}