seo-data
POST /v1/seo-connection/data-sources/{source}/run
Check this source for the site 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/data-sources/{source}/run \
-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
Starts one check (a Temporal workflow) and answers 202 at once; read the result with getSeoDataSources. Spends the site owner's own units at the vendor — or, for Zinn® Authority, Zinn® credit (paid up front, refunded for domains with no answer; needs seo.spend). Needs seo.run.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
source (path) | string<ahrefs_free, ahrefs, majestic, moz, semrush, se_ranking, openpagerank, zinn_authority> | Yes | The SEO data source. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
vendor | string | Yes | — |
show | string[] | Yes | — |
track | string[] | Yes | — |
alerts | SeoDataAlertRule[] | Yes | — |
cadence_days | integer | Yes | — |
state | string<active, paused_quota, paused_credit, paused_key, paused_user> | Yes | — |
resume_at | object | Yes | When a quota pause lifts. |
next_due_at | object | Yes | — |
last_succeeded_at | object | Yes | — |
last_units | integer | Yes | Vendor units (Zinn® Authority — credit micros) the last check spent. |
last_error | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503