Skip to content
Navigation

Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/licenses/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 software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.

JSON
  • issued
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • imported
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • verifies
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • uses
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • active_license_days
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • activations
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • deactivations
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • refusals
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • series
    array of
    object
    required
    • previous_verifies
      number
      required
    • previous_active_license_days
      number
      required
    • previous_activations
      number
      required
    • issued
      number
      required

      Licenses the store minted.

    • imported
      number
      required

      Licenses recorded from another platform.

    • verifies
      number
      required

      Checks from the seller's server.

    • uses
      number
      required

      Checks that counted a use.

    • active_license_days
      number
      required

      Each license that checked in while active, once a day, summed over the days.

    • activations
      number
      required

      Devices that began counting, new or come back.

    • deactivations
      number
      required

      Devices freed by their holder, the merchant, the software, or a new key.

    • refusals
      number
      required

      Activations refused at the limit.

    • start
      string
      required
    • end
      string
      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