API Reference

List open problems

get
https://production-api.shoutaboutus.com/api/v1/partner/error-notifications

Get the current problems across your locations: which location, which site, what went wrong, when, and whether it's been looked at. Use this as a regular check, or to build an alerts view in your dashboard. Choose the list with type (open, acknowledged or resolved), and narrow it with search_field and search_value. Returns one entry per problem, newest first, 5 per page unless you send limit.

Prerequisites: a Partner bearer token.

Authentication: Partner token. Lists the problems for the partner behind the token.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required
Defaults to open

Required. open (neither acknowledged nor resolved), acknowledged or resolved.

Allowed:
integer
10 to 100
Defaults to 10

Page size, 10–100. Default 5 when left out. Values below 10 are raised to 10; above 100 returns 422.

integer
≥ 1
Defaults to 1

The page to return, from 1. Default 1.

string
enum
Defaults to notificationDate

Sort by notificationDate (default), latest_note_date, accountName, storeName, reviewSiteName, subject or resolved.

Allowed:
string
enum
Defaults to desc

asc or desc (default).

Allowed:
string
enum
Defaults to storeName

Where to search: notificationDate (default; matches the day), accountName, storeName, subject or reviewSiteName.

Allowed:
string
Defaults to Sydney

What to search for.

Responses

Updated 17 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago

Did this page help you?