Skip to content
Navigation

Reads the store's customer stats over a period.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/customers/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 customer stats over a period.

JSON
  • customers
    object
    required
    • total
      number
      required
    • erased
      number
      required
  • new_customers
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • returning
    object
    required
    • current
      object
      required
      • customers
        number
        required
      • ordered
        number
        required
    • previous
      object
      required
      • customers
        number
        required
      • ordered
        number
        required
  • spent
    array of
    object
    required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • amount
      required

      One of the following:

      • object
      • null
    • gross
      required

      One of the following:

      • object
      • null
    • refunded
      required

      One of the following:

      • object
      • null
  • all_time
    object
    required
    • orders
      number
      required
    • returning
      number
      required
    • spent
      array of
      object
      required
      • currency
        string
        required
      • exponent
        required

        One of the following:

        • number
        • null
      • orders
        number
        required
      • amount
        required

        One of the following:

        • number
        • null
      • gross
        required

        One of the following:

        • number
        • null
      • refunded
        required

        One of the following:

        • number
        • null
      • average
        required

        One of the following:

        • number
        • null
  • by_country
    array of
    object
    required
    • orders
      number
      required
    • currencies
      array of
      object
      required
      • currency
        string
        required
      • exponent
        required

        One of the following:

        • number
        • null
      • orders
        number
        required
      • sales
        required

        One of the following:

        • number
        • null
      • average
        required

        One of the following:

        • number
        • null
    • country
      required

      One of the following:

      • string
      • null
    • customers
      number
      required
  • series
    array of
    object
    required
    • start
      string
      required
    • end
      string
      required
    • customers
      number
      required
    • previous_customers
      number
      required
  • bucket
    string
    required
  • time_zone
    string
    required
  • from
    string
    required
  • to
    string
    required
  • previous_range
    object
    required
    • from
      string
      required
    • to
      string
      required
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