Find out why a location stopped collecting reviews or posting responses, and track what you've done about it.
Find out why a location stopped collecting reviews or posting responses, and track what you've done about it.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | List open problems | Get a paginated, sortable, searchable list of the partner's error/monitoring notifications, filtered by lifecycle state (open / acknowledged / resolved). |
GET | Get one problem | Get the full raw record of a single error notification and, if it belongs to the caller's company and is still unread, marks it as notified. |
GET | List a problem's notes | Get a paginated list of notes attached to a given error notification, newest-updated first. |
POST | Add a note to a problem | Add a free-text note to an error notification. |
POST | Delete a note | Delete a single note from an error notification. |
POST | Mark problems resolved or in progress | Bulk-updates the lifecycle status of one or more error notifications, marking them acknowledged or resolved. |
POST | Email a problem to someone | Send the error-notification alert email, either to the store's configured response-posting error recipients (email_to=admin) or to a custom address (email_to=other). |