Modifier un KPI personnalisé

PATCH

https://core.shopimind.com/v1/custom-stats/kpis/{id}

Modifie le nom, la description, les mesures, les dimensions ou les filtres d'un KPI personnalisé. Quand ils sont fournis, measures, dimensions et filters remplacent toute la liste existante. La source, les relations et le champ de temps ne sont pas modifiables : créer un nouveau KPI à la place. Modifier les mesures ou les dimensions reconstruit la table d'agrégat, et les mesures reçoivent de nouveaux identifiants : mettre à jour les widgets qui y font référence.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key, in the form {prefix}.{secret}.

Type

string

Required

Example"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU"

Pattern

"^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"

Path Parameters

id*

Identifier of the custom KPI to update (id_custom_kpi).

Type

string

Required

Example"3"

Request Body

application/json

{

  

"name": {

  

},

  

"description": {

  

},

  

"measures": [

  

  

{

  

  

  

"id_measure": "string",

  

  

  

"type": "string",

  

  

  

"field": "t.amount",

  

  

  

"label": {

  

  

  

},

  

  

  

"format": "number",

  

  

  

"suffix": "string",

  

  

  

"position": 0

  

  

}

  

],

  

"dimensions": [

  

  

{

  

  

  

"id_dimension": "string",

  

  

  

"field": "t.status",

  

  

  

"label": {

  

  

  

},

  

  

  

"position": 0

  

  

}

  

],

  

"filters": [

  

  

{

  

  

  

"field": "t.amount",

  

  

  

"operator": "string",

  

  

  

"value": {

  

  

  

}

  

  

}

  

]

}

Responses

Custom KPI updated successfully.

Content-Type

application/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"

  

  

  

}

  

  

]

  

}

}

PATCH

https://core.shopimind.com/v1/custom-stats/kpis/{id}

Playground

Headers

spm-api-key*

Variables

Key

Value

id*

Body

Samples

Modifier un KPI personnalisé Modifie le nom, la description, les mesures, les dimensions ou les filtres d'un KPI personnalisé. Quand ils sont fournis, measures, dimensions et filters remplacent toute la liste existante. La source, les relations et le champ de temps ne sont pas modifiables : créer un nouveau KPI à la place. Modifier les mesures ou les dimensions reconstruit la table d'agrégat, et les mesures reçoivent de nouveaux identifiants : mettre à jour les widgets qui y font référence. PATCH /v1/custom-stats/kpis/{id} updateCustomKpi Custom KPIs spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. id Identifier of the custom KPI to update (id_custom_kpi). Custom KPI updated successfully. Client error - Invalid request or authentication issues Server error - Internal processing failure