curl -X GET "<base_url>/dpp/dwm/v2/stats/domains/{domain}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"domain": {
"value": "domain.com",
"lookback": "all",
"records": 23650,
"relatedSources": 368,
"employeeRecords": 23650,
"employeeDistinctEmails": 12754,
"consumerRecords": 0
}
}
}
Quick Scan
Stats by Domain
Returns aggregate exposure counts for an entire domain from the dark-web breach dataset, broken down into employee vs. consumer exposure.
GET
/
dpp
/
dwm
/
v2
/
stats
/
domains
/
{domain}
curl -X GET "<base_url>/dpp/dwm/v2/stats/domains/{domain}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"domain": {
"value": "domain.com",
"lookback": "all",
"records": 23650,
"relatedSources": 368,
"employeeRecords": 23650,
"employeeDistinctEmails": 12754,
"consumerRecords": 0
}
}
}
Returns aggregate exposure counts for an entire domain from the dark-web breach dataset, broken down into employee vs. consumer exposure.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dwm/v2/stats/domains/{domain} - Full URL:
<base_url>/dpp/dwm/v2/stats/domains/{domain} - 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
Domain to get exposure stats for.
Sample Request
cURL
curl -X GET "<base_url>/dpp/dwm/v2/stats/domains/{domain}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/dpp/dwm/v2/stats/domains/{domain}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"domain": {
"value": "domain.com",
"lookback": "all",
"records": 23650,
"relatedSources": 368,
"employeeRecords": 23650,
"employeeDistinctEmails": 12754,
"consumerRecords": 0
}
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"domain": {
"value": "domain.com",
"lookback": "all",
"records": 23650,
"relatedSources": 368,
"employeeRecords": 23650,
"employeeDistinctEmails": 12754,
"consumerRecords": 0
}
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | Aggregate domain exposure counts with employee/consumer breakdown. |
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 |
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 |