Headers

• User-Agent string Required

  The user agent string of the user's device.

Query parameters

• devices array[string]

  An array that any combination of iphone, ipad, or android. Provide an empty array to clear existing devices.

  Values are iphone, ipad, or android.

• in_app boolean | null

  If true, only offers that follow App Store and Play Store guidelines are returned. If not set, it falls back to the app setting.

• client_user_agent string

  The user agent string of the user's device.

• client_ip string

  The IP address of the user's device.

• tags string(URL-encoded query)

  Optional set of key-value pairs to be passed back in callbacks. Max 10 pairs with both key and value up to 50 characters long. Keys and values are trimmed and lower-cased. Keys can only contain alphanumeric characters and underscores. Values can contain any characters. If you need to pass sensitive information, note that users can potentially manipulate this data.

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • data object
    Hide data attributes Show data attributes object

    • offers array[object] Required
      Hide offers attributes Show offers attributes object

      • id integer(int64) Required
      • anchor string Required

        Offer title to display to users

      • description string Required

        Enter to win a Playstation 5!

      • requirements string Required

        What the user should do to complete an offer

      • confirmation_time string Required

        Text that described how long it takes to receive credit

      • click_url string Required

        URL to redirect the user to

      • support_url string Required

        The URL the user can access to get support in case they are not rewarded

      • icon_url string Required

        Square icon URL

      • categories array[string] Required

        An array of offer categories

      • total_points string Required

        Total points the user may earn

      • total_points_promotional string

        If a promotion is currently in progress, the amount of points they will earn. If not null, this should be used instead of total_points.

      • is_sticky boolean Required

        If an offer should be pinned to the top of the offer wall

      • events array[object] Required

        An array of events the user may complete to earn points. Each event is an object.

        Hide events attributes Show events attributes object

        • uuid string Required

          ID of the event

        • name string Required

          Event name to display to the user

        • type string Required

          Flat events have static point values. Dynamic events will have varying payouts.

          Values are flat or dynamic.

        • payable boolean Required

          Whether the event pays anything to the user

        • display_type string Required

          This determines how the potential points are displayed. "none": no special logic. User receives {points}. "up_to": display "Up to {points}". "commission": display "{points} per ${commission_amount}

          Values are none, up_to, or commission.

        • points string Required

          Will be 0 if the event is not payable.

        • promotional_points string

          Points if there is an ongoing promotion. If not null, this should be used instead of points.

        • commission_amount string

          For "commission", the points amount to use in the phrase above.

        • payout string

          The dollar amount.

        • status string Required

          Values are viewed, pending, completed, or canceled.

        • type_id integer(int64) Required

          ID used to identify the event type. The following values are possible: 0: Not specified 1: Install 2: Event 3: In-app purchase 4: Time played event

      • app_metadata object Required
        Hide app_metadata attributes Show app_metadata attributes object

        • app_id string

          The app ID

        • categories array[string] Required

          The categories the app belongs to

        • screenshot_urls array[string] Required

          URLs to screenshots of the app

        • video_urls array[string] Required

          URLs to videos of the app

      • is_game boolean Required

        Indicates if the offer is a game. If true, the offer is a game. If false, the offer is not a game.

      • stats object Required
        Hide stats attributes Show stats attributes object

        • tool_cpm string

          The tool CPM for this offer

        • network_cpm string

          The network CPM for this network

      • disclaimer string Required

        A disclaimer that should be shown to the user before they start the offer.

      • pending_time integer Required

        Time in minutes that a reward will be held from the user completion

      • web_to_mobile boolean Required

        Whether this offer must be accessed on the user's mobile device.

      • web_to_mobile_devices array[string] Required

        Array of devices the users must access the user on. The list of applicable devices is taken from the devices stored for that particular user

      • epc string

        Network-wide EPCs

      • session_hours integer Required

        Offer is valid for that many hours

      • offer_expires_at string(date-time)

        Offer expiration timestamp

      • product_id string Required

        A unique string shared between offers which belong to same product, e.g. same mobile app.

      • product_name string Required

        The offer's product name.

    • started_offers array[object] Required
      Hide started_offers attributes Show started_offers attributes object

      • id integer(int64) Required
      • anchor string Required

        Offer title to display to users

      • description string Required

        Enter to win a Playstation 5!

      • requirements string Required

        What the user should do to complete an offer

      • confirmation_time string Required

        Text that described how long it takes to receive credit

      • support_url string Required

        The URL the user can access to get support in case they are not rewarded

      • icon_url string Required

        Square icon URL

      • categories array[string] Required
      • total_points string Required

        Total points the user may earn

      • total_points_promotional string

        If a promotion is currently in progress, the amount of points they will earn. If not null, this should be used instead of total_points.

      • events array[object] Required

        An array of events the user may complete to earn points. Each event is an object.

        Hide events attributes Show events attributes object

        • uuid string Required

          ID of the event

        • name string Required

          Event name to display to the user

        • type string Required

          Flat events have static point values. Dynamic events will have varying payouts.

          Values are flat or dynamic.

        • payable boolean Required

          Whether the event pays anything to the user

        • display_type string Required

          This determines how the potential points are displayed. "none": no special logic. User receives {points}. "up_to": display "Up to {points}". "commission": display "{points} per ${commission_amount}

          Values are none, up_to, or commission.

        • points string Required

          Will be 0 if the event is not payable.

        • promotional_points string

          Points if there is an ongoing promotion. If not null, this should be used instead of points.

        • commission_amount string

          For "commission", the points amount to use in the phrase above.

        • payout string

          The dollar amount.

        • status string Required

          Values are viewed, pending, completed, or canceled.

        • type_id integer(int64) Required

          ID used to identify the event type. The following values are possible: 0: Not specified 1: Install 2: Event 3: In-app purchase 4: Time played event

      • latest_date string(date-time) Required

        Date of the latest click or conversions.

      • points string Required

        Will be 0 if the event is not payable.

      • completed_events integer Required
      • completed boolean Required
      • has_pending_conversions boolean Required
      • disclaimer string Required
      • app_metadata object Required
        Hide app_metadata attributes Show app_metadata attributes object

        • app_id string

          The app ID

        • categories array[string] Required

          The categories the app belongs to

        • screenshot_urls array[string] Required

          URLs to screenshots of the app

        • video_urls array[string] Required

          URLs to videos of the app

      • hours_left integer Required

        Number of hours left for the offer to be completed

    • offerwall_code string Required