Skip to content
Navigation

Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.

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

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

  • customer
    optional
    string

    An id.

    minLength: 1
  • filter
    optional
    object

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

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

Returns

200

Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.

JSON
  • items
    array of
    object
    required
    • customer
      required

      One of the following:

      • object
      • null
    • id
      string
      required
    • customer_id
      string
      required
    • product_id
      string
      required
    • product
      required

      One of the following:

      • object
      • null
    • readers
      number
      required

      Readers it served in the last 30 days, each shared fetcher for the people it reports.

    • reader_limit
      number
      required

      Readers it serves in 30 days before it moves to a new URL.

    • reader_limit_set
      boolean
      required

      Whether the limit is the merchant's own rather than the default.

    • created_at
      required

      One of the following:

      • string
      • null
    • revoked_at
      required

      One of the following:

      • string
      • null
    • revoked_reason
      required

      Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.

      One of the following:

      • string
      • null
  • 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