Weekly breach volume trend for a domain

curl --request GET \
  --url https://api.vantaprism.me/v1/domain/{domain}/timeline \
  --header 'api-key: <api-key>'

{
  "data": [
    {
      "week": "2023-12-25",
      "employees": 123,
      "users": 123
    }
  ],
  "meta": {
    "request_id": "req_01HZXK3Q7N8YV6F3M2P9JABCDE",
    "took_ms": 42.7,
    "tier": "pro",
    "masked_fields": [
      "password",
      "ip"
    ],
    "freshness_at": "2023-11-07T05:31:56Z"
  }
}

GET

domain

{domain}

timeline

Weekly breach volume trend for a domain

curl --request GET \
  --url https://api.vantaprism.me/v1/domain/{domain}/timeline \
  --header 'api-key: <api-key>'

{
  "data": [
    {
      "week": "2023-12-25",
      "employees": 123,
      "users": 123
    }
  ],
  "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.

Path Parameters

domain

string

required

Domain to analyze, e.g. example.com.

Query Parameters

weeks

integer

default:24

Look-back window in weeks.

Required range: 4 <= x <= 208

Response

Weekly timeline

data

object[]

required

Show child attributes