visibility

GET /v1/domain-vetting

Domain vetting — credits held, the packs, the markets and recent reports.

All visibility endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/domain-vetting \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Everything the domain vetting screen needs in one read: how many report credits the organisation holds (unlimited for our own organisation), the one-off packs that sell them (domain_vetting_1, _10, _50 — priced on the add-ons catalogue), the search markets a report can be read for, how many days a re-vet of the same domain is free (reuse_days), the most recent reports and the most recent credit movements.

Response

NameTypeRequiredWhat it is
creditsintegerYes—
unlimitedbooleanYes—
packsobject[]Yes—
marketsinteger[]Yes—
reuse_daysintegerYes—
reportsDomainVetSummary[]Yes—
ledgerobject[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 422