Skip to main content
GET
Poll an analysis

Authorizations

x-preuve-key
string
header
required

API key id. Requests are additionally signed with x-preuve-timestamp, x-preuve-nonce, and x-preuve-signature (HMAC-SHA256) - see the Authentication guide.

Path Parameters

id
string<uuid>
required

Run id (returned by create) or report id.

Response

Current run state.

id
string<uuid>
reportId
string<uuid>
clientRunId
string
scanType
enum<string>

Your request type. Reliable from creation, even while PROCESSING.

Available options:
free,
deep
reportType
enum<string>
Available options:
quick,
deep_dive
analysisTier
enum<string>

Derived from the report. Deep runs read "basic" until deep sections land.

Available options:
basic,
advanced
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
readyForExport
boolean
enrichment
object
modules
object | null

Per-module statuses. Deep reports only; null on free runs.

reportUrl
string<uri>
shareUrl
string<uri> | null