©️REFERENCE

πŸ†• Reference Movement Tracking with PoseTracker

PoseTracker supports custom reference-based tracking with the reference query parameter.

A reference movement is a short movement created in the PoseTracker dashboard and stored as a reusable reference. Once created, it can be used in both:

  • real-time tracking

  • uploaded video analysis

This allows developers to compare a user’s movement against a custom movement instead of using a built-in exercise.


1. Create a Reference Movement

Before using the reference parameter, you first need to create a reference movement in the PoseTracker dashboard.

πŸ‘‰ Create and manage your references here:

https://app.posetracker.com/reference-movements/list

In the dashboard, you can:

  • upload a short reference video

  • trim one clean repetition

  • generate a reference movement

  • retrieve its UUID

This UUID is the value used in the reference query parameter.

Example:


2. Use the reference Parameter

Use reference when you want PoseTracker to track a custom movement.

Real-time tracking

Upload tracking

⚠️ reference and exercise cannot be used together.

Use:

  • exercise=... for built-in PoseTracker exercises

  • reference=... for custom dashboard-created movements


3. How It Works

When reference is provided:

  1. PoseTracker loads the reference movement

  2. PoseTracker compares the live or uploaded movement to that reference

  3. PoseTracker detects repetitions

  4. PoseTracker returns similarity scores for each repetition

This works with the same integration flow as the standard tracking endpoints.


4. Integration Flow


5. Returned Data

When using reference, PoseTracker sends the usual tracking events, and counter events may include a reference_score object.

Example:

reference_score fields

Field
Type
Description

overallScore

number

Global similarity score

poseScore

number

Pose similarity

timingScore

number

Timing similarity

movementScore

number

Movement amplitude similarity

grade

string

Global letter grade

All numeric scores are returned between 0 and 1.


6. Upload Video Summary

When using reference with uploaded videos, PoseTracker may also return a summary event at the end of the analysis.

Example:

Summary fields

Field
Type
Description

counter

number

Total repetitions detected

avg_similarity

number | null

Average similarity across frames

avg_rep_score

number | null

Average repetition score

total_frames_compared

number

Number of analyzed frames


7. Simple Implementation Example

Embed the tracking URL

Listen to results


8. When to Use reference

Use reference when:

  • you want to track a custom movement not available as a built-in exercise

  • you want to compare users against a movement recorded in your dashboard

  • you want per-repetition similarity scoring

Use exercise when:

  • you want to use PoseTracker’s built-in movement logic

  • you do not need a custom movement reference


9. Best Practices

For best results:

  • create references from a short video containing one clean repetition

  • keep the movement clearly visible

  • ask end users to perform the movement from a similar camera angle


  • Reference dashboard https://app.posetracker.com/reference-movements/list

  • Real-time tracking docs Use PoseTracker on real-time camera / webcam

  • Upload tracking docs Use PoseTracker on uploaded files

Last updated