Path parameters

• offerId string Required

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • data object
    Hide data attributes Show data attributes object

    • offer_id string Required
    • anchor string Required

      Offer title to display to users.

    • description string Required

      Description to display to the user.

    • requirements string Required

      What the user should do to complete an offer.

    • icon_url string Required

      Square image to display to the user.

    • contact_url string Required

      Link to the contact page.

    • things_to_know array[string] Required
    • started_at string(date-time) Required
    • disclaimer string Required
    • events array[object] Required
      Hide events attributes Show events attributes object

      • uuid string Required

        ID of the event

      • name string Required

        Event name to display to the user

      • approved_conversions integer Required

        How many approved (payable) conversions there are.

      • approved_cpa string Required

        How much approved (payable) cpa there is.

      • pending_conversions integer Required

        How many conversions are pending.

      • pending_cpa string Required

        How much cpa is pending.

      • status string Required

        Values are viewed, pending, completed, or cancelled.

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

      • timestamp string(date-time) Required

        ID of the event

      • pending_reason string Required Deprecated

        Explains, in text, why the event is in 'pending' status. Deprecated; will always be be empty string.

      • display_type string Required

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

        Values are none, up_to, or commission.

      • promised_points string Required

        The number of points the user will be rewarded upon completion. Will be 0 if the event is not payable.

      • promised_commission_amount string

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

      • time_played object

        Time played event details (if applicable).

        Hide time_played attributes Show time_played attributes object

        • id integer Required
        • goal_unit string Required
        • goal_unit_count integer Required
      • offer_expires_at string(date-time)

        If there is a time limit for this event, this contains the unix timestamp when the event expires.

      • minutes_left number(float)
      • 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

      • promotional_points string

        Points if there is an ongoing promotion

    • hours_left integer

      Number of hours left to complete the offer.

    • is_game boolean Required

      Boolean. Indicates if the offer is a game.

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

    • categories array[string] Required

      An array of the category names that the offer belongs to

    • confirmation_time string Required

      Text that described how long it takes to receive credit

    • latest_date string(date-time) Required

      Date of the latest click or conversions.

    • continue_url string Required

      URL to redirect the user to

    • points string Required

      Total points earned by the user for this offer. This does not include any points that are pending.

    • completed_events integer Required
    • completed boolean Required
    • has_pending_conversions boolean Required
    • total_points string Required

      Total points the user may earn

    • total_promotional_points 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.

    • total_approved_points string Required

      Total points the user has earned and have been approved.

    • total_pending_points string Required

      Total points the user has earned and are pending approval.

    • total_cancelled_points string Required

      Total points the user has earned and have been cancelled.

    • total_events integer Required

      Total number of events that the user has completed for this offer.

    • total_approved_events integer Required

      Total number of events that the user has completed and have been approved.

    • total_pending_events integer Required

      Total number of events that the user has completed and are pending approval.

    • total_cancelled_events integer Required

      Total number of events that the user has completed and have been cancelled.

    • tx_id string Required

      The primary transaction ID, or click ID, associated with this offer.

    • next_event string

      Id of the next event

    • next_payable_event string

      Id of the next payable event

• 406 application/json

  VPN detected

  Hide response attribute Show response attribute object

  • data object