Activity Results Endpoints
An overview of the Activity Results endpoints.
The Activity Results API category offers a comprehensive suite of endpoints tailored to retrieve user activity data from within R1 Discover. Below is a summary of the endpoints available within this category, each with specialized functionalities for different scopes of data retrieval. Detailed information about each endpoint, including request formats, response structures, and usage examples, can be found in the "Endpoints Detailed Description" section of this documentation.
Overview of Activity Results APIs
R1 Discover provides a beautiful set of dashboards to analyze use activity data, however if you want to access the data for your own analysis, or use it to create documentation of user engagements, we make it all available through the Activity Results APIs. Our API endpoints provide flexible, detailed access to all of the activity data.
Endpoints
All Companies Taken Activity List: Retrieve lists of activities taken by all users across all companies accessible by the requester.
View Taken Activity Details: Access detailed information about a specific activity taken, including completion status and timestamps.
View User Taken Activity Details: Obtain all activity taken data for a specific user, including activity status, type and timestamps.
View Company Taken Activity Details: Gather activity results data for all users within a specific company.
View Taken Activity Cards: Retrieve card interaction data from one specific activity, including selections and rankings made by users.
View User Taken Activity Cards: Access card interaction data across all activities for a specific user, including all selections and rankings.
View Company Taken Activity Cards: Gather comprehensive card interaction data for all users within a company, useful for assessing collective engagement trends.
View Taken Activity Questions & Answers: Retrieve user responses to questions associated with a specific activity for individual activity analysis.
View User Taken Activity Questions & Answers: Access a user’s responses across all their activities, providing a comprehensive view of their reflections.
View Company Taken Activity Questions & Answers: Obtain aggregated responses from all users within a company for a holistic view of user responses and reflections of their activities.
View User Video Metrics: Obtain all details about the videos watched by a specific user within a specific company.
View Company Video Metrics: Obtain all details about the videos watched by all users within a specific company.
Integration Points
Documentation: These endpoints provide the data necessary to create documentation of interactions with individuals in individual, one on one, and group settings.
Data Analysis and Reporting: These endpoints are integral for generating detailed reports on user activity and engagement, facilitating opportunity for in-depth analysis and outcome tracking.
Additional Resources
For developers looking to implement user management functionalities, additional resources such as code snippets, SDKs, and integration guides are available in the "Support and Resources" section of this documentation. These tools are designed to accelerate development and ensure best practices are followed in integrating our APIs.
Next Steps
After reviewing this section, developers should understand the scope and capabilities of our Activity Results APIs. Proceed to the detailed descriptions for code samples, technical specifics, and interactive examples to begin integration.
Last updated