footprint
GET /v1/footprint
The footprint checker for this organisation — allowances, sites and latest verdict.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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/footprint \
-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
Whether the PBN footprint checker is on for this organisation, how often it runs on its own (cadence_days), how many sites hosted elsewhere it may include and how many on-demand checks remain this month, the external sites added, the latest finished check and any check still running, and the score over time. Every site hosted with us is always included and never counts against external_allowance. -1 in an allowance means unlimited, and the matching *_remaining field is then null.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | — |
cadence_days | integer | Yes | How often every site is checked automatically; 0 when off. |
external_allowance | integer | Yes | Sites hosted elsewhere allowed; -1 is unlimited. |
external_used | integer | Yes | — |
external_remaining | integer | No | — |
checks_allowance | integer | Yes | On-demand checks a month; -1 is unlimited. |
checks_used | integer | Yes | — |
checks_remaining | integer | No | — |
hosted_count | integer | Yes | Sites hosted with us — always included. |
next_run_at | string | No | — |
sites | FootprintSite[] | Yes | — |
latest | FootprintRunSummary | No | — |
running | FootprintRunSummary | No | — |
trend | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422