Skip to content
Navigation

Reads a product's views, visitors, checkouts started and orders over a period, by channel.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/traffic/stats

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • from
    optional
    string
    format: date
  • to
    optional
    string
    format: date
  • bucket
    optional
    day
    or
    week
    or
    month

Returns

200

Reads a product's views, visitors, checkouts started and orders over a period, by channel.

JSON
  • time_zone
    string
    required
  • from
    string
    required
  • to
    string
    required
  • previous_range
    object
    required
    • from
      string
      required
    • to
      string
      required
  • bucket
    string
    required
  • rolled_through
    required

    The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet.

    One of the following:

    • string
    • null
  • covered_from
    required

    The earliest store-local day the totals hold, null before the first; earlier days count nothing.

    One of the following:

    • string
    • null
  • product_views
    object
    required

    Products shown to customers; the merchant's own visits and other callers who are no customer are left out.

    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • checkouts_started
    object
    required

    Carts started, each counted for the product of its first line alone.

    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • orders
    object
    required

    Orders through the store's own checkout (never a renewal, nor one recorded through the API or by hand) on the days the totals cover, a test purchase included.

    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • rates
    object
    required

    Rates over the steps above, which count apart, so one may reach past 1.

    • current
      object
      required
      • view_to_checkout
        required

        One of the following:

        • number
        • null
      • checkout_to_order
        required

        One of the following:

        • number
        • null
      • view_to_order
        required

        One of the following:

        • number
        • null
    • previous
      required

      One of the following:

      • object
      • null
  • estimated
    boolean
    required

    Views or carts counted from sampled data, so the figures are estimates.

  • visitors
    object
    required

    The product's daily unique visitors, summed over the days.

    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • by_channel
    array of
    object
    required

    The product's views and visitors by the channel they came through.

    • views
      object
      required

      Pages, products and entries shown, scaled back from sampling.

      • current
        number
        required
      • previous
        required

        One of the following:

        • number
        • null
    • visitors
      object
      required

      Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one person on three days counts three times.

      • current
        number
        required
      • previous
        required

        One of the following:

        • number
        • null
    • estimated
      boolean
      required

      Counted from sampled data, so the figures are estimates.

    • channel
      string
      required
  • series
    array of
    object
    required
    • start
      string
      required
    • end
      string
      required
    • product_views
      number
      required
    • checkouts_started
      number
      required
    • orders
      number
      required
    • previous_product_views
      required

      One of the following:

      • number
      • null
    • previous_checkouts_started
      required

      One of the following:

      • number
      • null
    • previous_orders
      required

      One of the following:

      • number
      • null
    • estimated
      boolean
      required

      Views or carts counted from sampled data, so the figures are estimates.

    • visitors
      number
      required
    • previous_visitors
      required

      One of the following:

      • number
      • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close