footprint
GET /v1/footprint/runs/{run_id}
One footprint check — its findings, its most linked site pairs and each site's state.
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/runs/{run_id} \
-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
A finding names the organisation's own sites it covers and a count. Its code is an opaque identifier the dashboard renders as a title, what it means and how to fix it; no measured value is ever returned. owner: platform marks something we fix for you, which never lowers the score.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
run_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
run | FootprintRunSummary | Yes | — |
findings | FootprintFinding[] | Yes | — |
pairs | object | Yes | — |
sites | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404