BitLabs API

Get user history

GET /v1/client/user/history

Header api token & Header user Query api token & Query user

Get User History returns a sorted list of events where the first element is the most recent. It contains up to
four different types of events: OPEN, LEAVE, SCREENOUT, COMPLETE.

Events in this response are unique per survey so if a survey was completed, only the complete event is returned
and not the corresponding opening. Only non open events contain a duration property. Only screenout and complete
events contain a user value property.

Query parameters

filter array[string]

optionally filter by type

Values are surveys, offers, or others.

Responses

• 200 object

OK
- data array[object]
  
  One of:
  UserHistoryEntrySurvey array[object] UserHistoryEntryOfferV2 array[object] UserHistoryEntryLeaderboard array[object] UserHistoryEntrySurveySupport array[object]
  
  type string Required
  
  Values are OPEN, LEAVE, SCREENOUT, or COMPLETE.
  
  survey_id integer(int64) Required
  
  details object Required
  
  category object Required
  
  name string Required
  
  Localized category name
  
  icon_url string Required
  
  If not empty: url to an icon for the cateogry.
  
  name_internal string Required
  
  Internal, unlocalized, machine-friendly name of the category
  
  network object Required
  
  name string Required
  
  Displayable name of the network the survey came from
  
  icon_url string Required
  
  If not empty: url to an icon for the network.
  
  user_value string Required
  
  rating integer Required
  
  created_at string Required
  
  duration string Required
  
  reconciled boolean Required
  
  callback_delay_seconds integer
  
  Optional delay in seconds after which the callback will be sent, if not reconciled until that point.
  
  offer_id string Required
  
  anchor string Required
  
  The title of the offer as it is displayed to the user.
  
  icon_url string Required
  
  Square image to display to the user.
  
  latest_date string(date-time) Required
  
  Date of the latest click or conversions.
  
  cpa string Required
  
  completed_events integer Required
  
  Total number of events that the user has completed for this offer.
  
  contact_url string Required
  
  Link to the contact page
  
  has_details boolean Required
  
  If true, user history offer details endpoint can be called for additional information.
  
  state string Required
  
  Values are opened, completed, pending, or reconciled.
  
  state string Required
  
  The state of the request.
  
  Values are pending, rejected, or credited.
  
  created_at string Required
  
  The date the request is created.
  
  amount string Required
  
  The amount of the request in USD.
• 406 object

VPN detected
- data object
- error object
  details object
  
  http string Required
  
  msg string Required
- status string Required
  
  Values are success or error.
- trace_id string Required

GET /v1/client/user/history

curl \
 -X GET https://api.bitlabs.ai/v1/client/user/history \
 -H "X-Api-Token: $API_KEY" \
 -H "X-User-Id: $API_KEY"

Response example (200)

{
  "data": [
    {
      "type": "OPEN",
      "survey_id": 42,
      "details": {
        "category": {
          "name": "string",
          "icon_url": "string",
          "name_internal": "string"
        },
        "network": {
          "name": "string",
          "icon_url": "string"
        }
      },
      "user_value": "string",
      "rating": 42,
      "created_at": "string",
      "duration": "string",
      "reconciled": true,
      "callback_delay_seconds": 42
    }
  ]
}

Response example (406)

{
  "error": {
    "details": {
      "http": "406 Not Acceptable",
      "msg": "vpn detected"
    }
  }
}