API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE

Fetch offers

get
https://mediastoreapi-sandbox.cleeng.com/offers

This 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Pagination parameter. It indicates the page number. By default, this parameter is equal to 1.

string

Pagination parameter. It indicates the number of items on a page. By default, 15 results per page are returned.

string

A search key. The endpoint should search by title and offerId (including the main offer and offer localizations).

type[]
array of strings

Filters results by offer type (possible values: subscription, pass, vod, live).

type[]
string

Filters results by offer status (active, inactive, all). By default all offers are listed.

string

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.

string

Filters results by App store product id. This parameter must be used together with the appStoreName. It cannot be used alone.

string

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.

Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago