Ejento APIs
V1
  • V2
  • V1
  1. Analytics APIs
Ejento APIs
V1
  • V2
  • V1
  • Overview
  • Endpoints
    • Chat APIs
      • Run Chat
      • Create Custom Instructions
      • Add Comment Feedback
      • Add Upvote Feedback
      • Add Downvote Feedback
      • Get Chat Thread
      • Get Thought Process
      • Get Supporting Content
      • Get All Agent Threads
    • Agent APIs
      • Get Recent Agents
      • Add to Recent Agents
      • Delete Recent Agent
      • Get Starred Agents
      • Delete Starred Agents
      • Get Agents by Team or User Team
      • Create a Review for an Agent
      • Get Agent Reviews
      • Update an Agent Review
      • Delete an Agent Review
      • Create Agent Chat
      • Get Agent Ratings
      • Toggle Rating
      • Create Agent Alias
      • Get All Agent Alias
      • Update Agent Alias
      • Get Agent Access Level
      • Update Agent Access Level
      • Get All Agents by Project
      • Get Agent Types
      • Update Agent Type
      • Get User Agent or User Agent Permission
    • Project APIs
      • Create New Project
      • Get All Projects
      • Get Project Details by ID
      • Edit Project By ID
      • Delete Project By ID
      • Add Recent Project
      • Get Recent Projects
      • Fetch Project Details
      • Add User to Project
      • Remove User from Project
      • Get User Projects For Team
    • Document APIs
      • Get Document By ID
      • Edit Document By ID
      • Delete Document By ID
    • Corpus APIs
      • Get All Corpus
      • Create Corpus
      • Get Corpus by ID
      • Edit Corpus
      • Delete Corpus
      • Get Corpus Permissions
      • Create Corpus Permissions
      • Delete Corpus Permissions
      • Get Corpus Permission By User
      • Create Document In Corpus
      • Get All Documents From Corpus
      • Delete All Documents
      • Check Duplicate Documents
    • Evaluation APIs
      • Create Evaluation Test
      • Get All Evaluation Tests for an Agent
      • Update Evaluation Test
      • Get One Evaluation Test
      • Update Evaluation Status
      • Get Evaluation Dataset for an Agent
      • Get All Evaluation Datasets for an Agent
      • Create Evaluation Dataset
      • Update Evaluation Dataset
      • Delete Evaluation Dataset
      • Get Agent Queries
      • Get Dataset Queries
    • SharePoint APIs
      • Get SharePoint items by full path
      • Get a SharePoint item by its ID
      • Create a new SharePoint item
      • Edit SharePoint item
      • Delete a SharePoint item
    • User APIs
      • Get All Users
      • Get User By ID
      • Edit User By ID
      • Delete User by ID
      • Create User Permission
      • Get User Permission by ID
      • Edit User Permission by ID
      • Delete User Permission by ID
      • Batch Delete Users
    • Analytics APIs
      • Get Tokens by Date
        GET
      • Get Tokens by Segment
        GET
      • Get User Tokens
        GET
      • Get Agent Tokens
        GET
      • Get Team Tokens
        GET
      • Get Query Count by Date
        GET
      • Get Query Count by Segment
        GET
      • Get Total Count
        GET
      • Get Daily Chat Engagement
        GET
      • Get Weekly Chat Engagement
        GET
      • Get Monthly Chat Engagement
        GET
      • Get User Engagement
        GET
      • Get Daily Chatlog Tokens
        GET
      • Get Weekly Chatlog Tokens
        GET
      • Get Monthly Chatlog Tokens
        GET
      • Get Agent Engagement
        GET
      • Get Engagement by Team
        GET
      • Get Engagement by User
        GET
      • Get Recently Active Agents
        GET
      • Get Recent Users
        GET
    • Notification APIs
      • Send Notification To User
      • Read Notification By ID
  1. Analytics APIs

Get User Engagement

GET
/analytics/user-engagement/{count}/
Analytics APIs
Retrieves engagement metrics for users, showing interaction levels and activity details. The number of users returned is limited by the count parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/analytics/user-engagement//'
Response Response Example
{
    "user_engagement": [
        {
            "user_fname": "John",
            "user_lname": "Doe",
            "user_email": "john.doe@example.com",
            "interaction_count": 664
        }
    ]
}

Request

Path Params
count
integer 
required
The number of users to retrieve.
Example:
3

Responses

🟢200OK
application/json
User engagement metrics retrieved successfully.
Body
user_engagement
array [object {4}] 
optional
user_fname
string 
optional
The first name of the user.
Example:
John
user_lname
string 
optional
The last name of the user.
Example:
Doe
user_email
string 
optional
The email of the user.
Example:
john.doe@example.com
interaction_count
integer 
optional
The number of interactions by the user.
Example:
664
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Previous
Get Monthly Chat Engagement
Next
Get Daily Chatlog Tokens