Report Preferences

Retrieve reporting preferences

GETaccount/reportPreferences

Retrieves the reporting preferences for your account. Reporting preferences define whether or not emails to the account holder will be sent at the given interval. Reports include trends data for the relevant time period with comparisons to the previous one

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

GET https://api.gosquared.com/account/v1/reportPreferences

Example Request

curl "https://api.gosquared.com/account/v1/reportPreferences?api_key=demo" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Please fill in the required fields in the Query Builder

Update reporting preferences

POSTaccount/reportPreferences

Updates the reporting preferences for your account. Preferences that are not present in the request will not be modified.

POST Body

daily_report

Object

enabled

BooleanRequired

weekly_report

Object

enabled

BooleanRequired

monthly_report

Object

enabled

BooleanRequired

daily_ecommerce_report

Object

enabled

BooleanRequired

weekly_ecommerce_report

Object

enabled

BooleanRequired

monthly_ecommerce_report

Object

enabled

BooleanRequired

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

POST https://api.gosquared.com/account/v1/reportPreferences

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/reportPreferences?api_key=demo" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint