Preview a custom KPI

POST

https://core.shopimind.com/v1/custom-stats/kpis/preview

Computes a KPI configuration over the last preview_days days (7 by default, 30 at most) without saving anything. Returns up to 100 computed rows, the executed SQL, the number of source rows read and the query duration. Same body and validation as createCustomKpi.

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_-]+$"

Request Body

application/json

{

  

"name": {

  

},

  

"description": {

  

},

  

"source_type": "string",

  

"source_schema_name": "orders",

  

"relations_chain": [

  

  

"contacts"

  

],

  

"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

  

  

}

  

],

  

"time_field": "t.date_creation",

  

"time_field_explicit": true,

  

"filters": [

  

  

{

  

  

  

"field": "t.amount",

  

  

  

"operator": "string",

  

  

  

"value": {

  

  

  

}

  

  

}

  

],

  

"lookback_max_months": 12,

  

"preview_days": 7

}

Responses

Preview computed successfully.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"rows": [

  

  

  

{

  

  

  

}

  

  

],

  

  

"rowCount": 1,

  

  

"sql": "string",

  

  

"previewDays": 7,

  

  

"sourceRowsScanned": 842,

  

  

"durationMs": 38

  

}

}

POST

https://core.shopimind.com/v1/custom-stats/kpis/preview

Playground

Headers

spm-api-key*

Body

Samples

Preview a custom KPI Computes a KPI configuration over the last preview_days days (7 by default, 30 at most) without saving anything. Returns up to 100 computed rows, the executed SQL, the number of source rows read and the query duration. Same body and validation as createCustomKpi. POST /v1/custom-stats/kpis/preview previewCustomKpi Custom KPIs spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. Preview computed successfully. Client error - Invalid request or authentication issues Server error - Internal processing failure