seo-connect

POST /v1/seo-connection/products/{product}/quote

What one run would cost, before it is asked for. Spends nothing.

All seo-connect endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; 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}/quote \
  -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

Validates the parameters exactly as runSeoProduct will and answers the units, the unit price, the total and the current balance — the price the screen shows before the person presses Run.

Parameters

NameTypeRequiredWhat it is
product (path)SeoProductCodeYesThe credit tool (listSeoProducts).

Request body

NameTypeRequiredWhat it is
paramsSeoProductParamsYesThe 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

NameTypeRequiredWhat it is
productSeoProductCodeYesgeo_grid local rank grid (zs-520) · reviews Google/Trustpilot/Tripadvisor reviews (zs-521) · shopping Google Shopping price and position (zs-522) · traffic competitor…
unitstringYes—
unitsintegerYes—
price_microsintegerYesOne unit
cost_microsintegerYesThe whole run.
paramsSeoProductParamsYesThe 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…
balance_microsintegerYes—
currencystring<USD>Yes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429