Skip to content
Navigation

Reads the calls customers' apps made to the store over the API and MCP over a period, by channel and client.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/calls/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 calls customers' apps made to the store over the API and MCP over a period, by channel and client.

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
  • calls
    object
    required
    • current
      number
      required
    • previous
      required

      One of the following:

      • number
      • null
  • estimated
    boolean
    required

    Counted from sampled data, so the figures are estimates.

  • by_channel
    array of
    object
    required

    By the channel: api or mcp.

    • calls
      object
      required
      • 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_client
    object
    required

    The clients with the most calls in the range, and how many called at all.

    • total
      number
      required
    • clients
      array of
      object
      required
      • calls
        object
        required
        • current
          number
          required
        • previous
          required

          One of the following:

          • number
          • null
      • estimated
        boolean
        required

        Counted from sampled data, so the figures are estimates.

      • client
        object
        required
        • id
          string
          required
        • name
          required

          One of the following:

          • string
          • null
      • channel
        string
        required
  • unattributed
    object
    required

    Calls through no client, such as a customer's own token.

    • calls
      object
      required
      • current
        number
        required
      • previous
        required

        One of the following:

        • number
        • null
    • estimated
      boolean
      required

      Counted from sampled data, so the figures are estimates.

  • series
    array of
    object
    required
    • start
      string
      required
    • end
      string
      required
    • calls
      number
      required
    • previous_calls
      required

      One of the following:

      • number
      • null
    • estimated
      boolean
      required

      Counted from sampled data, so the figures are estimates.

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