LeapsurgeBI
Userdasboarddata
Function: userDasboardData Type: API Endpoint (GET)
Purpose: Returns dashboard data for the logged-in Leapsurge BI user and firm. The endpoint decodes the supplied header values, checks the user's administrator/group context, and builds dashboard sections for user counts, reports, sync status, source status, and today's activity log.
Headers:
- user_code (str, required): Base64-encoded user code.
- lscode (str, required): Base64-encoded customer/LS code.
- company_code (str, required): Base64-encoded firm/company code.
- app_code (str, required): Base64-encoded application code.
Response: Returns a JSON object containing:
- cardDetails: User, active user, inactive user, subscribed report, assigned license, and pending license counts for administrator users.
- favouritereportList: Favorite subscribed reports for the user.
- recentReportList: Recently opened reports available to the user or assigned group.
- reportoverviewList: Requested, subscribed, rejected, and disabled report counts.
- dataSyncDetails: Report sync and dataset sync status details.
- sourceData: Customer firm and sync source/server status information.
- reportsTrace: Report subscription status summary.
- activityLog: Current-day activity event counts grouped by time.
Exceptions:
- Returns HTTP 500 with an error message if dashboard data cannot be retrieved.
get/api/LeapsurgeBI/userdasboard
Headers
user-codestring nullable
lscodestring nullable
company-codestring nullable
app-codestring nullable
Response
Successful Response
{"stackTrail":"paths:/api/LeapsurgeBI/userdasboard:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
Changes
No recorded changes to this endpoint across all 1 revision of this API.