get
https://production-api.shoutaboutus.com/api/v1/partner/gbp-connection-events
Google Business Profile connection-activity report for the caller's account tree. Returns the event feed (sign-ins, failures, connects, disconnects) newest first, plus funnel KPI totals for the same filter window. Reads gbp_connection_events scoped by partner_id to the caller's partner company.
Auth
- Bearer — partner role, and the caller MUST be a partner-level user (
company.bundle_id = 1), re-asserted in the controller. 403 (with anAUTHZ_DENIEDaudit event) for any non-partner caller; 401 if unauthenticated.
Rate limit
- No rate limit.
Query
| Field | Type | Required | Notes |
|---|---|---|---|
from | date | Optional | Include events on/after this day (start of day). |
to | date | Optional | Include events up to/including this day; must be >= from. |
event | string | Optional | Single event type, e.g. connection.connected, oauth.started, token.exchange_failed. |
source | string | Optional | Portal section: invite_link, connect_google_page, registration, settings, debugger, app, system, unknown. |
company_id | integer | Optional | Filter to one account — includes every location under it. |
store_id | integer | Optional | Filter to a single location. |
search | string | Optional | Match the connected Google account email (like). Max 255. |
page | integer | Optional | Page number, min 1. |
limit | integer | Optional | Page size 10–100, values below 10 are raised to 10 (default 10). |
Behaviour
- 200 with
{ kpis, events }.eventsis a length-aware paginator; each row is a transformed shape (id, event, source, store_id, store_name, google_email, error_code, message, details, user_email, created_at).detailsis a human-readable summary synthesised from the event type + metadata. - 401 unauthenticated · 403 caller is not partner-level.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…