seo-connect
POST /v1/seo-connection/reports/run
Make this site's report now.
Authentication
Send an API key as a bearer token. The endpoint checks sites.create; 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 POST https://api.zinndigital.com/v1/seo-connection/reports/run \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
Zinn® SEO stage P12. Same as makeClientReport for this site's client: counted at once, built in the background, poll getSiteReport. Needs seo.run.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
send_email | boolean | No | — |
period_start | string | No | — |
period_end | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
client_id | string | Yes | — |
client_name | string | Yes | — |
period_start | string | Yes | — |
period_end | string | Yes | — |
locale | string | Yes | — |
state | string<building, ready, failed> | Yes | — |
source | string<manual, schedule> | Yes | — |
sections | ClientReportSectionKey[] | Yes | — |
headline | ClientReportHeadline[] | Yes | — |
changes | integer | Yes | How many figures moved since the previous report. |
narrative | object | Yes | zs-541: the report's opening in plain words, in the client's language; null when there is none. |
narrative_note | object | Yes | Why there is or is not an opening (for the agency, never printed): no connected site covers the report, no Zinn® credit, the site may not spend credit, or the writer failed. |
failure | ClientReportFailure | null | Yes | Why a failed report failed, or why a ready one could not be e-mailed. |
share_url | object | Yes | null once revoked or expired. |
share_expires_at | object | Yes | — |
revoked | boolean | Yes | — |
views | integer | Yes | — |
emailed_at | object | Yes | — |
emailed_to | string[] | Yes | — |
created_at | string | Yes | — |
finished_at | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503