LogoLogo
Build appsContact API support
  • Build apps
  • Site Templates
  • API Reference
  • Changelog
  • REST API
    • REST API overview
    • Store Profile
      • Get store profile
      • Update store profile
      • Upload store logo image
      • Delete store logo image
      • Store reports
        • Get store reports
        • Get latest store update stats
        • Get deleted items history
    • Orders
      • Search orders
      • Get order
      • Get last order
      • Calculate order details
      • Update order
      • Create order
      • Delete order
      • Get repeat order URL
      • Order invoices
        • Get order receipt PDF
        • Get tax invoices for order
        • Generate tax invoice for order
      • Order statuses
        • Search order statuses
        • Get order status
        • Update custom order status
      • Order extra fields
        • Search order extra fields
        • Update order extra field
        • Add extra fields to order
        • Delete order extra field
      • Abandonned carts
        • Search abandoned carts
        • Get abandoned cart
        • Update abandoned cart
        • Convert abandoned cart to order
      • Recurring subscriptions
        • Search recurring subscriptions
        • Get recurring subscription
        • Update recurring subscription
    • Products
      • Search products
      • Get product
      • Update product
      • Create product
      • Delete product
      • Delete all products
      • Adjust product stock
      • Get product filters
      • Get recently used product swatches
      • Search product brands
      • Product images and videos
        • Upload main product image
        • Upload main product image (async)
        • Upload gallery product image
        • Upload gallery product image (async)
        • Delete main product image
        • Delete gallery product image
        • Delete all gallery product images
        • Upload main product video
        • Upload gallery product video
        • Upload cover for gallery video
        • Delete main product video
        • Delete gallery product video
        • Download gallery product video
        • Bulk update product images and videos
      • Product files
        • Upload product file
        • Download product file
        • Delete product file
        • Delete all product files
        • Change product file description
      • Product variations
        • Search product variations
        • Get product variation
        • Update product variation
        • Create product variation
        • Delete product variation
        • Delete all product variations
        • Adjust product variation stock
        • Upload product variation image
        • Upload product variation image (async)
        • Delete product variation image
      • Product types and attributes
        • Search product types
        • Get product type
        • Update product type and attributes
        • Create product type
        • Delete product type
      • Product reviews
        • Search product reviews
        • Get product reviews stats
        • Update product review status
        • Bulk update/delete product reviews
        • Delete product review
    • Categories
      • Search categories
      • Search categories by path
      • Get category
      • Update category
      • Create category
      • Delete category
      • Category images
        • Upload category image
        • Upload category image (async)
        • Delete category image
      • Manage order of categories in the store
        • Get order of categories
        • Update order of categories
      • Manage order of products in the category
        • Get order of products
        • Update order of products
        • Assign products to the category
        • Unassign products from the category
    • Customers
      • Search customers
      • Get customer
      • Update customer
      • Create customer
      • Delete customer
      • Customer groups
        • Search customer groups
        • Get customer group
        • Update customer group name
        • Create customer group
        • Delete customer group
      • Customer contacts
        • Search customer contacts
        • Get customer contact
        • Update customer contact
        • Create customer contact
        • Delete customer contact
      • Customer extra fields
        • Search customer extra fields
        • Get customer extra field
        • Update customer extra field
        • Create customer extra field
        • Delete customer extra field
    • Discounts
      • Promotions
        • Search promotions
        • Update promotion
        • Create promotion
        • Delete promotion
      • Discount coupons
        • Search discount coupons
        • Get discount coupon
        • Update discount coupon
        • Create discount coupon
        • Delete discount coupon
    • Domains
      • Search store domains
      • Update store domains
      • Search domains for purchase
      • Purchase domain
      • Send domain verification email
      • Reset domain password
    • Dictionaries
      • Country codes
      • Currency codes
      • Currency codes by country
      • State codes by country
      • Tax classes by country
    • Staff accounts
      • Search staff accounts
      • Get staff account
      • Get staff account scopes
      • Update staff account
      • Create staff account
      • Delete staff account
      • Resend staff account invite
      • Cancel staff account invite
    • Application
      • Get app subscription status
      • Cancel app subscription
      • Get all app storage data
      • Get specific app storage data
      • Update specific app storage data
      • Delete specific app storage data
      • Add app storage data
      • Custom charge with Ecwid billing
    • Batch requests
      • Create batch request
      • Get batch status
      • Search batch requests by status
      • Stop batch request
      • Stop and delete batch request
    • Shipping options
      • Search shipping options
      • Update shipping option
      • Create shipping option
      • Delete shipping option
    • Payment options
      • Search payment options
      • Get payment option
      • Update payment option
      • Create payment option
      • Delete payment option
    • Checkout extra fields
      • Add checkout extra fields with JavaScript
      • Manage checkout extra fields with REST API
        • Search checkout extra fields
        • Get checkout extra field
        • Update checkout extra field
        • Create checkout extra field
        • Delete checkout extra field
    • Storefront widget details
      • Get page slug and static code
      • Set base URL for storefront widgets
      • Optimize custom website SEO with better URLs
        • Enable Clean Store URLs on a custom website
        • Set Custom Page Slugs on a custom website
      • Dynamic loading for storefront widget
      • SSO (Single-Sign-On) for websites
        • Add SSO to the website
        • Customize SSO on the website
        • SSO code examples
      • Static store pages
        • Static code for home page
        • Static code for category page
        • Static code for product page

Lightspeed® 2025

On this page
  • Access scopes
  • Path params
  • Query params
  • Headers
  • Response JSON

Was this helpful?

  1. REST API
  2. Store Profile
  3. Store reports

Get store reports

Get store stats used for creating reports in Ecwid admin.

GET https://app.ecwid.com/api/v3/{storeId}/reports/{reportType}

Access scopes

Your app must have the following access scopes to make this request: read_store_stats

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

reportType

Report type that defines what data will be received in response. Find the full list of available reports below.

reportType

A list of available reports. Chart types include:

  • Chart — Default line chart.

  • Piechart — Sliced round chart.

  • Table — Table with the data.

  • Barchart — Vertical bar chart.

Visitors:

reportType
Сhart type

allTraffic

chart

newVsReturningVisitors

piechart

visitorsByCities

piechart

visitorsByCountry

barchart OR piechart

visitorsByDevice

piechart

visitorsByLanguage

piechart

Conversions:

reportType
Сhart type

salesFunnel

barchart

topOfCategoriesByViews

table

topOfProductsByViews

table

topOfProductsByAddingToCart

table

Orders:

reportType
Сhart type

allOrders

chart

newOrdersVsRepeatOrders

piechart

topOfProductsByOrders

table

topOfCustomersByOrders

table

topOfPaymentMethodsByOrders

table

topOfShippingMethodsByOrders

table

topOfProductsByAvailability

table

Finances:

reportType
Сhart type

allRevenue

chart

allExpenses

table

allProfit

chart

topOfProductsByProfit

table

tips

table

Marketing:

reportType
Сhart type

topOfMarketingSources

piechart

abandonedCarts

table

automatedEmails

table

acceptMarketing

piechart

mailchimpCampaigns

table

topOfCouponsByOrders

table

topOfDiscountsByOrders

table

giftCards

piechart

Query params

All query params are optional.

Name
Type
Description

startedFrom

number

Lower bound of a time interval for report generation. If not specified, report will be generated from the store creation date. Supported value: UNIX timestamp, for example: 1591646400

endedAt

number

Upper bound of a time interval for report generation. If not specified, report will be generated up to the request date and time. Supported value: UNIX timestamp, for example: 1591679000

timeScaleValue

string

Time scale of the chart in response. Must be one of: hour, day, week, month, year.

comparePeriod

string

Period for comparing and calculating the period-over-period metrics in a received report. If not specified, no such metric will be added to the report.

Must be one of:

  • noComparePeriod

  • similarPeriodInPreviousWeek

  • similarPeriodInPreviousMonth

  • similarPeriodInPreviousYear

  • previousPeriod

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Response JSON

A JSON object with the following fields:

Name
Type
Description

reportType

string

Type of the received report.

startedFrom

number

Lower bound of time interval used for report generation. Only present if it was passed as a request query param.

endedAt

number

Upper bound of time interval used for report generation. Only present if it was passed as a request query param.

timeScaleValue

string

Time scale of the chart in response. Only present if it was passed as a request query param.

aggregatedData

Metric values aggregated for the set period.

dataset

array of objects dataSet

Part of the report defined by the time/device/region/etc. that depends on the report type (except table chart type).

aggregatedData

Name
Type
Description

dataId

string

ID of the passed metric.

dataValue

number

Metric value.

dataSet

Name
Type
Description

orderBy

number

Sorting number for the datasets in the report.

datapointId

string

Name of the graph, pie segment, or position at the top that describes the data inside. Example 1: "Mobile" and "Desktop" are two IDs for the visitorsByDeviceReport report. Example 2: "June 1, 2024" and "June 2, 2024" are IDs for the allTraffic report.

startTimeStamp

number

Starting datetime of the specific dataset. Available only for the chart chart type.

endTimeStamp

number

Final datetime of the specific dataset. Available only for the chart chart type.

percentage

number

Percentage of the "slice" in the report. Available only for the piechart report type.

data

array of objects

Aggregated data for the specific dataset in the report. Matches its structure with the aggregatedData field.

Last updated 3 months ago

Was this helpful?

string

array of objects

reportType
aggregatedData