Domains Overview

post https://api.hudsonrock.com/json/v3/search-by-domain/overview

Get overview about domain-wide compromises and intelligence

Required Permissions

search-by-domain

Response Models (Schema)

domain

Response Limits

Rate limit: 50 requests per 10 seconds
Maximum response per page: 500 domains
Maximum response time: 90 seconds

Body Params

domains

array of strings

required

length between 1 and 500

List of domains to retrieve compromise overview statistics for. Accepts root domains (example.com) and will aggregate data across all subdomains. Between 1-500 domains can be specified per request.

domains*

min_employees_compromised

number

≥ 0

Minimum threshold for employee compromises. Returns only domains with at least this many compromised employee accounts. Useful for filtering out domains with negligible compromise counts.

max_employees_compromised

number

≥ 0

Maximum threshold for employee compromises. Returns only domains with no more than this many compromised employee accounts. Useful for focusing on organizations within specific size ranges.

min_users_compromised

number

≥ 0

Minimum threshold for user compromises. Returns only domains with at least this many compromised user accounts. Helps identify domains with significant consumer impact.

max_users_compromised

number

≥ 0

Maximum threshold for user compromises. Returns only domains with no more than this many compromised user accounts. Helps focus on domains with specific consumer impact ranges.

last_employee_compromised

date-time

ISO 8601 formatted timestamp (YYYY-MM-DDThh:mm:ssZ) to filter for domains with employee compromises after this date. Identifies domains with recent corporate breaches.

last_user_compromised

date-time

ISO 8601 formatted timestamp (YYYY-MM-DDThh:mm:ssZ) to filter for domains with user compromises after this date. Identifies domains with recent consumer-facing breaches.

last_employee_uploaded

date-time

ISO 8601 formatted timestamp (YYYY-MM-DDThh:mm:ssZ) to filter for domains with employee data uploaded after this date. Reflects when the data became available in our system.

last_user_uploaded

date-time

ISO 8601 formatted timestamp (YYYY-MM-DDThh:mm:ssZ) to filter for domains with user data uploaded after this date. Reflects when the data became available in our system.

sort_by

string

Defaults to last_employee_compromised

Field to sort overview results by. Time-based sorting helps identify recent breaches, while count-based sorting identifies the most severely affected domains.

sort_direction

string

Defaults to desc

Direction to sort overview results. 'desc' prioritizes recent breaches or highest compromise counts (recommended for threat monitoring), while 'asc' shows oldest breaches or lowest counts first.

cursor

string

Base64 encoded pagination cursor for retrieving the next set of overview results. Obtained from the 'nextCursor' field in the previous response. Essential for processing large domain lists.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.hudsonrock.com/json/v3/search-by-domain/overview \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
15
 
1
{
2
  "data": [
3
    {
4
      "_id": "string",
5
      "domain": "string",
6
      "compromised_employees": 25,
7
      "compromised_users": 120,
8
      "last_employee_compromised": "2025-04-03T14:28:32.331Z",
9
      "last_user_compromised": "2025-04-03T14:28:32.331Z",
10
      "last_employee_uploaded": "2025-04-03T14:28:32.331Z",
11
      "last_user_uploaded": "2025-04-03T14:28:32.331Z"
12
    }
13
  ],
14
  "nextCursor": "string"
15
}

Required Permissions

Response Models (Schema)

Response Limits

200Successful operation

400Validation error - the request or request body was invalid

401Unauthorized - the server could not authenticate the request

403Forbidden - the server authenticated the request but refuses to process it because of insufficient permissions

404Not found - the server could not find the requested resource

408Timeout - the server timed out while waiting for a response (90 seconds)

429Rate limit exceeded - the server has received too many requests in a short period of time

500Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request