Analytics

Anchor to OverviewOverview

The Shop Minis CLI provides access to analytics reports that help you understand how your Mini is performing. These reports provide valuable insights into user engagement, conversions, and other key metrics.

The CLI provides several commands to work with analytics reports:

• Use the reports list command to view all available report types
• Use the reports dates command to see available dates for a specific report
• Use the reports get command to download report data as CSV

CommandList all available reports

CommandView available dates for a report

CommandGet report data as CSV

Anchor to Report typesReport types

The following report types are available for analytics:

Anchor to CONTENT_IMPRESSIONSCONTENT_IMPRESSIONS

Shows how often content associated with your Mini is viewed by users. These are generated by the ContentWrapper component.

Fields:

• day: The date for which data was collected (in UTC)
• num_users: Number of distinct users who viewed the content
• num_views: Total number of content views
• impression_type: Type of impression. This represents where the content was seen e.g. IN_MINI
• content_public_id: Identifier for the content
• page_value: Page where the content was viewed

Anchor to PRODUCT_IMPRESSIONSPRODUCT_IMPRESSIONS

Shows which products are being viewed in your Mini, how often and by how many users. These are generated by the ProductCard and ProductLink components inside of Mini.

Fields:

• day: The date for which data was collected (in UTC)
• product_id: Identifier for the product
• shop_id: Identifier for the shop
• impression_type: Type of impression. This represents where the product was seen e.g. IN_MINI
• num_users: Number of unique users who viewed the product
• num_impressions: Total number of product impressions

Anchor to SALESSALES

Shows sales data for your Mini, including order count and revenue.

Fields:

• day: The date for which data was collected (in UTC)
• shop_id: Identifier for the shop
• product_id: Identifier for the product
• num_orders: Number of orders
• total_gmv_usd: Total gross merchandise value in USD

Anchor to USAGE_STATSUSAGE_STATS

Shows how users interact with your Mini, over the course of a day.

Fields:

• day: The date for which data was collected (in UTC)
• num_sessions: Number of user sessions
• num_users: Number of unique users
• num_mini_opens: Number of times the Mini was opened