curl -X GET "<base_url>/dpp/dwm/v2/stats/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"email": {
"lastDiscoveredDaysAgo": 1026,
"records": 2,
"relatedSources": 2,
"value": "string"
},
"domain": {
"lastDiscoveredDaysAgo": 9,
"records": 23650,
"relatedSources": 368,
"value": "domain.com"
}
}
}
Quick Scan
Stats by Email
Returns aggregate exposure counts for an email address from the dark-web breach dataset (total records, distinct breach sources, and how recently it was last seen), plus the same roll-up for its domain.
GET
/
dpp
/
dwm
/
v2
/
stats
/
emails
/
{email}
curl -X GET "<base_url>/dpp/dwm/v2/stats/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"email": {
"lastDiscoveredDaysAgo": 1026,
"records": 2,
"relatedSources": 2,
"value": "string"
},
"domain": {
"lastDiscoveredDaysAgo": 9,
"records": 23650,
"relatedSources": 368,
"value": "domain.com"
}
}
}
Returns aggregate exposure counts for an email address from the dark-web breach dataset (total records, distinct breach sources, and how recently it was last seen), plus the same roll-up for its domain. Set skipDomain=true to skip the domain roll-up.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dwm/v2/stats/emails/{email} - Full URL:
<base_url>/dpp/dwm/v2/stats/emails/{email} - Request Method: GET
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Path Parameters
string
required
Email address to get exposure stats for.
Query Parameters
string
Registered user uuid — makes this a PAID request; the user must belong to your partner. Omit for a free request.
string
Skip the rolled-up domain stats for a faster response. One of
true, false.Sample Request
cURL
curl -X GET "<base_url>/dpp/dwm/v2/stats/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/dpp/dwm/v2/stats/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"email": {
"lastDiscoveredDaysAgo": 1026,
"records": 2,
"relatedSources": 2,
"value": "string"
},
"domain": {
"lastDiscoveredDaysAgo": 9,
"records": 23650,
"relatedSources": 368,
"value": "domain.com"
}
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"email": {
"lastDiscoveredDaysAgo": 1026,
"records": 2,
"relatedSources": 2,
"value": "string"
},
"domain": {
"lastDiscoveredDaysAgo": 9,
"records": 23650,
"relatedSources": 368,
"value": "domain.com"
}
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | Aggregate exposure counts for the email and (unless skipped) its domain. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
10006 | Bad request / A {kind} value is required / Provide at least one search asset |
10200 | User with uuid {uuid} not found |
10204 | User with uuid {uuid} is disabled |
10205 | User with uuid {uuid} has expired |
11100 | Cluster1 is not configured |
11102 | Exposure lookup not permitted ({status}) |
11103 | Exposure lookup returned {status} |
11104 | Cluster1 is unavailable |
11199 | DWM response post-processing failed |