Basket Data Feed

Our Data Feed pulls data from your UB integration. This will give you on-demand intelligence about what's occurring in your app's basket.

Data feed API endpoint

GET https://events.ub.io/stream

Parameter	Value
key string	Your UB API key.
secret string	An additional secret. If you don't have your secret (or your API key) please get in touch with Mark at [email protected].
date string	A date in the past 7 days, formatted yyyy-mm-dd.

Data poll frequency

The data feed will return events with up to 7 days history. You can choose the poll frequency. We recommend you establish a recurring job on a cycle within the 7 day limit to pull the latest data by adjusting date and then save the output to your database.

Events and data returned

The endpoint returns a JSON object containing the following events:

Event	Description
basket.add	When an item is added to basket.
basket.remove	When something is removed from the basket.
basket.create	A new basket is created when the first item is added to it. Useful for seeing if an item has been added to a new or existing basket.
basket.checkout	The submission of a basket for checkout (i.e. clicking 'Place order')
transaction.success	Returned when a transaction succeeds.
transaction.failure	Returned when a transaction fails.

Each event includes a number of details. For example, basket.add includes timestamp, product title, price, variants and so on. transaction.success provides the basketId, user details etc. We may provide analytics and data visualisations in the future. Currently the potential for gaining metrics and insights from the data is up to you.

Example of returned data

{
    "id": 0000000,
    "name": "basket.create",
    "createdAt": "2016-09-18T15:15:49.000Z",
    "value": null,
    "userId": "0000000",
    "basketId": "0000000-8ba5-4817-b73e-fb4748449b40",
    "email": null,
    "firstname": null,
    "lastname": null,
    "data": {
      "app": 00,
      "user": 0000000,
      "basket": "0000000-8ba5-4817-b73e-fb4748449b40"
    }
  },
  {
    "id": 0000000,
    "name": "basket.add",
    "createdAt": "2016-09-18T18:08:02.000Z",
    "value": 29.99,
    "userId": "0000000",
    "basketId": "0000000-214f-412e-89d2-c8eb07b41710",
    "email": null,
    "firstname": null,
    "lastname": null,
    "data": {
      "shop": 263,
      "value": 29.99,
      "product": {
        "id": 0000000,
        "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
        "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
        "text": "",
        "price": {
          "value": 29.99,
          "currency": {
            "code": "GBP",
            "symbol": "£"
          },
          "text": "£29.99"
        },
        "currency": "GBP",
        "thumbnailUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
        "attachments": [
          {
            "type": "image",
            "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
            "id": 1
          },
          {
            "type": "image",
            "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
            "id": 2
          }
        ],
        "attributes": null,
        "variants": {
          "index": 0,
          "name": "size",
          "options": [
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "2",
              "value": "2",
              "image": null
            },
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "3",
              "value": "3",
              "image": null
            },
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "4",
              "value": "4",
              "image": null
            },
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "5",
              "value": "5",
              "image": null
            },
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "6",
              "value": "6",
              "image": null
            },
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "7",
              "value": "7",
              "image": null
            },
            {
              "name": "size",
              "available": true,
              "url": "http://www.zara.com/uk/en/trf/shoes/plimsolls-with-sunglasses-detail-c269216p3612427.html",
              "title": "PLIMSOLLS WITH SUNGLASSES DETAIL Details",
              "price": {
                "value": 29.99,
                "currency": "GBP",
                "min": 29.99,
                "max": 29.99
              },
              "description": "",
              "images": [
                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg=="
              ],
              "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3QMHCC46extmHgAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAADUlEQVQI12NgYGBgAAAABQABXvMqOgAAAABJRU5ErkJggg==",
              "text": "8",
              "value": "8",
              "image": null
            }
          ],
          "price": {
            "min": 29.99,
            "max": 29.99,
            "currency": "GBP"
          },
          "cardinality": 7
        },
        "shop": {
          "id": 263,
          "name": "www.zara.com",
          "url": "http://www.zara.com"
        },
        "outOfStock": false,
        "recrawling": 1474222082049
      },
      "userId": 0000000,
      "appId": "00",
      "basketId": "0000000-214f-412e-89d2-c8eb07b41710"
    }
  },
{
    "id": 0000000,
    "name": "basket.remove",
    "createdAt": "2016-09-18T10:53:04.000Z",
    "value": 78,
    "userId": "0000000",
    "basketId": "0000000-80d2-4abd-9f89-2fbc8bb881cc",
    "email": "[email protected]",
    "firstname": "Jane",
    "lastname": "Doe",
    "data": {
      "shop": 352,
      "value": 78,
      "product": {
        "id": 0000000,
        "url": "http://www.sarenza.co.uk/art-creta-442-s806496-p0000090299",
        "title": "Creta 442 ART",
        "text": "",
        "price": {
          "value": 78,
          "currency": {
            "code": "GBP",
            "symbol": "£"
          },
          "text": "£78.00"
        },
        "currency": "GBP",
        "thumbnailUrl": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
        "attachments": [
          {
            "type": "image",
            "url": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
            "id": 1
          },
          {
            "type": "image",
            "url": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
            "id": 2
          }
        ],
        "attributes": null,
        "variants": {
          "index": 0,
          "name": "size",
          "options": [
            {
              "name": "size",
              "text": "UK 3.5 / EU 36",
              "value": "uk 3.5 / eu 36",
              "image": null,
              "available": true,
              "price": {
                "value": 78,
                "currency": "GBP"
              },
              "picture": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
              "url": "http://www.sarenza.co.uk/art-creta-442-s806496-p0000090299",
              "title": "Creta 442 ART",
              "description": "",
              "images": [
                "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941"
              ]
            },
            {
              "name": "size",
              "text": "UK 4 / EU 37",
              "value": "uk 4 / eu 37",
              "image": null,
              "available": true,
              "price": {
                "value": 78,
                "currency": "GBP"
              },
              "picture": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
              "url": "http://www.sarenza.co.uk/art-creta-442-s806496-p0000090299",
              "title": "Creta 442 ART",
              "description": "",
              "images": [
                "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941"
              ]
            },
            {
              "name": "size",
              "text": "UK 5 / EU 38",
              "value": "uk 5 / eu 38",
              "image": null,
              "available": true,
              "price": {
                "value": 78,
                "currency": "GBP"
              },
              "picture": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
              "url": "http://www.sarenza.co.uk/art-creta-442-s806496-p0000090299",
              "title": "Creta 442 ART",
              "description": "",
              "images": [
                "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941"
              ]
            },
            {
              "name": "size",
              "text": "UK 6 / EU 39",
              "value": "uk 6 / eu 39",
              "image": null,
              "available": true,
              "price": {
                "value": 78,
                "currency": "GBP"
              },
              "picture": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
              "url": "http://www.sarenza.co.uk/art-creta-442-s806496-p0000090299",
              "title": "Creta 442 ART",
              "description": "",
              "images": [
                "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941"
              ]
            },
            {
              "name": "size",
              "text": "UK 7 / EU 40",
              "value": "uk 7 / eu 40",
              "image": null,
              "available": true,
              "price": {
                "value": 78,
                "currency": "GBP"
              },
              "picture": "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941",
              "url": "http://www.sarenza.co.uk/art-creta-442-s806496-p0000090299",
              "title": "Creta 442 ART",
              "description": "",
              "images": [
                "http://cdn3.sarenza.net/static/_img/productsV4/0000090299/MD_0000090299_164026_09.jpg?201312131941"
              ]
            }
          ],
          "price": {
            "min": 78,
            "max": 78,
            "currency": "GBP"
          },
          "cardinality": 5
        },
        "shop": {
          "id": 352,
          "name": "www.sarenza.co.uk",
          "url": "http://www.sarenza.co.uk"
        },
        "outOfStock": false,
        "recrawling": 0
      },
      "userId": 0000000,
      "appId": "00",
      "basketId": "0000000-80d2-4abd-9f89-2fbc8bb881cc"
    }
  },
  {
    "id": 0000000,
    "name": "transaction.success",
    "createdAt": "2016-09-18T19:20:26.000Z",
    "value": 99.98,
    "userId": "0000000",
    "basketId": "0000000-6d1e-4190-b1c7-eff89d547db5",
    "email": "[email protected]",
    "firstname": "Jane",
    "lastname": "Doe",
    "data": {
      "value": 99.98,
      "app": 00,
      "user": "584977",
      "basket": "0000000-6d1e-4190-b1c7-eff89d547db5",
      "shop": 336,
      "isFirstAttempt": true,
      "transactionId": "0000000-a6d3-4db5-94bc-8eee9f9a868e",
      "productsCount": 2
    }
  }

Data feed maturity and feedback

Please note: The UB data feed hasn't been standardised yet, so it will evolve, the format may be revisited, more events added, etc. You're welcome/encouraged to provide feedback, so do let me know if you have any. If you would like to do this please contact Mark at [email protected].