Motive Feed Integration Documentation (Version 4)

This version is deprecated, please upgrade to version 5. We will not be supporting this version anymore.


Two Easy Steps:

  1. Get your unique API Key and Affiliate ID (see below).

  2. Fill out the parameters of our URL with the afformentioned items and optional parameters.


Obtaining your API Key and Affiliate ID:

  1. Go to: http://affiliates.motiveinteractive.com/
  2. Click on the "Reporting API" button near the top.
  3. Copy the information highlighted in red, you need to use that to build your request URL.

URL:

http://motivefeed.com/affiliate/4/campaigns?api_key=[API_KEY]&affiliate_id=[AFFILIATE_ID]&creatives=[TRUE/FALSE]&d[]=[WIDTH]x[HEIGHT]&creative_limit=[INTEGER]&vertical_id=[VERTICAL_ID]&tag_id=[TAG_ID]&payout_at_least=[INTEGER]&payout_at_most=[INTEGER]&incent_id=[INTEGER]


Parameter Summary:

api_key / STRING (required)= Affiliate API Key

affiliate_id / INT (required)= Affiliate ID

creatives / BOOL (optional)= TRUE/FALSE

d[] / ARRAY (optional)= Dimension of creatives in this format (WIDTHxHEIGHT). Can have multiple. ( Eg. d[]=300x250&d[]=320x480 )

creatives_limit / INT (optional)= Limit the amount of creatives returned per campaign. Default limit is 50.

vertical_id / INT (optional)= Vertical ID see here for a list of avaliable verticals

tag_id / INT (optional)= Tag ID see here for a list of avaliable tags

incent_id / INT (optional)= Incent ID see here for a list. Return all, non-incent, or incent-only campaigns. Default shows all campaigns.

payout_at_least / INT (optional)= Return campaigns with payout equal to or greater than this value.

payout_at_most / INT (optional)= Return campaigns with payout equal to or less than this value.


Sample GET Call:

XML: http://motivefeed.com/affiliate/4/campaigns?api_key=[API_KEY]&affiliate_id=[AFFILIATE_ID]&creatives=[TRUE/FALSE]&d[]=[WIDTH]x[HEIGHT]&creative_limit=[INTEGER]&vertical_id=[VERTICAL_ID]&tag_id=[TAG_ID]&payout_at_least=[INTEGER]&payout_at_most=[INTEGER]&incent_id=[INTEGER]

OR

JSON: http://motivefeed.com/affiliate/4/campaigns?api_key=[API_KEY]&affiliate_id=[AFFILIATE_ID]&creatives=[TRUE/FALSE]&d[]=[WIDTH]x[HEIGHT]&creative_limit=[INTEGER]&vertical_id=[VERTICAL_ID]&tag_id=[TAG_ID]&payout_at_least=[INTEGER]&payout_at_most=[INTEGER&incent_id=[INTEGER]&format=json


Request interval:

Our feed updates once every hour, so our recommendation is to have a max interval pull of once per hour and a minimum of at least once a day to ensure the data is synchronized between your application and our server.


Response Type:

success - STRING: Request success status

totals_rows - INT: Total number of rows


campaigns > campaign:

campaign_id - INT: Campaign ID

offer_id - INT: Offer ID

offer_name - STRING: Offer Name

offer_contract_id - INT: Offer Contract ID

vertical_name - STRING: Vertical Name

vertical_id - STRING: Vertical ID

tracking_link - STRING: Tracking link URL

payout - STRING: Payout amount in string format with $ in front of the number

> tags: See available tags

> tag:

tag_id - INT: Tag ID

tag_name - STRING: Tag name

> allowed_media_types > media_type > item:

type_id - INT: Media type ID

type_name - STRING: Media type name

category_id - INT: Media category ID

type_name - STRING: Media category name

> creatives:

> creatives:

creative_id - INT: Creative ID

creative_name - STRING: Creative name

creative_type_id - INT: Creative type ID

creative_type - STRING: Creative type name

creative_status_id - INT: Creative status ID

creative_status - STRING: Creative status name

width - INT: Width

height - INT: Height

creative_file_id - INT: Creative file ID

creative_file_name - STRING: Creative file name

creative_file_link - STRING: Creative file link

date_created - DATETIME: date created

> app_details:

app_id - STRING: Apple App Store/Google Play Store App ID

developer - STRING: App developer name/company

rating - FLOAT: App rating in decimal, rating is on a scale from 0 - 5

content - STRING: App description

maturity_rating - STRING: App Maturity rating. Varies iOS/Android

number_of_reviews - INT: Number of reviews

min_OS_version - STRING: App Minimum OS Requirement. Varies iOS/Android

downloads - STRING: Number of downloads (Only available for Google Play Store apps)

file_size - STRING: File size in MB

> app_icons:

app_icon_small - STRING: Small icon image link

app_icon_large - STRING: Large icon image link

app_icon_60x60 - STRING: 60x60 icon image link

app_icon_100x100 - STRING: 100x100 icon image link

app_icon_200x200 - STRING: 200x200 icon image link

> allowed_countries:

allowed_country - STRING: Two letter country code in uppercase

> allowed_devices:

allowed_device - STRING: Allowed device name in lowercase


Sample XML Response:
                

        <xml>
            <success>true</success>
            <total_rows>1</total_rows>
            <campaigns>
                <campaign>
                <campaign_id>228490</campaign_id>
                <offer_id>54292</offer_id>
                <offer_name>Feed Offer Test - US Traffic (default)</offer_name>
                <offer_contract_id>7138</offer_contract_id>
                <vertical_name>Mobile Android</vertical_name>
                <vertical_id>49</vertical_id>
                <tracking_link>https://traktum.com/?a=66269&c=328882&s2=&s3=&s4=&s5=[insert_AID]</tracking_link>
                <payout>$0.01</payout>
                <tags>
                    <tag>
                        <tag_id>760</tag_id>
                        <tag_name>Device ID Required</tag_name>
                    </tag>
                    <tag>
                        <tag_id>868</tag_id>
                        <tag_name>Device ID Allowed: Google AID</tag_name>
                    </tag>
                </tags>
                <allowed_media_types/>
                <creatives>
                    <creative>
                        <creative_id>293804</creative_id>
                        <creative_name>320x250-1</creative_name>
                        <creative_type_id>3</creative_type_id>
                        <creative_type>Image</creative_type>
                        <creative_status_id>1</creative_status_id>
                        <creative_status>Active</creative_status>
                        <width>320</width>
                        <height>250</height>
                        <creative_file_id>214318</creative_file_id>
                        <creative_file_name>320x250-1.jpg</creative_file_name>
                        <date_created>2014-02-05 11:39:37</date_created>
                        <creative_file_link>
                            http://cdn.motivefeed.com/uploads/54292/320x250-1.jpg
                        </creative_file_link>
                    </creative>
                    <creative>
                        <creative_id>293803</creative_id>
                        <creative_name>320x50-mobilebanner</creative_name>
                        <creative_type_id>3</creative_type_id>
                        <creative_type>Image</creative_type>
                        <creative_status_id>1</creative_status_id>
                        <creative_status>Active</creative_status>
                        <width>320</width>
                        <height>50</height>
                        <creative_file_id>214317</creative_file_id>
                        <creative_file_name>320x50-mobilebanner.jpg</creative_file_name>
                        <date_created>2014-02-05 11:39:36</date_created>
                        <creative_file_link>
                            http://cdn.motivefeed.com/uploads/54292/320x50-mobilebanner.jpg
                        </creative_file_link>
                    </creative>
                </creatives>
                <app_details>
                    <app_id>com.android.chrome</app_id>
                    <app_icons>
                        <app_icon_small>
                            https://lh6.ggpht.com/lum4KYB0TtgvR-8vRMUZ_JhRnMQ4YqBIR0yjspc4ETsM9iJ8-4YHZ0s0HO9i0ez_=w57
                        </app_icon_small>
                        <app_icon_large>
                            https://lh6.ggpht.com/lum4KYB0TtgvR-8vRMUZ_JhRnMQ4YqBIR0yjspc4ETsM9iJ8-4YHZ0s0HO9i0ez_=w300
                        </app_icon_large>
                        <app_icon_60x60>
                            https://lh6.ggpht.com/lum4KYB0TtgvR-8vRMUZ_JhRnMQ4YqBIR0yjspc4ETsM9iJ8-4YHZ0s0HO9i0ez_=w60
                        </app_icon_60x60>
                        <app_icon_100x100>
                            https://lh6.ggpht.com/lum4KYB0TtgvR-8vRMUZ_JhRnMQ4YqBIR0yjspc4ETsM9iJ8-4YHZ0s0HO9i0ez_=w100
                        </app_icon_100x100>
                        <app_icon_200x200>
                            https://lh6.ggpht.com/lum4KYB0TtgvR-8vRMUZ_JhRnMQ4YqBIR0yjspc4ETsM9iJ8-4YHZ0s0HO9i0ez_=w200
                        </app_icon_200x200>
                    </app_icons>
                    <developer>Google Inc.</developer>
                    <rating>4.2</rating>
                    <title>Chrome Browser - Google</title>
                    <content/>
                    <maturity_rating>Low Maturity</maturity_rating>
                    <number_of_reviews>969710</number_of_reviews>
                    <min_OS_version>2.2 and up</min_OS_version>
                    <downloads>100,000,000 - 500,000,000</downloads>
                    <filesize>Varies with device</filesize>
                    <app_store_url>
                        https://play.google.com/store/apps/details?id=com.android.chrome
                    </app_store_url>
                </app_details>
                <allowed_devices>
                    <allowed_device>android</allowed_device>
                </allowed_devices>
                <allowed_countries>
                    <allowed_country>US</allowed_country>
                </allowed_countries>
                </campaign>
            </campaigns>
        </xml>  
                
                

© Motive Feed