Skip to content
Navigation

Pages a portfolio's daily snapshots.

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

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
    date
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 400 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages a portfolio's daily snapshots.

JSON
  • items
    array of
    object
    required
    • date
      string
      required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • value
      required

      One of the following:

      • number
      • null
    • cash
      required

      One of the following:

      • number
      • null
    • positions
      required

      One of the following:

      • number
      • null
    • twr
      required

      One of the following:

      • number
      • null
    • benchmark
      required

      One of the following:

      • number
      • null
    • benchmarks
      object
      required
      • sp500
        required

        One of the following:

        • number
        • null
      • nasdaq
        required

        One of the following:

        • number
        • null
      • acwi
        required

        One of the following:

        • number
        • null
      • gold
        required

        One of the following:

        • number
        • null
    • state
      string
      required
  • cursor
    required

    One of the following:

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