Choose a version:

searches

The searches schema captures online store search activity with query classification fields. Use it to distinguish result availability, inferred intent, and whether queries target products, articles, or pages.

Anchor to Use casesUse cases

Intent distribution: Group searches by search_query_intent to summarize search intent distribution.
Result availability: Filter search_results_were_returned to separate searches with and without results.
Query classification: Compare is_product_search_query, is_article_search_query, and is_page_search_query flags to split searches by content type.
Day-of-week trend: Trend searches by day_of_week to see which days drive the most on-site search.

Examples

ShopifyQL

View in adminView query results in the ShopifyQL editor

FROM searches

SHOW searches

GROUP BY search_query, search_results_were_returned WITH TOTALS, GROUP_TOTALS

HAVING searches > 5

DURING last_month

ORDER BY searches DESC

LIMIT 50

VISUALIZE searches TYPE grouped_bar

Examples

Description

Show the 50 most-run `searches` last month, split by whether results were returned. This example uses a [`GROUP_TOTALS`](/docs/api/shopifyql/latest/syntax/with#group-total-columns) subtotal per query.

ShopifyQL

FROM searches
  SHOW searches
  GROUP BY search_query, search_results_were_returned WITH TOTALS, GROUP_TOTALS
  HAVING searches > 5
  DURING last_month
  ORDER BY searches DESC
  LIMIT 50
VISUALIZE searches TYPE grouped_bar

Description
Break down `searches` by query intent this quarter. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add the all-intent total to every row.
ShopifyQL
```
FROM searches
  SHOW searches
  GROUP BY search_query_intent WITH TOTALS
  DURING this_quarter
  ORDER BY searches DESC
VISUALIZE searches TYPE donut
```
Description
Compare `searches` last month against the month before. This example uses [`COMPARE TO previous_period`](/docs/api/shopifyql/latest/syntax/compare-to) to benchmark your date range against the equal-length period right before it.
ShopifyQL
```
FROM searches
  SHOW searches
  WITH PERCENT_CHANGE
  DURING last_month
  COMPARE TO previous_period
```
Description
Track weekly `searches` across this quarter. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add a quarter-to-date total beside the weekly rows.
ShopifyQL
```
FROM searches
  SHOW searches
  TIMESERIES week WITH TOTALS
  DURING this_quarter
  ORDER BY week ASC
VISUALIZE searches TYPE bar
```

Anchor to MetricsMetrics

Counts and calculations that let you track key business indicators. Metrics show up as the columns when queried.

Metrics you can use when querying FROM searches.

Anchor to searches searches: Number of search queries made on your online store

Anchor to DimensionsDimensions

Attributes of your data that let you look more granularly at aspects of the data. Group and filter by dimensions to shape the rows your query returns.

Dimensions you can use when querying FROM searches.

Anchor to day day: The day a search happened.
Anchor to day_of_week day_of_week: The day of the week a search happened, with values Monday through Sunday.
Anchor to hour hour: The hour a search happened.
Anchor to hour_of_day hour_of_day: The hour of day a search happened, with values 0 through 23.
Anchor to is_article_search_query is_article_search_query: Whether a visitor's search was for an article, with values true and false.
Anchor to is_page_search_query is_page_search_query: Whether a visitor's search was for a store page, with values true and false.
Anchor to is_product_search_query is_product_search_query: Whether a visitor's search was for a product, with values true and false.
Anchor to minute minute: The minute a search happened.
Anchor to month month: The month a search happened.
Anchor to month_of_year month_of_year: The month of the year a search happened, with values 1 through 12.
Anchor to quarter quarter: The quarter a search happened.
Anchor to search_query search_query: The term or phrase a visitor searched for on your online store.
Anchor to search_query_intent search_query_intent: What the visitor appeared to be looking for when they searched your online store.
Anchor to search_results_were_returned search_results_were_returned: Indicates whether an online store search found matching content, with values true and false. Filter by search_results_were_returned to find searches with no matches.
Anchor to second second: The second a search happened.
Anchor to shop_id shop_id: The unique Shopify identifier for your store. Use shop_id with shop_name to show readable store labels.
Anchor to week week: The week a search happened.
Anchor to week_of_year week_of_year: The week of the year a search happened, with values 1 through 53.
Anchor to year year: The year a search happened.
Anchor to shop_name shop_name: Name of your store

DAY_TIMESTAMP

A date value truncated to day precision.

DAY_OF_WEEK

A day within a week, used for weekday-based grouping and filtering.

HOUR_TIMESTAMP

A timestamp truncated to hour precision.

HOUR_OF_DAY

An hour within a day, typically represented as an integer from 0 to 23.

BOOLEAN

A true or false value representing binary states.

MINUTE_TIMESTAMP

A timestamp truncated to minute precision.

MONTH_TIMESTAMP

A date value representing the start of a month.

MONTH_OF_YEAR

A month number within a year.

QUARTER_TIMESTAMP

A date value representing the start of a fiscal quarter.

STRING

A sequence of characters representing text data.

SECOND_TIMESTAMP

A timestamp truncated to second precision.

IDENTITY

A unique identifier for a Shopify resource such as a customer, product, or order.

WEEK_TIMESTAMP

A date value representing the start of a week.

WEEK_OF_YEAR

A week number within a year.

YEAR_TIMESTAMP

A date value representing the start of a year.

Anchor to Related schemasRelated schemas

search_queries: Query-level click outcomes for which searches lead to clicks.
search_conversions: Search-driven funnel volume for tracking searches downstream to checkout.
sessions: Storewide session data for a denominator beyond search-driven traffic.

Was this page helpful?