getEvents
GET/events
Get all Events up to 30 days back in a paginated listing, sorted by ascending createdAt.
Request
Query Parameters
Possible values: >= 1
Default value: 1
The page number in a paginated listing.
Possible values: >= 1 and <= 20
Default value: 20
The number of items to return on each page.
Filter Events to only include those with a createdAt timestamp strictly greater than createdAfter. Useful for polling and batch processing; iterate over all Events, and filter each request by createdAt of the latest processed Event.
Responses
- 200
All events in a paginated listing.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- event.UserCreated
- event.UserDestroyed
- event.PageView
- event.DepositRequested
- event.DepositSettled
- event.DepositFailed
- event.WithdrawalRequested
- event.WithdrawalSettled
- event.WithdrawalFailed
- event.InternalTransferRequested
- event.InternalTransferSettled
- event.InternalTransferFailed
- event.DreamCreated
- event.DreamAchieved
- event.SavehackLaunched
- event.DreamMilestone
- schemas-savehackLaunch.AutopilotLaunch
- schemas-savehackLaunch.DailyLaunch
- schemas-savehackLaunch.WeeklyLaunch
- schemas-savehackLaunch.MonthlyLaunch
- schemas-savehackLaunch.ThiefLaunch
- schemas-savehackLaunch.RocketLaunch
- schemas-savehackLaunch.OneTimeLaunch
- schemas-savehackLaunch.RouletteLaunch
- schemas-savehackLaunch.MoonstruckLaunch
- schemas-savehackLaunch.PercentageLaunch
- schemas-savehackLaunch.EverestLaunch
- schemas-savehackLaunch.CalendarChaosLaunch
- schemas-savehackLaunch.SaveLeagueLaunch
- schemas-savehackLaunch.EurocupLaunch
- schemas-savehackLaunch.CopycatLaunch
]
events
object[]
oneOf
Possible values: [UserCreated]
data
object
required
Possible values: [User]
Possible values: [UserDestroyed]
data
object
required
Possible values: [User]
Possible values: [PageView]
data
object
required
user
object
required
Possible values: [DepositRequested]
data
object
required
Possible values: [Deposit]
user
object
required
Possible values: [requested, settled, failed]
toAccount
object
required
toDream
object
Possible values: [DepositSettled]
data
object
required
Possible values: [Deposit]
user
object
required
Possible values: [requested, settled, failed]
toAccount
object
required
toDream
object
Possible values: [DepositFailed]
data
object
required
Possible values: [Deposit]
user
object
required
Possible values: [requested, settled, failed]
toAccount
object
required
toDream
object
Possible values: [WithdrawalRequested]
data
object
required
Possible values: [Withdrawal]
user
object
required
Possible values: [requested, settled, failed]
fromAccount
object
required
fromDream
object
Possible values: [WithdrawalSettled]
data
object
required
Possible values: [Withdrawal]
user
object
required
Possible values: [requested, settled, failed]
fromAccount
object
required
fromDream
object
Possible values: [WithdrawalFailed]
data
object
required
Possible values: [Withdrawal]
user
object
required
Possible values: [requested, settled, failed]
fromAccount
object
required
fromDream
object
Possible values: [InternalTransferRequested]
data
object
required
Possible values: [Internal]
user
object
required
Possible values: [requested, settled, failed]
fromAccount
object
required
fromDream
object
toAccount
object
required
toDream
object
Possible values: [InternalTransferSettled]
data
object
required
Possible values: [Internal]
user
object
required
Possible values: [requested, settled, failed]
fromAccount
object
required
fromDream
object
toAccount
object
required
toDream
object
Possible values: [InternalTransferFailed]
data
object
required
Possible values: [Internal]
user
object
required
Possible values: [requested, settled, failed]
fromAccount
object
required
fromDream
object
toAccount
object
required
toDream
object
Possible values: [DreamCreated]
data
object
required
Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.
(Optional) Date before which the User wants to complete this Dream.
DateTime when the dream was completed.
user
object
groupDream
object
(Optional) GroupDream this Dream is a part of.
account
object
The Account connected to this Dream.
Possible values: [DreamAchieved]
data
object
required
Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.
(Optional) Date before which the User wants to complete this Dream.
DateTime when the dream was completed.
user
object
groupDream
object
(Optional) GroupDream this Dream is a part of.
account
object
The Account connected to this Dream.
Possible values: [SavehackLaunched]
data
object
required
oneOf
dream
object
required
savehack
object
required
Possible values: [AutopilotLaunch]
dream
object
required
savehack
object
required
Possible values: [DailyLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [WeeklyLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
Possible values: <= 6
Determines which day of the week the SavehackLaunch should create a Deposit.
dream
object
required
savehack
object
required
Possible values: [MonthlyLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
Possible values: >= 1 and <= 31
Determines which day of the month the SavehackLaunch should create a Deposit.
dream
object
required
savehack
object
required
Possible values: [ThiefLaunch]
Possible values: >= 1
The lower boundary (inclusive) for the amount (in cents or the smallest currency subunit) that will be Deposited.
Possible values: <= 9223372036854776000
The upper boundary (inclusive) for the amount (in cents or the smallest currency subunit) that will be Deposited.
dream
object
required
savehack
object
required
Possible values: [RocketLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [OneTimeLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [RouletteLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [MoonstruckLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [PercentageLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
Possible values: >= 1 and <= 31
Determines which day of the month the launch should happen
dream
object
required
savehack
object
required
Possible values: [EverestLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
Possible values: <= 6
Determines which day of the week the launch should happen
dream
object
required
savehack
object
required
Possible values: [CalendarChaosLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [SaveLeagueLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
Used in saveleague savehack to determine the selected team.
dream
object
required
savehack
object
required
Possible values: [EurocupLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
dream
object
required
savehack
object
required
Possible values: [CopycatLaunch]
Possible values: >= 1 and <= 9223372036854776000
How much money (in cents or the smallest currency subunit) that will be transferred from the current account to the Dream's connected Account in each Deposit created by the SavehackLaunch.
Possible values: [DreamMilestone]
dream
object
This field is present only in case the milestone was created not due to InternalTransfer
toDream
object
This field is present only in case the milestone was created due to InternalTransfer
fromDream
object
This field is present only in case the milestone was created due to InternalTransfer
user
object
Possible values: [25, 50, 75, 100]
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
meta
object
URL for the next page.
The total count of items.
The number of returned items on this page.
The number of pages.
Index of the first item on this page (starting from 1).
Index of the last item on this page.
{
"events": [
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null
],
"meta": true
}