GEgetstream
product:chat

Get retention policy runs

Changed on

Returns filtered and sorted retention cleanup run history for the app. Supports filter_conditions on 'policy' (possible values: 'old-messages', 'inactive-channels') and 'date' fields. Server-side only.

post/retention_policy/runs

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/retention_policy/runs
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

filter_conditionsobject

Filter conditions to apply to the query

limitinteger
nextstring
prevstring

Response

Response

durationstring required

Duration of the request in milliseconds

nextstring
prevstring

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • a850089bc5ddRevision changes
    • info

      added the optional property /// to the response with the status