Dashboard Running

Compare Metrics (week-by-week)

get

Return a single composite object that places several running metrics on the same ISO-week timeline.

chart_data β€’ x_values - first day of each ISO-week in the interval. β€’ y_values - dictionary keyed by metric (snake-case); each entry is a list whose items line up with x_values (use null when a week has no data). β€’ max_values - the interval-wide maximum for every requested metric (handy for axis scaling).

weeks Helper structure for tables/tool-tips: every bucket is broken out with its start/end dates and per-metric value(s).

Authorizations
AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Query parameters
user_idsstring[]Optional

One or more user ids (CSV list)

start_datestring Β· dateRequired

Interval start (YYYY-MM-DD)

end_datestring Β· dateRequired

Interval end (YYYY-MM-DD)

Responses
chevron-right
200

Metrics compared successfully.

application/json
Responseobject
get
/dashboard-running/client-overview/compare-metrics/

Compare Sessions (flat series per metric)

get

Return a per-session breakdown for one or more running metrics.

  • chart_data - one entry per metric: β€’ x_values - ISO dates (YYYY-MM-DD) of every requested session in chronological order. β€’ y_values - the same length list of session-detail objects β€” each object carries the metric value plus the session / user identifiers needed for tool-tips or tables.

  • weeks - unchanged: sessions grouped into ISO-week buckets (handy for tables/tool-tips).

  • sessions - quick lookup list of { session_id, session_name } used to populate filters.

Authorizations
AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Query parameters
session_idsstring[]Required

One or more session ids (CSV list)

start_datestring Β· dateRequired

Interval start (YYYY-MM-DD)

end_datestring Β· dateRequired

Interval end (YYYY-MM-DD)

Responses
chevron-right
200

Per-session metrics returned successfully.

application/json
get
/dashboard-running/client-overview/compare-sessions-individually/

Compare Sessions (per-session values in weekly buckets)

get

Return a per-session breakdown for one or more running metrics.

  • The requested interval is split into ISO-weeks (listed in x_values).

  • chart_data β†’ one entry per metric. For each week the y_values array contains the session objects that fall into that bucket.

  • weeks mirrors the same data for easy table / tooltip rendering.

Authorizations
AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Query parameters
session_idsstring[]Required

One or more session ids (CSV list)

start_datestring Β· dateRequired

Interval start (YYYY-MM-DD)

end_datestring Β· dateRequired

Interval end (YYYY-MM-DD)

Responses
chevron-right
200

Per-session metrics returned successfully.

application/json
Responseobject
get
/dashboard-running/client-overview/compare-sessions/

Compare Users (interval-wide totals)

get

Compare selected running metrics per user across the requested date range. The interval is split into calendar-week buckets.

  • chart_data - for every metric, supplies the overall min / max / avg and a y_values matrix (user x week) aligned to x_values (ISO week start dates).

  • weeks - lists, for every bucket, the users that contributed sessions and the underlying session details.

  • users - an ordered roster mapping user IDs to display names.

  • For numeric metrics each cell in y_values is the user's weekly average.

  • Training Frequency cells are raw counts.

  • Footstrike cells are percentage breakdowns of strike patterns for that user & week.

Authorizations
AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Query parameters
user_idsstring[]Optional

One or more user ids (CSV list)

start_datestring Β· dateRequired

Interval start (YYYY-MM-DD)

end_datestring Β· dateRequired

Interval end (YYYY-MM-DD)

Responses
chevron-right
200

Per-user weekly metric values returned successfully.

application/json
get
/dashboard-running/client-overview/compare-users/

Retrieve Extended Metric Data (weekly buckets)

get

Return a detailed, week-by-week breakdown for one running metric.

  • The interval is split into ISO-weeks (see x_values).

  • chart_data contains the global min / max / avg and an array of bucket averages in y_values.

  • weeks enumerates the sessions that form each bucket and exposes their raw metric values.

Special cases: β€’ Training Frequency - raw weekly counts. β€’ Foot-strike - weekly percentage splits (categorical). β€’ All other metrics - numeric min / avg / max per session.

Authorizations
AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Query parameters
user_idsstring[]Optional

One or more user ids (CSV list)

metricstring Β· enumRequired

The metric to drill into

Possible values:
start_datestring Β· dateRequired

Interval start (YYYY-MM-DD)

end_datestring Β· dateRequired

Interval end (YYYY-MM-DD)

Responses
chevron-right
200

Extended metric data returned successfully.

application/json
Responseobject
get
/dashboard-running/client-overview/metric-extended/

Retrieve Dashboard Metrics (weekly buckets)

get

Return aggregated running metrics for dashboard charts. The requested interval is split into calendar-week buckets.

The response has two top-level blocks:

  • chart_data - global stats and weekly values for every metric.

  • weeks- per-week session lists (and their metric values).

  • Training Frequency is a simple count per week.

  • Footstrike is a percentage breakdown for the whole interval.

Authorizations
AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Query parameters
user_idsstring[]Optional

One or more user ids (CSV list)

start_datestring Β· dateRequired

Interval start (YYYY-MM-DD)

end_datestring Β· dateRequired

Interval end (YYYY-MM-DD)

Responses
chevron-right
200

Aggregated metrics returned successfully.

application/json
get
/dashboard-running/client-overview/overview

Last updated

Was this helpful?