Shopify Query Language

The query language of the Analytics API is called ShopifyQL. A valid ShopifyQL query consists of parts similar to a valid SQL request. Let's look at an example:

SHOW sum(pageview_count) FROM visits SINCE -7d UNTIL -1d

This query will fetch the total pageviews for the last 7 days. The result would look something like:

sum_pageview_count 282778

Fetching data (SHOW)

There are a number of ways to select, filter and aggregate data using ShopifyQL.

Columns

Each schema is comprised of many columns.

SHOW utm_campaign_name, utm_campaign_term, utm_campaign_source

Aggregation Functions

A number of functions exist to aid with gathering or aggregating data.

function description
sum returns the summation of rows scanned
min returns the minimum value of rows scanned
max returns the maximum value of rows scanned
count returns the count of objects
DISTINCT returns the unique count of rows
avg returns the average value of rows scanned
median median value of results
any returns one value from the results

Aliases

Commonly used aggregation expressions are provided as named aliases.

SHOW total_pageviews vs SHOW sum(pageview_count)

Named aliases on the visits schema:

Name Type Definition
avg_duration number avg(duration)
total_pageviews number sum(pageview_count)
total_purchases number sum(purchase_count)
total_sessions number count(pageview_count)
total_visitors number count(DISTINCT user_token)

Result columns can be explicitly labeled with expression AS label, otherwise a label derived from the expression will be assigned which can often be a bit unwieldy.

SHOW sum(pageview_count) AS pageviews

Aggregate Conditions

ShopifyQL provides support for conditions within the SHOW statement. These can be used to filter rows from inclusion into aggregation functions. Aggregate conditions make it possible to get results back in a single query that would usually require two or more.

Selecting schemas (FROM)

Schemas are selected by the key word FROM. This works in a similar fashion to SQL. The following query is using the visits schema:

SHOW sum(pageview_count) FROM visits

Shopify provides several schemas that you can fetch data from:

Filtering (WHERE)

The WHERE clause indicates the condition or conditions that rows must satisfy to be selected.

Unlike aggregate conditions, which only filter for one column of the result. WHERE conditions filter for all columns that will be returned. WHERE clauses can simplify queries, such as below:

Using aggregate conditions

Using WHERE clauses:

Valid operators are:

  • !=
  • ==
  • IN

Grouping data

Grouping by results (BY)

The BY statement can be used to group the result-set by one or more columns. In the following example, we use the BY clause to group data based on day. Note that there is no row for 2016-02-01. This is because there is no data for that day. This behaviour differs from that of the OVER clause explained below.

Total pageviews by day (last 7 days)

SHOW sum(pageview_count) BY day(timestamp) FROM visits SINCE -7d UNTIL -1d

page_path sum_pageview_count
"2016-01-30T00:00:00-05:00" 69910
"2016-01-31T00:00:00-05:00" 33611
"2016-02-02T00:00:00-05:00" 18139
"2016-02-03T00:00:00-05:00" 22225
"2016-01-28T00:00:00-05:00" 49897
"2016-01-29T00:00:00-05:00" 59655

Grouping with backfill (OVER)

Similarly to BY the OVER clause can also be used to group result sets. The difference is that missing rows will be backfilled. In the following example, we use the OVER clause to group data based on day. Note that there is a backfilled row for 2016-02-01.

Total pageviews per day (last 7 days)

SHOW sum(pageview_count) OVER day(timestamp) FROM visits SINCE -7d UNTIL -1d

day_timestamp sum_pageview_count
"2016-01-30T00:00:00-05:00" 69910
"2016-01-31T00:00:00-05:00" 33611
"2016-02-01T00:00:00-05:00" 0
"2016-02-02T00:00:00-05:00" 18139
"2016-02-03T00:00:00-05:00" 22225
"2016-01-28T00:00:00-05:00" 49897
"2016-01-29T00:00:00-05:00" 59655

It is also possible to combine BY and OVER queries.

Total pageviews by browser per day (last 7 days)

SHOW sum(pageview_count) OVER day(timestamp) BY ua_browser FROM visits SINCE -7d UNTIL -1d

day_timestamp ua