Skip to main content
GET
/
api
/
public
/
v1
/
analytics
/
portfolio
Get portfolio summary
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/analytics/portfolio \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "companyHealth": [
      {
        "count": 123,
        "percentage": 123
      }
    ],
    "overallComplianceRate": 123,
    "trainingComplianceRate": 123,
    "activeEngagementRate": 123,
    "metrics": {
      "totalCompanies": 123,
      "totalDevices": 123,
      "totalUsers": 123,
      "totalGoals": 123,
      "totalPlannerItems": 123
    },
    "byRole": [
      {
        "role": "<string>",
        "companiesAssigned": 123,
        "averageAuditScore": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
roleType
string

Filter by role type

Maximum string length: 100
​
assignedUserId
string<uuid>

Filter by assigned user ID

Response

Portfolio summary

​
data
object
required