Get Search Console performance
Clicks, impressions, CTR and average position totals with the daily clicks and impressions timeline. Live Google read for the inclusive start..end range (at most the configured maximum, 486 days by default; end at most today in UTC). May refresh the site’s Google access token. Charged to the analytics rate budget.
A valid request URL is required to generate request examples{
"data": {
"period": {
"start": "2023-12-25",
"end": "2023-12-25"
},
"totals": {
"clicks": 123,
"impressions": 123,
"ctr": 123,
"position": 123
},
"timeline": [
{
"date": "2023-12-25",
"clicks": 123,
"impressions": 123
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pagination": {
"limit": 50,
"has_more": true,
"next_cursor": "<string>"
},
"catalog": {
"available_count": 1,
"enriched_count": 1,
"truncated": true
}
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}Authorizations
Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.
- Authorization URL
- /oauth/authorize
- Token URL
- /oauth/token
- Refresh URL
- /oauth/token
Path Parameters
Profile UUID; must be in the grant allowlist and currently accessible to the actor.
Query Parameters
Inclusive start date (YYYY-MM-DD).
Inclusive end date (YYYY-MM-DD), not before start, at most today (UTC); the range is at most the configured maximum (486 days by default).
A valid request URL is required to generate request examples{
"data": {
"period": {
"start": "2023-12-25",
"end": "2023-12-25"
},
"totals": {
"clicks": 123,
"impressions": 123,
"ctr": 123,
"position": 123
},
"timeline": [
{
"date": "2023-12-25",
"clicks": 123,
"impressions": 123
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pagination": {
"limit": 50,
"has_more": true,
"next_cursor": "<string>"
},
"catalog": {
"available_count": 1,
"enriched_count": 1,
"truncated": true
}
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}