Activity Results
An overview of the User Management collection of endpoints.
Overview of Activity Results
The Activity Results category in the R1 Discover API provides a set of endpoints designed to retrieve detailed information about user activities within a company. These endpoints allow you to access activity metadata, user responses, and outcomes, such as yes/no card selections, final card results, and question-and-answer data. This category is essential for tracking user engagement, analyzing activity completion, and understanding user progress within educational or therapeutic programs.
This category is particularly useful for administrators, practitioners, or developers who need to programmatically monitor and analyze user activity data, ensuring that insights can be derived to improve program delivery and user outcomes.
Endpoints in This Category
The "Activity Results" collection includes the following endpoints:
List Activities Retrieve a paginated list of activities for a specific company, including details such as topic name, activity type, completion status, and report URLs.
List Activity Yes/No Cards Fetch the yes/no card selections made by users for a specific activity, including the model definitions and text of each card.
List Activity Final Cards Retrieve the final card results for a specific activity, including the pyramid ID, model category, and card details.
List Activity Q&As Get the questions and answers provided by users for a specific activity, including question types (e.g., radio, textarea) and user responses.
Each endpoint in this category requires authentication via a Bearer token, which must be included in the Authorization header of your requests. For more details on authentication, refer to the Authentication Guide section.
Use Cases
The Activity Results endpoints are typically used in the following scenarios:
Streamlined Documentation: Use the data from these endpoints to construct SOAP/DAP notes and send them directly into client records in EHR/EMRs.
User Progress Tracking: Use the List Activities endpoint to monitor user activity completion, including timestamps, completion status, and associated report URLs. Typically used to aggregate data on number and type of activities completed.
Behavioral Analysis: Leverage the List Activity Yes/No Cards and List Activity Final Cards endpoints to analyze user responses to yes/no cards and final card outcomes, gaining insights into user behavior and progress.
Qualitative Insights: Use the List Activity Q&As endpoint to retrieve user responses to activity questions, providing qualitative data for practitioners to assess user reflections and needs. It's helpful to view the user written results vs the data driven card results in the other endpoints.
Reporting and Analytics: Combine activity results with other data (e.g., from the Metrics and Analytics category) to generate comprehensive reports on user engagement and program effectiveness.
Program Improvement: Analyze activity results to identify trends or areas for improvement in educational or therapeutic content, ensuring programs meet user needs.
Best Practices
Authentication: Always include a valid Bearer token in the Authorization header to avoid 401 Unauthenticated errors.
Pagination: All endpoints in this category support pagination parameters (page and limit). Use these to manage large datasets efficiently and avoid performance issues.
Filtering Options: Utilize query parameters like maxDays, userId, uniqueId, userActivityId, activityType, topicId, and activityId to filter results and retrieve only the data you need. For example, filter by userId to focus on a specific user’s activities.
Error Handling: Be prepared to handle common errors such as 401 Unauthenticated and 403 Unauthorized. Refer to the individual endpoint documentation for detailed error responses.
Data Interpretation: When analyzing yes/no cards, final cards, or Q&As, ensure you understand the context of the activity type (e.g., sorting cards, pyramid) to correctly interpret the results.
Performance Optimization: Since activity data can be voluminous, consider caching frequently accessed results or using filters to reduce the amount of data retrieved in each request.
Integration Points
To effectively use the Activity Results endpoints, ensure your application is properly authenticated. You will need to:
Obtain an API Token: Follow the authentication flow to obtain a Bearer token. Refer to the Authentication Guide (#) for detailed steps.
Set Up Headers: Include the following headers in your requests:
Content-Type: application/json
Accept: application/json
Authorization: Bearer {token}
These endpoints can be combined with other categories for more advanced integrations, such as:
Company Management: Use the List Company Activities endpoint in the Company Management category to retrieve activity IDs, then fetch detailed results using the List Activities endpoint.
User Management: After retrieving user data with the List Company Users endpoint in the User Management category, use the userId or uniqueId to filter activity results for specific users.
Metrics and Analytics: Combine activity results with video metrics from the List Company Video Metrics endpoint in the Metrics and Analytics category to get a holistic view of user engagement across activities and videos.
Additional Resources
Postman Collection: Explore the full R1 Discover API Postman collection for pre-built requests and examples: R1 Discover API Postman Collection.
Support: For further assistance, contact the R1 Discover API support team at [email protected].
Changelog: Stay updated with the latest API changes by reviewing the API Changelog.
Last updated