Get user Progress

GET 
/v1/clients/:clientID/flows/:flowId/progress

Endpoint to retrieve User Progress for a specified Flow

Request

Path Parameters

clientID stringrequired
flowId stringrequired

Responses

200

Successful operation

application/json

Schema

Schema

• Array [
id uuid
flowId uuid
authId number
clientId string
index number
completed boolean
events object[]
Array [
id uuid
authId number
clientId string
progressId uuid
eventId uuid
flowId uuid
sourceSystem string
sourceSystemId string
createdAt date-time
]
• ]

Example (from schema)

[
  {
    "id": "42fac465-9998-485c-bcbf-e42854afdf54",
    "flowId": "a5b703f7-089c-4b3f-ac55-36b688fada82",
    "authId": 1234,
    "clientId": "INCROWD",
    "index": 1,
    "completed": true,
    "events": [
      {
        "id": "52ef169f-70bb-4941-a903-6e3d75b78147",
        "authId": 1234,
        "clientId": "INCROWD",
        "progressId": "70c50148-52e4-4b9f-8d38-0d3d2027ab06",
        "eventId": "c18a61e5-d151-4ee4-91d9-0fc8494a612e",
        "flowId": "a5b703f7-089c-4b3f-ac55-36b688fada82",
        "sourceSystem": "some_source_system",
        "sourceSystemId": "some_source_system_id",
        "createdAt": "2023-09-21T18:35:26.234Z"
      }
    ]
  }
]

Loading...