API call: Available Offers

This API Call returns summarized information about all the offers that are available in minimob.
Url: http://dashboard.minimob.com/api/availableoffers/?apikey=your_api_key
HTTP method: GET
Returns: json array of objects [{},{}….{}]
Each JSON object contains the following properties:
• id: [string] the offer's id that is unique across the minimob platform
• name: [string] the name of the offer
• targetedCountries: [string] the list of countries in which the offer can be served (country codes as per ISO 3166-1 alpha-2)
• payout: [double] the monetary compensation per each goal achieved as defined by the payout model
• payoutCurrency: [string] the currency of the payout (currency codes as per ISO 4217)
• payoutModel: [string] the model on which the payout is based (currently CPI only is supported)
• targetPlatform: [string] the mobile operating system that is targeted
• overallConversionCap: [nullable int] the conversion cap for the entire lifetime of the offer
• dailyConversionCap: [nullable int] the conversion cap per day
• weeklyConversionCap: [nullable int] the conversion cap per week
• monthlyConversionCap: [nullable int] the conversion cap per month
• status: [enum] indicates the status of the offer. It can have one of the following values:
– 0: The offer is Available for you to request it
– 1: Your request for this offer is Pending
• incentivized: indicates whether the offer is allowed to run on incentivized traffic or not. It can have one of the following values:
– 0: Both Incentivized traffic and Non-Incentivized traffic are allowed
– 1: Incentivized traffic only
– 2: Non-Incentivized traffic only
– 3: Uncertain (the offer is allowed to run on both Incentivized traffic and Non-Incentivized traffic)
• incentivizedDescription: [string] a textual description regarding whether the offer is Incentivized
• storeId: [string] indicates the store through which the application is distributed. It can have one of the following values:
– 1: corresponds to Google Play
– 2: corresponds to Apple iTunes
– 3: corresponds to minimob Store
• storeName: [string] the name of the store through which the application is distributed

 

Powered by Zendesk