Skip to content
Navigation

Pages a portfolio's events.

GET
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/portfolio/events

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • preview
    optional
    string

    A token a seller made for the product's page or one of its entries, which opens an unpublished product's portfolio, gated as ever.

    maxLength: 128 · minLength: 1
  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    occurred
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1

Returns

200

Pages a portfolio's events.

JSON
  • items
    array of
    object
    required
    • id
      string
      required
    • symbol
      required

      One of the following:

      • string
      • null
    • type
      string
      required
    • shares
      required

      One of the following:

      • number
      • null
    • price
      required

      One of the following:

      • number
      • null
    • amount
      required

      One of the following:

      • number
      • null
    • note
      required

      One of the following:

      • string
      • null
    • effective_date
      required

      One of the following:

      • string
      • null
    • symbol_type
      required

      One of the following:

      • string
      • null
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • price_currency
      string
      required
    • price_exponent
      required

      One of the following:

      • number
      • null
    • allocation
      required

      One of the following:

      • number
      • null
    • allocation_change
      required

      One of the following:

      • number
      • null
    • ratio
      required

      One of the following:

      • object
      • null
    • split_kind
      required

      How a split moved the shares, which its ratio alone cannot tell apart; null for any other event.

      One of the following:

      • string
      • null
    • files
      required

      One of the following:

      • array<object>
      • null
    • occurred_at
      required

      One of the following:

      • string
      • null
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
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