Get an insight card
The stored insight card of one spot for the property: dashboard_run_out (products about to run out), category_returns (needs category_col), campaign_break_even, save_settings_stock or competitor_comparison.
GET /properties/{propertyId}/insights
Scope read · Access Read only · Operation id insights.get
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID first.
productmetrics insights get \
--property-id $PROPERTY_ID \
--spot dashboard_run_out \
--jsonResponse
API response (200), shortened:
{
"data": {
"spot": "dashboard_run_out",
"feedKey": "all",
"card": {
"state": "ready",
"spot": "dashboard_run_out",
"insightId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"feedKey": "all",
"categoryColumn": "custom_label_0",
"computedAt": "2026-11-02T09:30:00.000Z"
// … 10 more fields
}
},
"request_id": "req_01JXDYME5BK0BFJNCA9DAA5NR0"
}CLI output: productmetrics insights get --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
card is null until the nightly insights job stored one; without Product Segmentation access the card is a sample (state sample), not the property’s data.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | The property id, from productmetrics whoami or properties.list (property_id). |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
feed_scope | string | No | Which feed of the property: a feed id, or all for the property-wide settings. |
spot | enum | Yes | The stored insight card of one spot for the property: dashboard_run_out (products about to run out), category_returns (needs category_col), campaign_break_even, save_settings_stock or competitor_comparison. One of dashboard_run_out, category_returns, campaign_break_even, save_settings_stock, competitor_comparison. |
category_col | enum | No | The stored insight card of one spot for the property: dashboard_run_out (products about to run out), category_returns (needs category_col), campaign_break_even, save_settings_stock or competitor_comparison. One of custom_label_0, custom_label_1, custom_label_2, custom_label_3, custom_label_4, product_type_1, product_type_2, product_type_3, product_type_4, product_type_5. |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the read scope; connect again and allow it.",
"details": {
"required_scope": "read"
}
},
"request_id": "req_01JMDH4001A3V8X3SFXJ8PWFMM"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the read scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |