Admin Portal

Admin Portal is a top layer module for managing and retrieving data from any module across the application.

API documentation

Retrieve executions

Retrieves executions for the given identifier. The identifier it could be a job ID or a workflow ID.

GET /admin/executions/[id]

Response Sample

{
    "data": [{
        "status": 'completed',
        "configuration": {},
        "result": {},
        "createdAt": '2022-05-26T04:00:00.569Z',
        "updatedAt": '2022-05-26T04:00:13.534Z',
        "id": '3f208e44-0e09-4cfa-bf42-aa0d94286738',
        "workflowId": '01c270df-ac34-4c89-ad6c-3d349631c347',
        "type": 'normal',
    }],
}

Retrieve statistics

Retrieves administrator overview statistics for organisations and users.

GET /admin/statistics

Response Sample

{
    "activeOrganisations": 10,
    "unverifiedOrganisations": 2,
    "numberOfCountries": 5
    "activeUsers": 100
}