NOTHINGPHISHY
GET/partner-api/alerts

Returning all digital asset alerts

Explore the returning all digital asset alerts 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.severityLevelobject

Filter alert severity, for example {"gte":1}; levels are 1 low, 2 medium, 3 high.

q.where.createdAtstring

Relative start time, for example "24 hours" or "3 days".

q.paginationobject

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

EXAMPLE BEFORE ENCODING
{
  "where": {
    "severityLevel": {
      "gte": 1
    },
    "createdAt": "24 hours"
  },
  "pagination": {
    "current": 1,
    "pageSize": 10
  }
}

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

Responses

Successful responses
200OK
responsepartnerAlertResponseoptional
datapartnerAlertItem[]optional
whitelistNamestringoptional
severityLevelintegeroptional

1 low, 2 medium, 3 high.

categorystringoptional
lastAnalysisStatsobjectoptional
verdictsobjectoptional
createdAtstringoptional
whitelistBrandRelationsobject[]optional
brandIdintegeroptional
brandpartnerBrandNameoptional
brandspartnerBrandName[]optional
brandIdintegeroptional
originalNamestringoptional

Brand name in its original language.

englishNamestringoptional
paginationpartnerAlertPaginationoptional
currentintegeroptional
pageSizeintegeroptional
totalintegeroptional
otherDataobjectoptional

Severity counts for False Positive and Domain Expiration; absent when no brands are accessible.

falsePositivepartnerAlertSeverityCountsoptional
domainExpirationpartnerAlertSeverityCountsoptional
NOTHINGPHISHY API REFERENCE