---
title: "Get Portfolio Insights"
method: POST
path: "/v1/insights/portfolio"
tags: ["insights"]
---

# Get Portfolio Insights

`POST /v1/insights/portfolio`

## Request

- Base URL: `https://api.shapemaker.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.shapemaker.io/v1/insights/portfolio`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

## Request body

- PortfolioInsightsInput
  - `filters` PortfolioInsightsFilterInput[], required
    - `attribute` 'PRODUCT' | 'CAPACITY_STATUS' | 'UTILIZATION' | 'UNIQUE_TENANTS' | 'ENABLED_ANCILLARIES' | 'REST_CAPACITY', required
    - `comparator` 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUALS' | 'LESS_THAN' | 'LESS_THAN_OR_EQUALS', required
    - `value` string, required

## Response `200`

Successful Response

- PortfolioInsightView[]
  - `structureUuid` string, required
  - `analyzedAtUtc` string, date-time, required
  - `siteName` string, required
  - `productId` string, nullable, required
  - `lat` number, nullable, required
  - `lon` number, nullable, required
  - `maxUtilizationPercent` number, required
  - `restCapacityM2` number, required
  - `status` 'UNKNOWN' | 'OVERLOADED' | 'UNDERLOADED', required
  - `isStaleAnalysis` boolean, required
  - `ancillariesEnabledCount` integer, required
  - `uniqueTenantCount` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/shapemaker/apis/shapemaker-api.md) - [All operations](https://skmtc.dev/shapemaker/apis/shapemaker-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shapemaker/apis/shapemaker-api/revisions/b8461cf1236c?raw)