get
https://production-api.shoutaboutus.com/api/v1/partner/error-notifications
Get a paginated, sortable, searchable list of the partner's error/monitoring notifications, filtered by lifecycle state (open / acknowledged / resolved).
Auth: Partner — authentication, under the partner prefix. Scoped by the caller's own company: the list is built for, so a partner only sees notifications under their company. The type query param maps to the SQL filter (resolved=1 for resolved, status='acknowledged' for acknowledged, else open).
Rate limit: No rate limit.
Request
- Query:
type(string, required) — one ofopen,acknowledged,resolved. - Query:
limit(integer, optional) — page size, default 5. - Query:
page(integer, optional) — page number, default 1. - Query:
sort_field(string, optional) — one ofnotificationDate,latest_note_date,accountName,storeName,reviewSiteName,subject,resolved. DefaultnotificationDate. (Not in the request validation rules; read from input directly.) - Query:
sort_by(string, optional) —asc/desc/ASC/DESC. Defaultdesc. - Query:
search_field(string, optional) — one ofnotificationDate,accountName,storeName,subject,reviewSiteName. (Not in request validation rules; read from input directly.) - Query:
search_value(string, optional) — value to search for.
Response — paginated collection ({ data: [.], links, meta }). Each item:
id(int) — notification id.is_badge(string) —Yeswhen unread (notified != 1), elseNo.notificationDate(string) — created_at formattedm/d/y.accountName(string|null) — account company name (com.name).storeName(string) —CONCAT_WS(' - ', store.name, store.storeid).reviewSiteName(string) — review site name;Maps.Googlenormalized toGoogle;#N/Awhen empty.subject(string) — notification subject, or#N/A.isResolved(string) —Yes/No.latestNote(string) — latest note content, or#N/A.lastUpdated(string) — latest note date formattedm/d/y.show_acknowledge_button(string) —yes/no(yes when not acknowledged and not resolved).show_resolved_button(string) —yes/no(yes when not resolved).store_id(int|null) — the location'sid.review_site_id(int|null) — the review site'sid.store_review_site_id(int|null) — matching the connected review site'sidfor the store+site, or null.show_connect_button(string) —yes/no(yes whenreview_site_id > 0and not resolved).
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
