seo-connect
POST /v1/seo-connection/products/{product}/runs
Run one credit tool now. Spends credits.
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/products/{product}/runs \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "params": <SeoProductParams> }'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
Needs the seo.spend scope. Every unit is debited up front (units x the unit price, under the site's own spend so its monthly limit counts it) and the run happens in the background: read it with getSeoProductRun. Every unit the data supplier did not answer is refunded — the site pays only for answers. A run that could not be started is refunded in full before the answer (503). Refused before anything is spent: unusable parameters (422, a refusal naming the field), not enough credit, the site's monthly limit or an account not in good standing (403).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
product (path) | SeoProductCode | Yes | The credit tool (listSeoProducts). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
params | SeoProductParams | Yes | The tool's parameters. geo_grid: phrase, lat, lng, size (3/5/7/9), spacing_km (0.2-10), business (Google id or name), domain, language — billed size x size… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
product | SeoProductCode | Yes | geo_grid local rank grid (zs-520) · reviews Google/Trustpilot/Tripadvisor reviews (zs-521) · shopping Google Shopping price and position (zs-522) · traffic competitor… |
status | string<queued, complete, partial, failed> | Yes | partial: some units answered and paid, the rest refunded. failed: refunded in full. |
params | SeoProductParams | Yes | The tool's parameters. geo_grid: phrase, lat, lng, size (3/5/7/9), spacing_km (0.2-10), business (Google id or name), domain, language — billed size x size… |
units | integer | Yes | — |
price_micros | integer | Yes | — |
charged_micros | integer | Yes | Debited up front. |
refunded_micros | integer | Yes | Returned for what was not answered. |
currency | string<USD> | Yes | — |
result | object | Yes | The tool's answer. Every item carries answered; an unanswered item is refunded and is never a measurement. geo_grid: points [{lat, lng, position|null, top, answered}],… |
alerts | object[] | Yes | Reviews: new_reviews and rating_drop since the previous reading (a first reading is a baseline). |
watch_id | object | Yes | — |
error | string | Yes | — |
created_at | string | Yes | — |
finished_at | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503