Skip to content
Navigation

Reads the store's views, visitors, sign-ins and sign-ups over a period, by channel, country and product, with visits by referrer, campaign and device.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

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

Returns

200

Reads the store's views, visitors, sign-ins and sign-ups over a period, by channel, country and product, with visits by referrer, campaign and device.

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
  • 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.

  • sign_ins
    object
    required

    Customers signing in, a new sign-up included.

    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • sign_ups
    object
    required

    Customers signing in for the first time.

    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • by_event
    array of
    object
    required
    • 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.

    • event
      string
      required
  • by_channel
    array of
    object
    required

    By the channel each view came through: web, api, mcp or feed.

    • 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
  • by_country
    array of
    object
    required

    By the visitor's country, null where it is unknown.

    • 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.

    • country
      required

      One of the following:

      • string
      • null
  • top_products
    object
    required

    The most viewed products in the range, and how many were viewed at all.

    • total
      number
      required
    • covered_from
      required

      The first day the product figures hold, which may come after covered_from.

      One of the following:

      • string
      • null
    • products
      array of
      object
      required
      • 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.

      • product
        object
        required
        • id
          string
          required
        • title
          required

          One of the following:

          • string
          • null
  • series
    array of
    object
    required
    • start
      string
      required
    • end
      string
      required
    • views
      number
      required
    • visitors
      number
      required
    • previous_views
      required

      One of the following:

      • number
      • null
    • previous_visitors
      required

      One of the following:

      • number
      • null
    • estimated
      boolean
      required

      Counted from sampled data, so the figures are estimates.

  • sources
    object
    required
    • visits
      object
      required

      Visits (a visit's first page), scaled back from sampling.

      • current
        number
        required
      • previous
        required

        One of the following:

        • number
        • null
    • estimated
      boolean
      required

      Counted from sampled data, so the figures are estimates.

    • covered_from
      required

      The first day the visit figures hold, which may come after the answer's covered_from; null until one holds a visit.

      One of the following:

      • string
      • null
    • top_referrers
      object
      required

      The referring hosts with the most visits, direct visits as null, and how many the days' top values name, direct included.

      • total
        number
        required
      • referrers
        array of
        object
        required
        • visits
          object
          required

          Visits (a visit's first page), scaled back from sampling.

          • current
            number
            required
          • previous
            required

            One of the following:

            • number
            • null
        • estimated
          boolean
          required

          Counted from sampled data, so the figures are estimates.

        • referrer
          required

          One of the following:

          • string
          • null
      • other
        object
        required

        Visits from every referring host not listed.

        • visits
          object
          required

          Visits (a visit's first page), scaled back from sampling.

          • current
            number
            required
          • previous
            required

            One of the following:

            • number
            • null
        • estimated
          boolean
          required

          Counted from sampled data, so the figures are estimates.

    • top_campaigns
      object
      required

      The campaigns with the most visits, and how many the days' top values name.

      • total
        number
        required
      • campaigns
        array of
        object
        required
        • visits
          object
          required

          Visits (a visit's first page), scaled back from sampling.

          • current
            number
            required
          • previous
            required

            One of the following:

            • number
            • null
        • estimated
          boolean
          required

          Counted from sampled data, so the figures are estimates.

        • campaign
          object
          required
          • utm_source
            required

            One of the following:

            • string
            • null
          • utm_medium
            required

            One of the following:

            • string
            • null
          • utm_campaign
            required

            One of the following:

            • string
            • null
          • ref
            required

            One of the following:

            • string
            • null
      • untagged
        object
        required

        Visits whose landing named no campaign.

        • visits
          object
          required

          Visits (a visit's first page), scaled back from sampling.

          • current
            number
            required
          • previous
            required

            One of the following:

            • number
            • null
        • estimated
          boolean
          required

          Counted from sampled data, so the figures are estimates.

      • other
        object
        required

        Visits from every campaign not listed.

        • visits
          object
          required

          Visits (a visit's first page), scaled back from sampling.

          • current
            number
            required
          • previous
            required

            One of the following:

            • number
            • null
        • estimated
          boolean
          required

          Counted from sampled data, so the figures are estimates.

    • by_device
      array of
      object
      required

      By the visitor's device, every one with visits: mobile, or desktop for a desktop or a tablet, null where it is unknown.

      • visits
        object
        required

        Visits (a visit's first page), scaled back from sampling.

        • current
          number
          required
        • previous
          required

          One of the following:

          • number
          • null
      • estimated
        boolean
        required

        Counted from sampled data, so the figures are estimates.

      • device
        required

        One of the following:

        • string
        • 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