analytics_read
Arguments
ID!
required
The id of the report.
Returns
An analytics report: a question answered as a table, with columns, filters and sorting. Read its rows with
analyticsReportRows, or export them all with analyticsReportExportStart.Show fields
Show fields
What the report shows and how each column is calculated. Null while the report has no query.Requires:
analytics_readShow fields
Show fields
required
The report’s columns, in display order.
Show fields
Show fields
String
How the column is calculated, such as
count of distinct returns. Null for a column read as stored.String
Anything that changes how the column should be read.
Int
How many decimal places the merchant shows. Null for the default.
String
What the column means.
Filters that apply to this column only.
String!
required
The column’s stable key.
required
What the column holds.
String!
required
The column’s header.
String
What one row represents, such as
One row per return.Int
The most rows the report returns. Null for no limit.
required
How rows are ordered, first key first.
Show fields
Show fields
String!
required
The key of the sorted column.
String!
required
The header of the sorted column.
required
The sort direction.
String
A short explanation of the report, written when it was made.
Why the report FAILED. Null otherwise.
String
A merchant-facing explanation of the failure.
ID!
required
The id of this report.
String
What Redo is doing while the report is PREPARING.
String
The question or instruction behind the report’s latest generation or edit.
Saved versions of the report, newest first.Requires:
analytics_readShow fields
Show fields
ArgumentsFields
Int
How many versions to return, newest first (max 100).
[String!]!
required
What changed from the version before it, such as
Column added: Refund amount.Int!
required
The version’s number; higher is newer.
String
The report’s title in this version.
The report’s delivery schedule. Null when nothing is delivered by email or SFTP.Requires:
analytics_readShow fields
Show fields
The schedule as a daily, weekly or monthly cadence. Null when only
cronExpression can express it.Show fields
Show fields
Int
The day of a MONTHLY delivery, 1-31. A month without that day is skipped.
The day of a WEEKLY delivery.
required
How often the report is delivered.
Int!
required
The hour, 0-23.
Int!
required
The minute, 0-59.
String!
required
The six-field cron expression (seconds first) the schedule runs on, in the report’s timezone.
Boolean!
required
Whether the report is emailed.
[String!]!
required
The addresses the report is emailed to.
Boolean!
required
Whether the report is uploaded to the store’s SFTP server.
required
Whether the report is ready to read.
String
The IANA timezone dates are grouped and filtered in. Null uses the store’s timezone.
String
The report’s title. Null while it is first being written.
Example
query {
analyticsReport(id: "...") {
createdAt
failureCode
failureReason
id
progressMessage
question
status
timezone
# ...
}
}