Batch Data API

This page details the MyVideos endpoint.

Purpose

For any organisation that wants to query all meta data linked to a batch to enhance their CRM or reporting functions.

get
MyVideos

https://app.b2see.co.uk/PublicAPI/MyVideos/v1/cakes/:id
This endpoint allows you to get all meta data linked to a Batch
Request
Response
Request
Query Parameters
customerId
optional
string
This is the unique identifier for the account (B2see ID)
apiKey
required
string
API key to authenticate the 3rd party
daysOfHistory
required
integer
How far back in days the data set will be queri
Response
200: OK
Cake successfully retrieved.
[
{
"BatchId": 1032005,
"MarketingContactId": 0,
"DateCreated": "2021-05-13T10:53:44Z",
"SendingUserName": "Rory Walsh",
"Title": "TEST SERVICE ",
"ProductType": "aftersales_via_portal",
"RecipientEmail": "",
"RecipientMobile": "",
"Data": null,
"DateSent": null,
"LandingPageFirstWatched": null,
"LandingPageLastWatched": null,
"LandingPageWatchCount": 0,
"CustomerActionState": null,
"CustomerActionDate": null,
"CustomerActionDescription": null,
"CustomerActionPrice": 0,
"CustomerActionPriceSuffix": null,
"CustomerActionPaymentOutcome": null,
"CustomerRating": null,
"CustomerRatingAdditional": null,
"VideoPlayCount": 1,
"ImageLinkClicks": 0,
"FacebookClicks": 0,
"GoogleClicks": 0
}
]
404: Not Found
{
"Success": false,
"Message": "CustomerID does not exist"
}
or
{
"Success": false,
"Message": "API key not in correct format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)"
}