Get a report for a specified facility

Retrieves report data for the facility specified.

Reports include:

  • facility_leaderboard : A leaderboard of your facility members for the current month.
  • facility_mep_target_status: A break down of how many of your users have/haven't hit 1300 MEPs this month.
  • facility_meps_logged: A list of MEPs earned broken down by weeks over the past 2 months.
  • facility_new_users: A list of how many new users your facility has gained each week seperated by device type.
  • user_rank_summary: A break down of your facility members myzone status.
  • facility_active_users_activities: A list of workouts by active users in a facility in time period. Pass to and from in filters e.g. "{YYYY-MM-DD HH:MM:SS},{YYYY-MM-DD HH:MM:SS}"
  • facility_active_user_activities: A list of workouts for a user in a time period. Pass accountId, to and from in filters e.g. "{accountId},{YYYY-MM-DD HH:MM:SS},{YYYY-MM-DD HH:MM:SS}"
  • facility_active_users: A list of active users in a facility in time period. Pass to and from in filters e.g. "{YYYY-MM-DD HH:MM:SS},{YYYY-MM-DD HH:MM:SS}"

Required Scope: read:reports


Required Role:

This endpoint is availble to clients using the client credentials grant.
When using the authorization code flow grant the authorized user must be an Owner or Coach to use this endpoint.

Path Params
uuid
required

The requested facility's ID

string
required

The requested report's name

Query Params
string

Additional query filters. A comma seperated list of values

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json