Error notifications

Operational-monitoring inbox for the partner: failed scrapes, missing credentials, throttled API quotas.

Operational-monitoring inbox for the partner: failed scrapes, missing credentials, throttled API quotas. Notifications can be listed (filtered by status bucket), inspected in detail, annotated with notes, bulk-transitioned, and re-emailed to the on-call admin.

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETList error notificationsGet a paginated, sortable, searchable list of the partner's error/monitoring notifications, filtered by lifecycle state (open / acknowledged / resolved).
GETGet notification detailsGet 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.
GETList notes on a notificationGet a paginated list of notes attached to a given error notification, newest-updated first.
POSTAdd a noteAdd a free-text note to an error notification.
POSTDelete a noteDelete a single note from an error notification.
POSTBulk update notification statusBulk-updates the lifecycle status of one or more error notifications, marking them acknowledged or resolved.
POSTSend alert emailSend 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).