Fetch offers
Changed onThis endpoint lets you list all your offers that meet the requirements given in the API request. For example, it allows you to filter offers by offer type or offer status.
Additional response header: x-total-count. It will show the number of offers.
Request
- Base URLhttps://mediastoreapi-sandbox.cleeng.com
- URLhttps://mediastoreapi-sandbox.cleeng.com/offers
- AuthAPI key in header Authorization
Query parameters
Pagination parameter. It indicates the page number. By default, this parameter is equal to 1.
Pagination parameter. It indicates the number of items on a page. By default, 15 results per page are returned.
A search key. The endpoint should search by title and offerId (including the main offer and offer localizations).
Filters results by offer type (possible values: subscription, pass, vod, live).
Filters results by offer status (active, inactive, all). By default all offers are listed.
Filters results by one of the allowed values: amazon, android, apple, roku, samsung, vizio. This parameter must be used together with the appStoreProductId. It cannot be used alone.
Filters results by App store product id. This parameter must be used together with the appStoreName. It cannot be used alone.
Filters results based on offer externalProperties field that can be configured during offer creation in the Cleeng Dashboard (Custom parameters). The required format is an object with key and value. The object needs to be parsed to string and then encoded. To do that use encodeURI function.
Response
200
Changes
- info
api operation id
list-offersremoved and replaced withfetch-offers - info
added the new optional
queryrequest parameterfilter - info
added the non-success response with the status
- info
added the non-success response with the status
- info