/partner-api/digital-riskQuery digital risks
Explore the query digital risks endpoint, including request parameters and response details.
Parameters
1 parameterqstringoptionalJSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.
q.where.typestring[]Filter by digital risk type.
q.where.brandIdnumber[]Filter by accessible brand IDs.
q.where.approveStatusnumber[]Approval status: 0 Pending, 1 Ticket created, 2 Whitelisted, 3 Ignored.
q.where.riskScorestring[]Risk levels: Low, Medium, High, Critical.
q.where.ticketStatusnumber[]Ticket status: 2 Open, 3 Pending, 4 Resolved, 5 Closed.
q.where.inspectionUrlstringFilter URLs using a multi-line fuzzy search.
q.where.brandCountrystring[]Filter by brand country code, for example AU or CN.
q.where.updatedAtobjectFilter by update time using gte and lte with ISO 8601 values.
q.where.idSearchstringSearch for one inspection UUID or ticket ID; numeric values are treated as ticket IDs.
q.viewModestringDisplay mode: table or card; defaults to table.
q.paginationobjectPagination: current page and pageSize; defaults are 1 and 20.
{
"where": {
"brandId": [
1
],
"approveStatus": [
0,
1
]
},
"pagination": {
"current": 1,
"pageSize": 10
}
}Encode this JSON with encodeURIComponent(JSON.stringify(q)) before sending it as the q parameter.
Responses
Successful responsesresponsepartnerDigitalRiskResponseoptionalPaginated digital risks and aggregate status counts.
datapartnerDigitalRiskItem[]optionalCommon fields returned in table and card views. Card view can include additional fields.
inspectionIdintegeroptionalexternalRefstringoptionalinspectionUrlstringnulloptionalphonestringnulloptionaltypestringoptionalupdatedAtstringoptionalbrandpartnerBrandNameoptionalbrandIdintegeroptionaloriginalNamestringoptionalBrand name in its original language.
englishNamestringoptionalriskScoreItemobjectoptionalRisk scoring details; may be null when no score exists.
scorenumberoptionalapproveStatusintegeroptional0 pending, 1 approved, 2 whitelisted, 3 ignored.
ticketStatusintegernulloptionalStatus of the associated ticket, if any.
customerTagsobject[]optionalCustomer-visible tags; the property may be absent when no tag references exist.
tagIdintegeroptionalnamestringoptionalassociationsSummarypartnerInspectionAssociationSummaryoptionalredirectCountintegeroptionaldownloadCountintegeroptionaltotalAssociationCountintegeroptionallastWorkOrderobjectoptionalMost recent visible associated work order, when present.
inspectionIdintegeroptionalworkOrderIdintegeroptionalstatusIdintegeroptionalpaginationpartnerDigitalRiskPaginationoptionalcurrentintegeroptionalpageSizeintegeroptionaltotalintegeroptionalotherDataobjectoptionaldigitalRiskTotalobjectoptionalCounts keyed by approval status.
ticketTotalobjectoptionalCounts keyed by ticket status.
