Get user history

GET /v1/client/user/history

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

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, magic_receipts, or others.

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data array[object]
  
  One of:
  UserHistoryEntrySurvey object UserHistoryEntryOfferV2 object UserHistoryEntryLeaderboard object UserHistoryEntrySurveySupport object UserHistoryEntryMagicReceipt object
  
  Hide attributes Show attributes
  
  type string Required
  
  Values are OPEN, LEAVE, SCREENOUT, or COMPLETE.
  
  survey_id integer(int64) Required
  
  details object Required
  
  Additional properties are allowed.
  
  Hide details attributes Show details attributes object
  
  category object Required
  
  Additional properties are allowed.
  
  Hide category attributes Show category attributes object
  
  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, un-localized, machine-friendly name of the category
  
  network object Required
  
  Additional properties are allowed.
  
  Hide network attributes Show network attributes object
  
  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.
  
  support_form_url string
  
  URL to the support form for the survey
  
  Hide attributes Show attributes
  
  offer_id string Required
  
  anchor string Required
  
  The title of the offer as it is displayed to the user.
  
  description string Required
  
  Description to display to the user.
  
  requirements string Required
  
  What the user should do to complete an offer.
  
  confirmation_time string Required
  
  categories array[string] Required
  
  An array of offer categories
  
  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.
  
  hours_left integer
  
  Number of hours left to complete the offer.
  
  next_event string
  
  Id of the next event
  
  next_payable_event string
  
  Id of the next payable event
  
  completed boolean Required
  
  If true, the user has completed the offer.
  
  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.
  
  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.
  
  has_pending_conversion boolean Required
  
  If true, the user has a pending conversion for this offer.
  
  Hide attributes Show attributes
  
  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.
  
  Hide attributes Show attributes
  
  id integer Required
  
  ID of the magic receipt
  
  user_value string Required
  
  offer_name string Required
  
  status string Required
  
  Values are completed, pending, reconciled, or reviewing.
  
  created_at string Required
  
  The date the request is created.
406 application/json

VPN detected
Hide response attribute Show response attribute object
- data object
  
  Additional properties are allowed.

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 examples (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,
      "support_form_url": "support.bitlabs.link/bitburst/survey/contact?user_id={encodedUserId}&survey_id={encodedSurveyId}"
    }
  ]
}

Response examples (406)

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