API Dashboard

Taffy 3.6.0

Resources:

UserVerifyOTP DELETE PATCH PUT POST GET /user/verify-otp

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource verifies the user's login and register OTP.
post
Handles user verify by validating email for 150 characters and otp for 6 characters, Verify OTP for max 5 times, generating Token.
Inputs
required string email
required string otp

UserSettings DELETE PATCH PUT POST GET /user/settings

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for user data settings update
post
This function updates user's settings.
Inputs
optional boolean notificationsEnabled
optional string themeMode

UserRegister DELETE PATCH PUT POST GET /user/register

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource handles user registration and OTP generation.
post
Handles user registration by validating username for 50 characters and email for 150 characters, checking uniqueness, generating OTP.
Inputs
required string username
required string email

UserLogin DELETE PATCH PUT POST GET /user/login

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource handles user login and OTP generation.
post
Handles user login by validating email for 150 characters, checking if exists, generating OTP.
Inputs
required string email

UserResource DELETE PATCH PUT POST GET /user

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for user data get, update, and delete.
get
Get authenticated user data and settings
Inputs
post
Updates user's profile including optional profile picture 'form.profileImage' upload.
Inputs
required string username
required string email
optional string profilePictureUrl (default: "")

UpdatePracticeSessions DELETE PATCH PUT POST GET /update-practice-sessions/{sessionId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Handles updating an existing practice or challenge session
post
Updates an existing practice or challenge session for the authenticated user
Inputs
required numeric sessionId
required string sessionDate
required numeric durationMinutes
optional array practiceShots (default: [runtime expression])
optional numeric challengeDurationMinutes
optional numeric challengeMaxShots
optional numeric challengeGoal
optional numeric halfwayMade
optional numeric halfwayMissed
optional numeric halfwayAccuracy

SubscriptionResources DELETE PATCH PUT POST GET /subscription

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for subscription data get.
get
Returns all active subscriptions for public users
Inputs

Stats DELETE PATCH PUT POST GET /stats

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for stats data get.
get
get stats data.
Inputs

CreateShot DELETE PATCH PUT POST GET /shot/create

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for shot data add.
post
Create shot.
Inputs
required String name
required numeric tableDesignId
required String balls
required String connections
optional String difficulty
optional String description
optional String notes
optional String instructions
optional String youtubeUrl
optional numeric youtubeTimeSec

ShotResource DELETE PATCH PUT POST GET /shot/{shotId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

This resource use for shot data get, update, and delete.
get
Inputs
required numeric shotId
post
Update shot.
Inputs
required numeric shotId
required String name
optional String balls
optional String connections
optional String difficulty
optional String description
optional String notes
optional String instructions
optional String youtubeUrl
optional numeric youtubeTimeSec

TableDesignResource DELETE PATCH PUT POST GET /setting/table-design

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for poll table design data get.
get
Returns table design.
Inputs

SliderResources DELETE PATCH PUT POST GET /setting/onboarding-slider

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for onboarding slider data get, add, update, and delete.
delete
Deletes a slider by order index from onboarding_sliders. Only admin can perform this action.
Inputs
required numeric order
get
Returns all onboarding sliders for public users.
Inputs
post
Handles creation and updating of onboarding slider entries. Validates input, ensures admin authorization, and stores slider data inside the app_settings table under the onboarding_sliders configuration.
Inputs
required string image
required string title
required string description
optional numeric order (default: 0)

PracticeSessions DELETE PATCH PUT POST GET /practice-sessions

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource handles practice or challenge session related operations
get
This API will send a list of all the practices and challenges of the selected shot of the logged in user.
Inputs
required numeric page (default: 1)
required numeric pageSize (default: [runtime expression])
required numeric shotId
post
Handles adding a new practice or challenge session for the authenticated user
Inputs
required string sessionType
required numeric shotId
required string sessionDate
required numeric durationMinutes
optional array practiceShots (default: [runtime expression])
optional numeric challengeDurationMinutes
optional numeric challengeMaxShots
optional numeric challengeGoal
optional numeric halfwayMade
optional numeric halfwayMissed
optional numeric halfwayAccuracy

Practice DELETE PATCH PUT POST GET /practice

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for user own shots data get.
get
Inputs
required numeric page (default: 1)
required numeric pageSize (default: [runtime expression])

GoalResource DELETE PATCH PUT POST GET /goal

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Save or update the authenticated user's practice goal and milestones.
get
Inputs
post
Inputs
required string totalHours
required string targetDate
required numeric daysPerWeek
required numeric hoursPerDay
required numeric minutesPerDay
required numeric hoursPerWeek
required array milestones

GameSessionsResource DELETE PATCH PUT POST GET /games-sessions/{gameId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

This resource returns session history for a specific game and user can add and edit sessions.
get
Returns session history for a game. Supports single-session lookup, date range filtering, game type filtering, and pagination.
Inputs
required numeric gameId
optional numeric page (default: 1)
optional numeric pageSize (default: [runtime expression])
optional numeric gameTypeId (default: 0)
optional string startDate (default: "")
optional string endDate (default: "")
optional numeric gameSessionId (default: 0)
post
Creates a new game session when game_session_id is not provided. Updates the existing session when game_session_id is provided.
Inputs
required numeric gameId
required numeric gameTypeId
required string sessionDate
required numeric durationMinutes
optional string location (default: "")
optional string opponent (default: "")
optional numeric gameSessionId (default: 0)

GamesResource DELETE PATCH PUT POST GET /games

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource returns all games with total practice hours for the logged-in user.
get
Returns all active games and the total hours the authenticated user has logged per game.
Inputs

GameTypesResource DELETE PATCH PUT POST GET /game-types

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource returns all active game types.
get
Returns all active game types ordered by name.
Inputs

Dashboard DELETE PATCH PUT POST GET /dashboard

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for dashboard data get.
get
Inputs

PollBallResource DELETE PATCH PUT POST GET /balls

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for poll balls data get.
get
Returns all poll balls.
Inputs

LoginGoogle DELETE PATCH PUT POST GET /auth/social/google

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Login with Google id_token
post
Inputs
required string idToken

LoginApple DELETE PATCH PUT POST GET /auth/social/apple

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Login with Apple identity token
post
Inputs
required string identityToken

AuthRefresh DELETE PATCH PUT POST GET /auth/refresh

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Refresh access token using refresh token
post
Refresh access token using refresh token
Inputs
required string refreshToken

Logout DELETE PATCH PUT POST GET /auth/logout

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Logout and revoke refresh token
post
Revoke a refresh token and log out user
Inputs
required string refreshToken

adminAdminVerifyOTP DELETE PATCH PUT POST GET /admin/verify-otp

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource verifies the admin's login OTP.
post
Handles admin verify by validating email for 150 characters and otp for 6 characters, Verify OTP for max 5 times, generating Token.
Inputs
required string email
required string otp

adminUserEdit DELETE PATCH PUT POST GET /admin/user-edit/{userId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

This resource is used to update all roles and their status except for customers.
get
Get admin user Data.
Inputs
required numeric userId
post
EDIT users (admin only)
Inputs
required numeric userId
required string username
required string email
required string phone
required numeric roleId
optional string status
optional boolean notifications
optional string theme

adminUserResource DELETE PATCH PUT POST GET /admin/user

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource is used to update all roles and their status except for customers.
get
Fetches a paginated list of admin users.
Inputs
optional numeric page (default: 0)
optional numeric perPage (default: 0)
post
ADD users (admin only)
Inputs
required string username
required string email
required string phone
required numeric roleId
optional string status
optional boolean notifications
optional string theme

adminAppleDailyDownloads DELETE PATCH PUT POST GET /admin/tasks/apple-daily-downloads/{scheduleKey}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

This resource will be used to get the app's total downloads and country data.
get
Inputs
required string scheduleKey

adminSubscriptionEdit DELETE PATCH PUT POST GET /admin/subscription-edit/{subscriptionId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

This resource use for subscription data get, update for administrators.
get
Returns subscription data for admin users
Inputs
required numeric subscriptionId
post
EDIT subscription (admin only)
Inputs
required numeric subscriptionId
required string name
required numeric monthlyAmount
required numeric yearlyAmount
optional string description (default: "")
optional string currency (default: USD)
optional numeric maxSessions (default: 0)
optional boolean isActive (default: true)
optional array features (default: [runtime expression])

adminSubscriptionResources DELETE PATCH PUT POST GET /admin/subscription

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for subscription data get, add, update, and delete for administrators.
delete
Deletes a subscription by id (admin only)
Inputs
required numeric subscriptionId
get
Returns all subscriptions for admin users
Inputs
post
ADD subscription (admin only)
Inputs
required string name
required numeric monthlyAmount
required numeric yearlyAmount
optional string description (default: "")
optional string currency (default: USD)
optional numeric maxSessions (default: 0)
optional boolean isActive (default: true)
optional array features (default: [runtime expression])

adminAdminLogin DELETE PATCH PUT POST GET /admin/login

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource handles admin login and OTP generation.
post
Handles admin login by validating email for 150 characters, checking if exists, generating OTP.
Inputs
required string email

adminDashboard DELETE PATCH PUT POST GET /admin/dashboard

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for admin dashboard data get.
get
GET - Retrieve complete dashboard analytics data Requires: Admin authentication
Inputs

adminCustomerResource DELETE PATCH PUT POST GET /admin/customer

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

This resource use for get customers and update customer status.
get
Fetches a paginated list of customers.
Inputs
optional numeric page (default: 0)
optional numeric perPage (default: 0)

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.