ReferenceSeoSeoOverview
Get the SEO Overview page envelope
Loading the API reference…
A practice API key or an OAuth access token, both presented as Authorization: Bearer <token>. The token itself names the practice, so no organization header is needed.
In: header
application/json
application/json
curl -X GET "https://example.com/seo/overview"{ "entitlement": { "enabled": true, "readOnly": true, "upgradeRequired": true }, "permissions": { "read": true, "request": true, "recover": true, "respond": true, "manage": true, "approve": true, "publish": true, "aiDraft": true }, "data": { "settings": { "primaryDomain": "string", "gridSize": 5, "gridSpacingMeters": 100, "scanDayOfWeek": 0, "trackedKeywordLimit": 0, "gridKeywordLimit": 0, "monthlyCostCeilingUsdMicros": 0, "autoApproveGbpPosts": true, "autoApproveGbpFixes": true, "contentReviewerPractitionerId": "fb1396ff-775d-4672-8b0f-4c0d879df51d", "aiVisibilityEnabled": true, "trackingEnabledAt": "2019-08-24T14:15:22Z", "allowances": { "trackedKeywordLimit": 0, "gridKeywordLimit": 0, "monthlyCostCeilingUsdMicros": 0 }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "reviewers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "registrationRef": "string", "role": "dentist" } ], "attribution": { "series": [ { "periodStart": "2019-08-24", "trackedLeads": 0, "confirmedValueCents": 0, "organicSearchLeads": 0, "gbpLeads": 0, "aiLeads": 0 } ], "trackedLeads": 0, "confirmedValueCents": 0, "priorTrackedLeads": 0, "priorConfirmedValueCents": 0 }, "actions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54", "kind": "gbp_fix_field", "surface": "overview", "status": "open", "priority": 0, "title": "string", "summary": "string", "payload": { "kind": "gbp_fix_field", "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54", "field": "string", "updateMask": [ "string" ], "intent": { "kind": "set", "value": "string" } }, "draft": "string", "autoApproved": true, "approvedById": "string", "idempotencyVersion": 0, "expiresAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "errorCode": "claim_budget_exhausted", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "events": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54", "kind": "rank_improved", "title": "string", "summary": "string", "payload": "string", "occurredAt": "2019-08-24T14:15:22Z" } ], "budget": { "month": "string", "spentMicros": 0, "ceilingMicros": 0, "ratio": 0, "capped": true, "state": "ok" }, "searchConsole": { "connected": true, "weeks": [ { "weekStart": "2019-08-24", "clicks": 0, "impressions": 0, "days": 1 } ] }, "rankings": { "current": { "keywords": 1, "averagePosition": 1, "positions1To3": 0, "positions4To10": 0, "positions11To20": 0, "notInTop20": 0 }, "weeks": [ { "keywords": 1, "averagePosition": 1, "positions1To3": 0, "positions4To10": 0, "positions11To20": 0, "notInTop20": 0, "weekStart": "2019-08-24" } ] }, "topTenCoverage": { "weekStart": "2019-08-24", "practice": 0, "competitors": [ { "competitorId": "be7195ac-4482-4082-b43f-9e70c41e9fc4", "name": "string", "share": 0 } ] }, "gridMap": { "scan": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "keywordId": "08721556-ef4c-40f0-9305-68bfacb3aef7", "status": "queued", "trigger": "scheduled", "scheduledFor": "2019-08-24T14:15:22Z", "centerLatitude": -90, "centerLongitude": -180, "zoom": 1, "gridSize": 5, "pointsTotal": 25, "pointsCompleted": 0, "averagePosition": 1, "bestPosition": 1, "worstPosition": 1, "top3Share": 0, "top10Share": 0, "targetRating": 0, "targetReviewCount": 0, "costMicros": 0, "lastError": "string", "startedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "points": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "row": 0, "column": 0, "latitude": -90, "longitude": -180, "position": 1, "topResults": [ { "rank": null, "name": "string", "placeId": "string", "rating": 0, "reviewCount": 0 } ] } ], "keywordPhrase": "string" }, "gbpPerformance": { "range": { "from": "string", "to": "string" }, "channel": { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "platform": "facebook", "displayName": "string", "handle": "string", "avatarUrl": "string", "sync": { "state": "ok", "lastSyncedAt": "2019-08-24T14:15:22Z" }, "followers": 0, "followersPrevious": 0, "views": 0, "engagements": 0, "posts": 0 }, "kpis": [ { "key": "string", "label": "string", "format": "number", "currency": "string", "value": 0, "previousValue": 0, "detail": { "label": "string", "value": 0 }, "better": "up", "trend": { "grain": "day", "points": [ { "bucket": "string", "value": 0, "previous": 0 } ] }, "rating": { "good": 0, "fair": 0 }, "note": "string" } ], "series": [ { "key": "string", "label": "string", "kind": "timeseries", "format": "number", "currency": "string", "grain": "day", "stacks": [ { "key": "string", "label": "string", "hue": "green" } ], "points": [ { "bucket": "string", "hue": "green", "values": { "property1": 0, "property2": 0 } } ], "sparse": true, "layout": "stacked", "target": 0, "summary": { "label": "string", "value": 0, "format": "number", "rating": { "good": 0, "fair": 0 } }, "group": { "key": "string", "label": "string", "option": "string" } } ] }, "topSearches": [ { "keywordId": "08721556-ef4c-40f0-9305-68bfacb3aef7", "phrase": "string", "latestPosition": 1, "positionDelta": -9007199254740991 } ], "counts": { "reviewsAwaitingReply": 0, "articlesInReview": 0 }, "setup": { "gbpConnected": true, "coordinatesConfirmed": true }, "usageByCategory": [ { "category": "gsc", "spentMicros": 0 } ] }}