API call: Available Offers Details

This API Call returns the full details of an offer that is available for you to request it.
In addition to the apikey, you need to include the id of the offer to the url.
Url: http://dashboard.minimob.com/api/availableoffers/?apikey=your_api_key&id=an_available_offer_id
HTTP method: GET
Returns: json object
The 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
• description: [string] A detailed description of the offer
• 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
• appIconLink: [string] a url which points to the icon of the application through which the offer is promoted
• appTitle: [string] the title of the application
• appId: [string] the application ID (as registered to the app store)
• appDescription: [string] A detailed description of the application
• appPreviewLink: [string] A link directing to the application page in the app store
• expirationDate: [string] Specifies the date until which the offer can be promoted
• 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
• creatives: Contains the creatives that are associated with the offer. For each creative, the following are returned:
– Id: [string] the unique id of the creative
– previewUrl: [string] the url where you can preview the creative
– mimeType: [string] the mime type of the creative
– dimensions: [string] the dimensions of the creative
– locale: [string] the locales supported by the creative

 

Powered by Zendesk