List custom KPIs
GET
https://core.shopimind.com/v1/custom-stats/kpis
Returns every custom KPI of the shop with its measures and dimensions, most recent first. The list is not paginated.
Parameters
Header Parameters
spm-api-key*
[Authentication] Required API key, in the form {prefix}.{secret}.
Type
Requiredstring
Example
"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU"Pattern
"^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"Responses
Custom KPIs of the shop.
application/json
JSON "statusCode": 200, "data": [ { "id_custom_kpi": "3", "id_shop": 1234, "name": { }, "description": { }, "source_type": "system", "source_schema_name": "orders", "source_table_name": "shopyminddata.shops_orders", "relations_chain": [ "contacts" ], "filters_json": [ { "field": "t.amount", "operator": "string", "value": { } } ], "time_field": "t.date_creation", "time_field_explicit": true, "aggregate_table_name": "kpi_1234_3_agg", "aggregate_procedure_name": "kpi_1234_3_aggregate", "aggregate_event_name": "kpi_1234_3_event", "status": "active", "last_event_run_at": "2026-05-04T10:00:00.000Z", "last_error": "string", "lookback_max_months": 12, "id_user_creator": "58", "id_user_modifier": "string", "created_at": "2026-05-04T09:12:00.000Z", "updated_at": "2026-05-04T09:12:00.000Z", "measures": [ { "id_measure": "12", "id_custom_kpi": "3", "type": "sum", "field": "t.amount", "format": "currency", "suffix": "string", "label_json": { }, "label": { }, "position": 0, "created_at": "2026-05-04T09:12:00.000Z", "updated_at": "2026-05-04T09:12:00.000Z" } ], "dimensions": [ { "id_dimension": "7", "id_custom_kpi": "3", "field": "t.status", "label_json": { }, "label": { }, "column_index": 1, "position": 0, "created_at": "2026-05-04T09:12:00.000Z", "updated_at": "2026-05-04T09:12:00.000Z" } ] } ]
{
}
List custom KPIs Returns every custom KPI of the shop with its measures and dimensions, most recent first. The list is not paginated. GET /v1/custom-stats/kpis listCustomKpis Custom KPIs spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. Custom KPIs of the shop. Client error - Invalid request or authentication issues Server error - Internal processing failure