Change Updates

Do not miss any BitLabs API changes, ever again

Subscribe to the BitLabs API changelog to be up to date on recent changes.

RSS
BitLabs API

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1
GET /v1/client/settings/v2
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
21 structure changes including:
21 Modifications
Modified 21 Breaking
GET /v1/client/auth/verify
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/balance
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/networks/{networkId}/questions/{questionId}
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/networks/{networkId}/surveys/{surveyId}/check
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/networks/{networkId}/surveys/{surveyId}/open
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/settings
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/settings/v2
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/user
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/user/history
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/user/history/offers/{offerId}
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

GET /v1/client/zipcodes/{zipcode}/valid
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

PATCH /v1/client/user
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

PATCH /v1/client/user/legal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
POST /v1/client/auth/sso
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v1/client/networks/{networkId}/questions/{questionId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v1/client/networks/{networkId}/questions/{questionId}/skip
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v1/client/networks/{networkId}/surveys/{surveyId}/leave
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v1/client/networks/{networkId}/surveys/{surveyId}/rate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v1/client/networks/{networkId}/surveys/{surveyId}/skip
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v1/publishers/auth/s2s
  • Response
  • 406 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

POST /v2/client/surveys/{surveyId}/skip
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
        • Removing polymorphism is always breaking

          Breaking

      • error, status, trace_id attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

1 structure change including:
1 Modification
Modified 1
GET /v2/client/surveys
  • Query
  • algo query parameter Added
1 structure change including:
1 Modification
Modified 1
GET /v1/client/user
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
1 structure change including:
1 Addition
Added 1
GET /v1/client/magic-receipts/url
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/client/settings/v2
  • Authentication
  • Header api token & Header user, Query api token & Query user, Header bearer token authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Header api token authentication method Added
1 structure change including:
1 Modification
Modified 1
GET /v2/client/offers
  • Query
  • client_user_agent, client_ip query parameters Added
4 structure changes including:
4 Modifications
Modified 4
GET /v1/client/settings/v2
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
GET /v1/client/user
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
POST /v1/client/auth/sso
  • Body
  • application/json content type Modified
    • custom_fields attribute Added
POST /v1/publishers/auth/s2s
  • Body
  • application/json content type Modified
    • custom_fields attribute Added
1 structure change including:
1 Modification
Modified 1
GET /v1/client/settings/v2
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
1 structure change including:
1 Modification
Modified 1
GET /v1/client/settings/v2
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
29 structure changes including:
3 Additions
26 Modifications
Modified 26 Breaking
GET /v1/client/actions
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/balance
  • Authentication
  • Header api token & Header user, Query api token & Query user authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Header bearer token authentication method Added
GET /v1/client/check
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/leaderboard
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/networks/{networkId}/questions/{questionId}
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/networks/{networkId}/surveys/{surveyId}/check
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/networks/{networkId}/surveys/{surveyId}/open
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/settings
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/settings/v2
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/surveys
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/user
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/user/history
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/user/history/offers/{offerId}
  • Authentication
  • Header bearer token authentication method Added
GET /v1/client/zipcodes/{zipcode}/valid
  • Authentication
  • Header bearer token authentication method Added
GET /v2/client/offers
  • Authentication
  • Header bearer token authentication method Added
GET /v2/client/surveys
  • Authentication
  • Header bearer token authentication method Added
GET /v2/client/surveys/{surveyId}/check
  • Authentication
  • Header bearer token authentication method Added
PATCH /v1/client/user
  • Authentication
  • Header bearer token authentication method Added
PATCH /v1/client/user/legal
  • Authentication
  • Header bearer token authentication method Added
POST /v1/client/networks/{networkId}/questions/{questionId}
  • Authentication
  • Header bearer token authentication method Added
POST /v1/client/networks/{networkId}/questions/{questionId}/skip
  • Authentication
  • Header bearer token authentication method Added
POST /v1/client/networks/{networkId}/surveys/{surveyId}/continue/{txId}
  • Authentication
  • Header bearer token authentication method Added
POST /v1/client/networks/{networkId}/surveys/{surveyId}/leave
  • Authentication
  • Header bearer token authentication method Added
POST /v1/client/networks/{networkId}/surveys/{surveyId}/rate
  • Authentication
  • Header bearer token authentication method Added
POST /v1/client/networks/{networkId}/surveys/{surveyId}/skip
  • Authentication
  • Header bearer token authentication method Added
POST /v2/client/surveys/{surveyId}/skip
  • Authentication
  • Header bearer token authentication method Added
Added 3
GET /v1/client/auth/verify
POST /v1/client/auth/sso
POST /v1/publishers/auth/s2s
1 structure change including:
1 Addition
Added 1
PATCH /v1/client/user
1 structure change including:
1 Modification
Modified 1
GET /v2/client/offers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
1 structure change including:
1 Modification
Modified 1
POST /v1/publishers/users
  • Authentication
  • Header s2s token authentication method Added
1 structure change including:
1 Modification
Modified 1
GET /v2/publishers/offers/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
1 structure change including:
1 Addition
Added 1
GET /v1/client/balance
1 structure change including:
1 Modification
Modified 1
GET /v2/publishers/offers/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data attribute Modified
1 structure change including:
1 Modification
Modified 1
GET /v2/client/offers
  • Header
  • User-Agent header Added
1 structure change including:
1 Modification
Modified 1
GET /v2/client/offers
  • Query
  • in_app query parameter Modified
    • Type went from boolean to boolean | null

1 structure change including:
1 Addition
Added 1
GET /v2/publishers/offers/report