seo-connect

POST /v1/seo-connection/google/search-analytics

Search Console clicks, impressions, CTR and position for the chosen property. Free.

All seo-connect endpoints

All developer docs →

Authentication

This endpoint does not take an API key. It takes its own credential, issued to the plugin or service that calls it, as a bearer token; see the description above.

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/google/search-analytics \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "startDate": <string>, "endDate": <string> }'

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

Google's searchAnalytics.query for the property this site chose, with Google's own fields only: dates (at most 16 months), up to four of date, hour, query, page, country, device, searchAppearance, filter groups, type, aggregationType, dataState, rowLimit (at most 25,000) and startRow. more is true when the page is full: ask again with the next startRow — the plugin pages through every row of a large site. Needs seo.read.

Request body

NameTypeRequiredWhat it is
startDatestringYes—
endDatestringYes—
dimensionsstring<date, hour, query, page, country, device, searchAppearance>[]No—
typestring<web, image, video, news, discover, googleNews>No—
rowLimitintegerNo—
startRowintegerNo—
dataStatestring<final, all, hourly_all>Nohourly_all with the hour dimension: recent data hour by hour.
aggregationTypestring<auto, byPage, byProperty>No—
dimensionFilterGroupsobject[]No—

Response

NameTypeRequiredWhat it is
propertystringYes—
queryobjectYesThe query as sent to Google.
rowsobject[]Yes—
morebooleanYesThe page was full; ask again with the next startRow.

Errors this endpoint can return

401 · 403 · 409 · 422 · 429 · 503