Get Active Users
    • Dark
      Light
    • PDF

    Get Active Users

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/engagement-dashboard/users/active-users
    Premium tag

    Retrieve the metrics of active users in the workspace during a specific period.

    Permission required: view-engagement-dashboard

    Changelog

    VersionDescription
    3.1.0Added
    Header parameters
    X-User-Id
    stringRequired

    The user ID of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    X-Auth-Token
    stringRequired

    The token of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    Query parameters
    start
    stringRequired

    The start date.

    Example2023-10-29T14:48:00.000Z
    end
    stringRequired

    The end date.

    Example2023-11-05T14:48:00.000Z
    Responses
    200

    OK

    Success Example
    {
      "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",
            "9iN96PXnDK7XAYESA"
          ],
          "users": 2,
          "day": 17,
          "month": 4,
          "year": 2023
        }
      ],
      "success": true
    }
    Expand All
    object
    month
    Array of object
    object
    usersList
    Array of string
    string
    users
    integer
    day
    integer
    month
    integer
    year
    integer
    success
    boolean
    400

    Bad Request

    Missing key
    {
      "success": false,
      "error": "Match error: Missing key 'start'"
    }
    Example 2
    {
      "success": false,
      "error": "Match error: Failed Match.Where validation in field start"
    }
    object
    success
    boolean
    error
    string
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string
    403

    Forbidden



    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.