analyticsReports

Required scopes: analytics_read

Arguments

String

Forward pagination cursor — returns reports after it.

String

Backward pagination cursor — returns reports before it.

Int

Forward pagination: returns the first N reports (max 100, default 25). Use with after; mutually exclusive with last/before.

Int

Backward pagination: returns the last N reports (max 100, default 25). Use with before; mutually exclusive with first/after.

AnalyticsReportSortKey

Which key to sort by (defaults to the first key, newest-first). Combine with reverse to flip direction.

Boolean

Reverses the sort direction selected by orderBy (or its default).

AnalyticsReportStatus

Only return reports with this status.

Returns

AnalyticsReportConnection!

required

A paginated list of AnalyticsReport items.

Show fields

[AnalyticsReportEdge!]!

required

The list of edges (each a node plus its pagination cursor).

Show fields

String!

required

Opaque cursor for this item; pass to after/before to page from here.

AnalyticsReport!

required

The item at this edge.

Show fields

DateTime!

required

When the report was created.

AnalyticsReportDefinition

What the report shows and how each column is calculated. Null while the report has no query.Requires: analytics_read

AnalyticsReportFailureCode

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.

[AnalyticsReportRevision!]

Saved versions of the report, newest first.Requires: analytics_read

Show fields

Arguments

Int

How many versions to return, newest first (max 100).

AnalyticsReportSchedule

The report’s delivery schedule. Null when nothing is delivered by email or SFTP.Requires: analytics_read

AnalyticsReportStatus!

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.

DateTime!

required

When the report last changed. Pass it as expectedUpdatedAt to analyticsReportUpdate to avoid overwriting someone else’s edit.

[AnalyticsReport!]!

required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

Show fields

DateTime!

required

When the report was created.

AnalyticsReportDefinition

What the report shows and how each column is calculated. Null while the report has no query.Requires: analytics_read

Show fields

[AnalyticsReportColumn!]!

required

The report’s columns, in display order.

[AnalyticsReportFilterDescription!]!

required

Filters on every row of the report, including its date range.

String

What one row represents, such as One row per return.

Int

The most rows the report returns. Null for no limit.

[AnalyticsReportSort!]!

required

How rows are ordered, first key first.

String

A short explanation of the report, written when it was made.

AnalyticsReportFailureCode

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.

[AnalyticsReportRevision!]

Saved versions of the report, newest first.Requires: analytics_read

Show fields

Arguments

Int

How many versions to return, newest first (max 100).

Fields

[String!]!

required

What changed from the version before it, such as Column added: Refund amount.

DateTime!

required

When this version was saved.

Int!

required

The version’s number; higher is newer.

String

The report’s title in this version.

AnalyticsReportSchedule

The report’s delivery schedule. Null when nothing is delivered by email or SFTP.Requires: analytics_read

Show fields

AnalyticsReportCadence

The schedule as a daily, weekly or monthly cadence. Null when only cronExpression can express it.

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.

DateTime!

required

When the report is next delivered.

Boolean!

required

Whether the report is uploaded to the store’s SFTP server.

DateTime!

required

When the schedule last changed.

AnalyticsReportStatus!

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.

DateTime!

required

When the report last changed. Pass it as expectedUpdatedAt to analyticsReportUpdate to avoid overwriting someone else’s edit.

PageInfo!

required

Pagination metadata for the current page.

Show fields

String

Cursor of the last edge in this page; pass to after to page forward.

Boolean!

required

Whether more items exist after this page (drives forward pagination with first/after).

Boolean!

required

Whether more items exist before this page (drives backward pagination with last/before).

String

Cursor of the first edge in this page; pass to before to page backward.

Example

query {
  analyticsReports(after: "...", before: "...", first: 10, last: 10, orderBy: CREATED_AT, reverse: true, status: FAILED) {
    nodes {
      createdAt
      failureCode
      failureReason
      id
      progressMessage
      question
      status
      timezone
      # ...
    }
    pageInfo { hasNextPage endCursor }
  }
}

Getting Started

Guides

Reference

analyticsReports

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example