Analytics

This page aggregates all endpoints related to retrieving reports, metrics, summaries, and recommendations for processed video sessions.

Overview

Each activity—Jumping, Running, and Weightlifting—has dedicated endpoints to:

• Export Processed Data: Retrieve structured session data (e.g., keypoints, angles, timestamps, and metrics).

• Generate Analysis Reports: Obtain comprehensive analysis (e.g., jump analysis, gait analysis, lift analysis).

• Retrieve Summaries: Generate textual summaries of a session’s performance.

• Create Recommendations: Generate personalized recommendations based on the analysis.

All endpoints require a valid Api-Key token in the Authorization header. For more details on request formats and error handling, please refer to our API Reference documentation.

Running

• Retrieve Total Metrics GET /running/sessions/metrics/total/ Get average metrics across all running sessions and detailed metrics for the most recent session.

• Retrieve Running Session Details GET /running/sessions/{session_id}/ Access detailed information for a specific running session, including processed video URLs, metrics, and computed statistics.

• Export Running Session Data GET /running/sessions/{session_id}/export/ Export running session data such as keypoints, angles, timestamps, and contact information.

• Gait Analysis Report POST /running/sessions/{session_id}/gait-analysis/ Obtain a detailed gait analysis report including phase information and joint angle measurements.

• Report Comments Management GET/POST/DELETE /running/sessions/{session_id}/report-comments/ Retrieve, update, or delete user comments associated with the running session report.

• Generate Session Summary POST /running/sessions/{session_id}/summary/ Generate a textual summary of a running session’s performance and metrics.

Jumping

• Export Session Data GET /jumping/sessions/{session_id}/export/ Retrieve detailed jumping session data, including keypoints, angles, timestamps, and performance metrics.

• Vertical Jump Analysis Report POST /jumping/sessions/{session_id}/jump-analysis/ Generate a comprehensive vertical jump analysis report that includes graphical data, phase details, and user performance insights.

• Generate Recommendation Threads POST /jumping/sessions/{session_id}/recommendation/ Create personalized recommendation threads based on the jump analysis report.

• Generate or Retrieve Session Summary GET/POST /jumping/sessions/{session_id}/summary/ Retrieve a summary of the session or generate summary threads (note: some summary endpoints may be deprecated).

Weightlifting

• Retrieve Weightlifting Session Details GET /weightlifting/sessions/{session_id}/ Fetch detailed information about a weightlifting session, including original and analyzed video URLs, timestamps, and exercise data.

• Export Weightlifting Session Data GET /weightlifting/sessions/{session_id}/export/ Export structured data from a weightlifting session, including keypoints, angles, and various performance metrics.

• Analyze Weightlifting Lift POST /weightlifting/sessions/{session_id}/lift-analysis/ Run a detailed analysis of the weightlifting lift, generating images that illustrate key performance indicators such as bar speed and joint angles.

• Generate Weightlifting Recommendations POST /weightlifting/sessions/{session_id}/recommendation/ Create tailored recommendations for weightlifting performance based on the session’s analysis.