List scheduled reports

post

https://production-api.shoutaboutus.com/api/v1/email-report/list

See every scheduled email report for your partner or an account. Use this to manage them, and to find the report_id you need to edit or delete one. Returns one entry per report, a page at a time.

Prerequisites: a Partner or Account bearer token.

Authentication: Partner or Account token. The list covers only the reports of the company behind the token.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sort_field

string

enum

Defaults to email

Field to sort by: first_name, last_name, email, report_type or report_period_type_id.

Allowed:

sort_by

string

enum

Defaults to ASC

Sort direction. Default ASC. Used only with sort_field.

Allowed:

search_field

string

enum

Defaults to store_name

Field to search: first_name, last_name, email, report_type, report_period_type_id or store_name. report_type and report_period_type_id match exactly; the others match part of the value. A store_name search also returns reports that cover every location.

Allowed:

search_value

string

Defaults to Sydney

The value to search for. Used only with search_field. Can't contain < or >.

limit

integer

Defaults to 10

Reports per page, 10 to 100. Values below 10 are raised to 10; above 100 returns 422. Default 10.

page

integer

Defaults to 1

Page number. Default 1.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The scheduled reports, a page at a time.

401The token is missing, expired or invalid.

422sort_field, sort_by or search_field isn't an allowed value, search_value contains < or >, or limit is above 100.

429More than 60 requests in a minute from this user.

500Unexpected server error.