​
Portfolio API

The portfolio API provides executive-level project portfolio views including health dashboards, risk heat maps, RACI matrices, and project drill-down. All procedures require organization-level authentication (orgProcedure).

​
portfolio.getOverview

Get the portfolio overview with project health summary and key metrics.

Input Schema:

{
  workspaceId?: string;       // Scope to workspace (optional)
  healthFilter?: "all" | "on-track" | "at-risk" | "critical";
  sortBy?: "name" | "health" | "progress" | "dueDate";
}

Output:

{
  projects: Array<{
    id: string;
    name: string;
    health: "on-track" | "at-risk" | "critical";
    progress: number;          // 0-100 percentage
    dueDate: Date | null;
    owner: string;
    kpiSummary: { green: number; amber: number; red: number };
  }>;
  summary: {
    total: number;
    onTrack: number;
    atRisk: number;
    critical: number;
  };
}

​
portfolio.getProjectDetail

Get detailed view of a single project for drill-down navigation.

Input Schema:

{
  projectId: string;
}

​
portfolio.getRiskHeatMap

Get risk heat map data showing probability vs. impact for all active risks.

Input Schema:

{
  workspaceId?: string;
  projectId?: string;
}

Output:

{
  risks: Array<{
    id: string;
    title: string;
    probability: number;      // 1-5 scale
    impact: number;           // 1-5 scale
    status: string;
    projectName: string;
  }>;
}

​
portfolio.getRaciMatrix

Get the RACI matrix for a project showing responsibility assignments.

Input Schema:

{
  projectId: string;
}

Output:

{
  activities: Array<{
    id: string;
    name: string;
    assignments: Array<{
      userId: string;
      userName: string;
      role: "R" | "A" | "C" | "I";
    }>;
  }>;
}

​
Permissions

ProcedureRequired Role
All portfolio proceduresAny authenticated member

Was this page helpful?

Benchmarking APIGxP & E-Signatures API