Aggregated breach summary for one or more domains

curl --request POST \ --url https://api.vantaprism.me/v1/domain/overview \ --header 'Content-Type: application/json' \ --header 'api-key: <api-key>' \ --data ' { "domains": [ "acme-corp.com", "globex.net" ] } '

{ "data": [ { "domain": "<string>", "compromised_employees": 123, "compromised_users": 123, "last_employee_uploaded": "2023-11-07T05:31:56Z", "last_user_uploaded": "2023-11-07T05:31:56Z", "first_employee_uploaded": "2023-11-07T05:31:56Z" } ], "meta": { "request_id": "req_01HZXK3Q7N8YV6F3M2P9JABCDE", "took_ms": 42.7, "tier": "pro", "masked_fields": [ "password", "ip" ], "freshness_at": "2023-11-07T05:31:56Z" } }

Authorizations

api-key

string

header

required

Static API key, format vp_<env>_<8-hex-prefix>.<40-hex-secret>. Preferred header for server-to-server integrations.

Body

application/json

domains

string[]

required

Domains to summarize, e.g. ["example.com"]. Up to 500 per request.

Required array length: 1 - 500 elements

start_date

string<date-time> | null

end_date

string<date-time> | null

Response

Domain summary stats

data

object[]

required

Show child attributes