NOTHINGPHISHY
GET/partner-api/inspections

Query inspections

Explore the query inspections 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 inspection type.

q.where.brandIdnumber[]

Filter by accessible brand IDs.

q.where.fromDatestring

Start of the time range, in ISO 8601 format.

q.where.toDatestring

End of the time range, in ISO 8601 format.

q.where.inspectionUrlobject

Match the inspection URL, including fuzzy matching.

q.where.associationStatusstring

Filter by associated or unassociated.

q.paginationobject

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

EXAMPLE BEFORE ENCODING
{
  "where": {
    "brandId": [
      1
    ],
    "associationStatus": "associated"
  },
  "pagination": {
    "current": 1,
    "pageSize": 10
  }
}

Encode this JSON with encodeURIComponent(JSON.stringify(q)) before sending it as the q parameter.

Responses

Successful responses
200OK
responsepartnerInspectionResponseoptional
datapartnerInspectionAudit[]optional
inspectionIdintegeroptional
externalRefstringoptional
typestringoptional
brandIdintegeroptional
inspectionUrlstringnulloptional
inspectionUrlMD5stringnulloptional
lastHistoryIdintegernulloptional
createdAtstringoptional
updatedAtstringoptional
remarksstringnulloptional
statusstringoptional
tagstag[]optional
tagIdintegeroptional
namestringoptional
platformstringoptional
platformNamestringnulloptional
platformIdstringnulloptional
platformAccountNamestringnulloptional
mobileAppsmobileAppAttachment[]optional
uidstringoptional
namestringoptional
urlstringoptional
sizeintegeroptional
locationstringoptional
externalRefstringoptional
fileMd5stringoptional
fileSha1stringoptional
fileSha256stringoptional
certOwnerstringoptional
certIssuerstringoptional
certMd5stringoptional
certSha1stringoptional
certSha256stringoptional
whitelistedAppbooleanoptional
manualScreenshotbooleanoptional
lastInspectionTimestringnulloptional
riskScoreintegernulloptional
associationsSummarypartnerInspectionAssociationSummaryoptional
redirectCountintegeroptional
downloadCountintegeroptional
totalAssociationCountintegeroptional
paginationpaginationoptional
totalintegeroptional

Total number of records (unpaginated) based on the query criteria.

pageSizeintegeroptional

Page size. Default page size is applied if not specified. Maximum 100.

currentintegeroptional

Current page starting from 1.

NOTHINGPHISHY API REFERENCE