Skip to content
Navigation

Pages a software product's releases and notes, newest first.

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

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

  • 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 software product's releases and notes, newest first.

JSON
  • items
    array of
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • type
      string
      required

      release or note.

    • version
      required

      A release's version; null for a note.

      One of the following:

      • string
      • null
    • body
      required

      The release notes or the note, as plain text.

      One of the following:

      • string
      • null
    • current
      boolean
      required

      Whether it is the product's current download: its newest release that ships files.

    • files
      array of
      object
      required
      • attachment_id
        string
        required
      • asset_id
        string
        required
      • tier
        required

        The lowest tier that downloads the file, by its own gate; null for every tier.

        One of the following:

        • object
        • null
      • name
        string
        required
      • ext
        required

        One of the following:

        • string
        • null
      • mime
        required

        One of the following:

        • string
        • null
      • bytes
        number
        required
      • description
        required

        The file's description, as its download shows it to holders; null for none.

        One of the following:

        • string
        • null
    • tier
      required

      The lowest tier whose holders download its files, while every file is gated to it; null for every tier.

      One of the following:

      • object
      • null
    • push
      string
      required

      Its push: none never asked, pending owed, sent to its holders, or dropped for good (its files failed, or a newer release came first).

    • push_reason
      required

      Why a dropped push was dropped: superseded, files (failed or never finished), removed (they left the release), unavailable (the product wasn't open) or failed; null otherwise.

      One of the following:

      • string
      • null
    • notified
      number
      required

      How many holders its push reached so far.

    • occurred_at
      required

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

      • string
      • null
    • updated_at
      required

      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