seo-connect
POST /v1/seo-connection/google/search-analytics
Search Console clicks, impressions, CTR and position for the chosen property. Free.
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
| Name | Type | Required | What it is |
|---|---|---|---|
startDate | string | Yes | — |
endDate | string | Yes | — |
dimensions | string<date, hour, query, page, country, device, searchAppearance>[] | No | — |
type | string<web, image, video, news, discover, googleNews> | No | — |
rowLimit | integer | No | — |
startRow | integer | No | — |
dataState | string<final, all, hourly_all> | No | hourly_all with the hour dimension: recent data hour by hour. |
aggregationType | string<auto, byPage, byProperty> | No | — |
dimensionFilterGroups | object[] | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
property | string | Yes | — |
query | object | Yes | The query as sent to Google. |
rows | object[] | Yes | — |
more | boolean | Yes | The page was full; ask again with the next startRow. |
Errors this endpoint can return
401 · 403 · 409 · 422 · 429 · 503