NOTHINGPHISHY
GET/partner-api/digital-risk

Query digital risks

Explore the query digital risks endpoint, including request parameters and response details.

Parameters

1 parameter
qstringoptional

JSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.

DECODED QUERY FIELDS
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.inspectionUrlstring

Filter URLs using a multi-line fuzzy search.

q.where.brandCountrystring[]

Filter by brand country code, for example AU or CN.

q.where.updatedAtobject

Filter by update time using gte and lte with ISO 8601 values.

q.where.idSearchstring

Search for one inspection UUID or ticket ID; numeric values are treated as ticket IDs.

q.viewModestring

Display mode: table or card; defaults to table.

q.paginationobject

Pagination: current page and pageSize; defaults are 1 and 20.

EXAMPLE BEFORE ENCODING
{
  "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 responses
200OK
responsepartnerDigitalRiskResponseoptional

Paginated digital risks and aggregate status counts.

datapartnerDigitalRiskItem[]optional

Common fields returned in table and card views. Card view can include additional fields.

inspectionIdintegeroptional
externalRefstringoptional
inspectionUrlstringnulloptional
phonestringnulloptional
typestringoptional
updatedAtstringoptional
brandpartnerBrandNameoptional
brandIdintegeroptional
originalNamestringoptional

Brand name in its original language.

englishNamestringoptional
riskScoreItemobjectoptional

Risk scoring details; may be null when no score exists.

scorenumberoptional
approveStatusintegeroptional

0 pending, 1 approved, 2 whitelisted, 3 ignored.

ticketStatusintegernulloptional

Status of the associated ticket, if any.

customerTagsobject[]optional

Customer-visible tags; the property may be absent when no tag references exist.

tagIdintegeroptional
namestringoptional
associationsSummarypartnerInspectionAssociationSummaryoptional
redirectCountintegeroptional
downloadCountintegeroptional
totalAssociationCountintegeroptional
lastWorkOrderobjectoptional

Most recent visible associated work order, when present.

inspectionIdintegeroptional
workOrderIdintegeroptional
statusIdintegeroptional
paginationpartnerDigitalRiskPaginationoptional
currentintegeroptional
pageSizeintegeroptional
totalintegeroptional
otherDataobjectoptional
digitalRiskTotalobjectoptional

Counts keyed by approval status.

ticketTotalobjectoptional

Counts keyed by ticket status.

NOTHINGPHISHY API REFERENCE