API Reference

Schedule an account email report

post
https://production-api.shoutaboutus.com/api/v1/user/reports/add

Set up a recurring email report for a business owner or user. Use this to give a customer a regular digest. The response doesn't include the new report's id; get it from List scheduled reports.

Prerequisites: an Account bearer token, the report type and frequency, the locations to cover, and a recipient.

Authentication: Account token; any other token gets 403. Each location must be inside your account, otherwise 422.

Rate limit: none.

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

The report to send: activity_report, response_report, review_feed, review_feed_star, review_responses, review_site_connections or insight_report.

Allowed:
string
enum
required
Defaults to month

How often to send it: day, week or month. Allowed values depend on reportType: activity_report, response_report and insight_report must be month; review_feed and review_feed_star must be day; review_site_connections must be week or month; review_responses accepts any. A wrong combination returns 422.

Allowed:
integer
enum
required
Defaults to 0

1 to cover every location in your account, 0 to cover only the locations in store_ids.

Allowed:
store_ids
array of integers
Defaults to 3007

Location ids to cover. Required when all_store is 0. Each must exist and be inside your account.

store_ids
string

Email to send the report to, reusing the recipient already saved with that email (or the name of the user with that email) when there is one. Required when recipient_email isn't sent.

string

Email of a new recipient. Required when old_recipient_email isn't sent.

string
length ≤ 100
Defaults to Jane

The new recipient's first name. Max 100 characters. Required when old_recipient_email isn't sent.

string
length ≤ 100
Defaults to Smith

The new recipient's last name. Max 100 characters. Required when old_recipient_email isn't sent.

Responses

Updated 18 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 18 days ago

Did this page help you?