Aggregate keyword hit-counts across harvested URLs

curl --request POST \ --url https://api.vantaprism.me/v1/search/keyword \ --header 'Content-Type: application/json' \ --header 'api-key: <api-key>' \ --data ' { "keywords": [ "admin-panel", "jenkins" ], "limit": 25 } '

{ "data": [ { "keyword": "<string>", "domain": "<string>", "occurrences": 123, "unique_victims": 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.

Body

application/json

keywords

string[]

required

Up to 10 keywords to match against harvested URLs and page titles.

Required array length: 1 - 10 elements

Example:

["admin-panel"]

start_date

string<date-time> | null

end_date

string<date-time> | null

limit

integer

default:25

Required range: 1 <= x <= 25

Response

Keyword hit-counts

data

object[]

required

Show child attributes