Retrieve the metrics of active users in the workspace during a specific period.
curl --location 'http://localhost:3000/api/v1/engagement-dashboard/users/new-users?start=2011-10-05T14%3A48%3A00.000Z&end=2023-10-05T14%3A48%3A00.000Z' \
--header 'x-auth-token: GENgWDE3-KV1BvVbnIOvpTq5RhJOQQr4XKCAsVLtFYu' \
--header 'x-user-id: 2tTEqR7ZNMJ4HGGNa'
{
"month": [
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 5,
"month": 5,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 4,
"month": 5,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 3,
"month": 5,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 2,
"month": 5,
"year": 2023
},
{
"usersList": [
"rbAXPnMktTFbNpwtJ"
],
"users": 1,
"day": 1,
"month": 5,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 29,
"month": 4,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 28,
"month": 4,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX",
"hFDuCPam7sWziWFYa"
],
"users": 2,
"day": 27,
"month": 4,
"year": 2023
},
{
"usersList": [
"rbAXPnMktTFbNpwtJ"
],
"users": 1,
"day": 26,
"month": 4,
"year": 2023
},
{
"usersList": [
"rbAXPnMktTFbNpwtJ"
],
"users": 1,
"day": 24,
"month": 4,
"year": 2023
},
{
"usersList": [
"rbAXPnMktTFbNpwtJ",
"rYhzFRd2QZjNwAAXX"
],
"users": 2,
"day": 21,
"month": 4,
"year": 2023
},
{
"usersList": [
"rYhzFRd2QZjNwAAXX"
],
"users": 1,
"day": 19,
"month": 4,
"year": 2023
},
{
"usersList": [
"rbAXPnMktTFbNpwtJ",
"rYhzFRd2QZjNwAAXX"
],
"users": 2,
"day": 18,
"month": 4,
"year": 2023
},
{
"usersList": [
"rbAXPnMktTFbNpwtJ",
"9iN96PXnDK7XAYESA"
],
"users": 2,
"day": 17,
"month": 4,
"year": 2023
}
],
"success": true
}
Any of the following errors can occur on the endpoint.
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}
{
"success": false,
"error": "Match error: Failed Match.Where validation in field start"
}