Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data UserHistoryOfferDetails
      Hide data attributes Show data attributes
      • 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.

      • things_to_know array[string] Required
      • disclaimer string Required
      • icon_url string Required

        Square image to display to the user.

      • started_at string(date-time) Required
      • events array[object] Required
        Hide events attributes Show events attributes UserHistoryOfferDetailsEvent
        • 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

          Explains, in text, why the event is in 'pending' status.

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

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

  • 406 application/json

    VPN detected

    Hide response attribute Show response attribute object
GET /v1/client/user/history/offers/{offerId}
curl \
 -X GET https://api.bitlabs.ai/v1/client/user/history/offers/{offerId} \
 -H "X-Api-Token: $API_KEY" \
 -H "X-User-Id: $API_KEY"
Response examples (200)
{
  "data": {
    "offer_id": "string",
    "anchor": "Playstation 5",
    "description": "Enter to win a Playstation 5!",
    "requirements": "Sign up with valid information and complete the full survey.",
    "things_to_know": [
      "string"
    ],
    "disclaimer": "string",
    "icon_url": "https://main-p.agmcdn.com/offers/1564507470875.gif",
    "started_at": "2022-01-01T00:00:00Z",
    "events": [
      {
        "uuid": "0dc43f54-135a-46a4-a51c-a2c5f3cfdac0",
        "name": "Completed",
        "approved_conversions": 42,
        "approved_cpa": "string",
        "pending_conversions": 42,
        "pending_cpa": "string",
        "status": "viewed",
        "type": "flat",
        "payable": true,
        "timestamp": "2022-01-01T00:00:00Z",
        "pending_reason": "string",
        "display_type": "none",
        "promised_points": "string",
        "promised_commission_amount": "string"
      }
    ]
  }
}
Response examples (406)
{
  "error": {
    "details": {
      "http": "406 Not Acceptable",
      "msg": "vpn detected"
    }
  }
}