Schedule a partner email report

post

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

Set up a recurring email report for your team: what to include, how often, who gets it. Use this so your ops team gets a digest without logging in. The response doesn't include the new report's id; get it from List scheduled reports.

Prerequisites: a Partner bearer token, the report type and frequency, the accounts to cover, and a recipient.

Authentication: Partner token; any other token gets 403. Each id in account must be inside your tree, otherwise 422.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

reportType

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:

reportPeriodType

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:

all_account

integer

enum

required

Defaults to 0

1 to cover every account under your partner, 0 to cover only the accounts in account.

Allowed:

account

array of integers

Defaults to 5994

Account ids to cover. Required when all_account is 0. Each must exist and be inside your tree.

account

old_recipient_email

string

Email of an existing user to send the report to. Required when recipient_email isn't sent. No user with that email returns 400.

recipient_email

string

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

recipient_first_name

string

length ≤ 100

Defaults to Jane

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

recipient_last_name

string

length ≤ 100

Defaults to Smith

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

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 report is scheduled.

400No user has that old_recipient_email (User not found!), or the user behind the token has no company (Company not found!).

401The token is missing, expired or invalid.

403The token isn't a Partner token.

422A required field is missing, reportPeriodType doesn't fit reportType, an account is outside your tree, or an email fails the RFC + DNS check.

500Unexpected server error.