Creating Notebooks

The ShopifyQL Notebooks app enables you to query your store data and create visualizations. By combining different data visualization with text locks, you can create reports on your store called notebooks. For example you can create a notebook to explore your total product sales, and a notebook to help you understand which products are making the biggest contribution to your profit margins. You can create as many notebooks as you want.

Install the ShopifyQL notebooks app

  1. Go to the ShopifyQL Notebooks page on the Shopify app store.

  2. Click Add app.

  3. Log in to the Shopify store that you want to install the ShopifyQL Notebooks app on.

  4. To agree to share the required data with the ShopifyQL Notebooks app, click Install app.

After the app is installed on your store, you can create a new notebook.

Creating a new notebook

A notebook is a set of content blocks that you create and put in the order that you want. There are different types of blocks that you can use to create your notebook:

You can use a combination of data visualizations such as graphs and charts, as well as text to best tell the data story.

Create a new notebook

  1. From your Shopify admin, click Settings > Apps and sales channels.

  2. From the Apps and sales channels page, click ShopifyQL Notebooks.

  3. Click Open app.

  4. Click Create notebook.

  5. By default, the new notebook has a single codeblock. Do either of the following:

    • Choose a template for your code block
    • Write your own code block
  6. Optional: Add additional code blocks or text blocks to your notebook by hovering your mouse where you want to add the block, and selecting either Text block or Code block.

  7. To save your notebook, click the ... button, and then click Name.

  8. Enter a name for your notebook, and then click Save.

After you save your notebook, you can export the notebook, or edit the notebook.

Text blocks

A text block lets you add styled text or a static image to your notebook. Text blocks can be used for headings in your notebooks, introductions, or descriptions of data visualizations.

Code blocks

Code blocks let you add a a query to your notebook that uses the ShopifyQL query language to return data about your store. In your code block you can choose how the data displayed in your notebook. Learn more about using ShopifyQL for Notebooks.

Templates

Templates are pre-written ShopifyQL queries that you can use as-is, or as a starting place to create your own query. When you create a code block, you can select a template by clicking Templates and selecting a template from the list. Templates are available for a number of data visualizations, for example:

  • Sales over time
  • Top converting products
  • Top selling products

Autocompletion

ShopifyQL Notebooks automatically provide suggestions for your query as you write your code block. Click on the suggestion to add it to your query, or continue typing to add your own code.

Export a notebook

  1. From your Shopify admin, click Settings > Apps and sales channels.

  2. From the Apps and sales channels page, click ShopifyQL Notebooks.

  3. Click Open app.

  4. In the Notebooks section, click the notebook that you want to export.

  5. Click the ... button, and then click Presentation mode.

  6. Click Export.

Your notebook is downloaded as a PNG file.

Edit a notebook

  1. From your Shopify admin, click Settings > Apps and sales channels.

  2. From the Apps and sales channels page, click ShopifyQL Notebooks.

  3. Click Open app.

  4. In the Notebooks section, click the notebook that you want to edit.

  5. Make changes to the notebook by editing blocks, adding new blocks, or deleting blocks.

  6. Click Save to save your changes.

Ready to start selling with Shopify?

Try it free