Skip to content
Navigation

Counts an event's attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Returns

200

Counts an event's attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.

JSON
  • going
    number
    required
  • pending
    number
    required

    Who waits for the seller's approval.

  • waitlisted
    number
    required

    Who waits on the waitlist for a seat.

  • canceled
    number
    required
  • canceled_by_reason
    object
    required
    • expired
      number
      required
    • revoked
      number
      required
    • refunded
      number
      required
    • canceled
      number
      required
    • declined
      number
      required
  • going_by_tier
    array of
    object
    required

    Who is going per tier, highest first; a null tier is access with no tier.

    • tier
      required

      One of the following:

      • object
      • null
    • going
      number
      required
  • checked_in_by_session
    array of
    object
    required

    How many were let in at each session that let anyone in.

    • session_id
      string
      required
    • checked_in
      number
      required
  • capacity
    required

    The event's own capacity; null when it sets none, or stores one no write could make.

    One of the following:

    • number
    • null
  • remaining
    required

    The seats left to sell, as checkout counts them (a grant takes none), held to each ticket type's capacity too; null unless the event is capped, or at least one ticket type is on sale and every one is; none once it is canceled.

    One of the following:

    • number
    • null
  • held_by_requests
    integer
    required

    Of the seats taken, those requests waiting for approval hold.

    minimum: 0
  • subscriptions
    integer
    required

    Subscriptions to the event still running, which a cancellation stops billing.

    minimum: 0
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