Objects / Reports — Shopfront Developer Documentation

Object

FavouriteReportEmailSettings

Fields	Type	Description
emails	[Email]	The list of the emails to send the report to
period	TimePeriod	The period settings for sending the report
anchor	DateTime	The anchor date for resolving
orientation	FavouriteReportOrientationEnum	The orientation of the generated by the report (Only used when the type is PDF)
type	FavouriteReportExportTypeEnum	The file type of the generated report

Object

FavouriteReport

Implements

List of interfaces this object implements

FavouriteReportInterface

Fields	Type	Description
id	ID!	The unique ID for the favourite report
name	String!	The name of the report
layers	Float	The maximum layers that report will export (if unset will be ignored)
emailSettings	FavouriteReportEmailSettings	The settings to use for automatically emailing this report
nextEmailDate	DateTime	The next date this report should be emailed on
syntaxErrors	Boolean	Whether there was syntax errors during the automated emailing of this report
createdAt	DateTime	The date the report was created
updatedAt	DateTime	The date the report was last updated
createdBy	User	The user who created this report
updatedBy Deprecated	User	The user who updated this report updatedBy has been superseded by latestRevision
latestRevision	Revision	The most recent revision that happened to this report
revisions	FavouriteReportInterfaceRevisionConnection	The revisions for the favourite report
type	ReportTypeEnum!	The type of report (used when reloading the reports in the UI)
report	String	The raw report to run

FavouriteReportInterfaceRevisionConnection

Object — ConnectionType of Revision

Sortable Fields

Fields from Revision that can be used to sort the connection items

timestamp

Object

SpecialFavouriteReportReportTime

Fields	Type	Description
amount	Int!	The amount of time this report should run for over the `period`
period	String!	The `period` the `amount` should apply for (i.e. days, weeks, months, years)
inclusive	Boolean!	Whether the time period should include today or not

Object

SpecialFavouriteReportReport

Fields	Type	Description
time	SpecialFavouriteReportReportTime!	The time period to generate the report for
parameters	JSON!	The parameters to apply to the report

Object

SpecialFavouriteReport

Implements

List of interfaces this object implements

FavouriteReportInterface

Fields	Type	Description
id	ID!	The unique ID for the favourite report
name	String!	The name of the report
layers	Float	The maximum layers that report will export (if unset will be ignored)
emailSettings	FavouriteReportEmailSettings	The settings to use for automatically emailing this report
nextEmailDate	DateTime	The next date this report should be emailed on
syntaxErrors	Boolean	Whether there was syntax errors during the automated emailing of this report
createdAt	DateTime	The date the report was created
updatedAt	DateTime	The date the report was last updated
createdBy	User	The user who created this report
updatedBy Deprecated	User	The user who updated this report updatedBy has been superseded by latestRevision
latestRevision	Revision	The most recent revision that happened to this report
revisions	FavouriteReportInterfaceRevisionConnection	The revisions for the favourite report
type	SpecialReportTypeEnum!	The type of report (used when reloading the reports in the UI)
report	SpecialFavouriteReportReport!	The raw report to run

FavouriteReportInterfaceRevisionConnection

Object — ConnectionType of Revision

Sortable Fields

Fields from Revision that can be used to sort the connection items

timestamp