Get user Timeline

GET 
/v1/clients/:clientID/timeline/:userId

Endpoint to retrieve user Timeline (transactions history). Useful for users to see their account operations/movements.

Request

Path Parameters

clientID stringrequired
userId stringrequired

Responses

200

Successful operation

application/json

Schema

Schema

• Array [
id uuid
authId number
clientId string
data object
data field can contain any JSON value. This field gives the request some flexibility.
amount number
flowId string
leaderboards object
dimensions string[]
keys string[]
message string
groupId string

useful to group transactions.

isComparable boolean

indicates if this transaction should be used to calculate Leaderboards or not.

operation string

indicates if this transaction should increase or decrease the balance. Allowed values are CREDIT and DEBIT.

parentId uuid

indicates that this transaction is child of the specified parentId (i.e. this transaction is a BOOSTER of another one).

sourceSystem string
type string
createdAt date-time
• ]

Example (from schema)

[
  {
    "id": "a5b703f7-089c-4b3f-ac55-36b688fada82",
    "authId": 1234,
    "clientId": "INCROWD",
    "data": {
      "amount": 100,
      "flowId": "6700752b-23ab-41db-a5cc-cea29700dd58",
      "leaderboards": {
        "dimensions": [
          "minileague_123",
          "EUROPE"
        ],
        "keys": [
          "competition_1234",
          "round_1"
        ]
      },
      "message": "Custom message"
    },
    "groupId": "6700752b-23ab-41db-a5cc-cea29700dd58",
    "isComparable": true,
    "operation": "CREDIT",
    "parentId": "7712e32c-068f-48ce-957b-bfa47026b270",
    "sourceSystem": "RULES_ENGINE",
    "type": "POINTS",
    "createdAt": "2023-09-21T18:35:26.234Z"
  }
]

Loading...