List the fields of a custom KPI source

GET

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

Returns the fields usable in a KPI built on the given source, including the fields of the joined relations. Use each field's path in measures, dimensions, time_field and filters. A field reached through a one-to-many relation (relationCardinality: many) can only be used in filters.

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

Query Parameters

sourceType*

Type of the source, as returned by listCustomKpiSources.

Type

string

Required

Valid values

"custom""system"

sourceSchema*

Name of the source schema (schemaName).

Type

string

Required

Example"orders"

relationsChain

Comma-separated relation names to join, 3 at most (e.g. "contacts,sessions").

Type

string

Responses

Available fields.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": [

  

  

{

  

  

  

"path": "t.amount",

  

  

  

"alias": "t",

  

  

  

"column": "amount",

  

  

  

"sqlExpression": "`t`.`amount`",

  

  

  

"label": "Montant TTC",

  

  

  

"type": "decimal",

  

  

  

"source": "main",

  

  

  

"relationPath": [

  

  

  

  

"contacts"

  

  

  

],

  

  

  

"relationCardinality": "one"

  

  

}

  

]

}

GET

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

Playground

Headers

spm-api-key*

Variables

Key

Value

sourceType*

sourceSchema*

relationsChain

Samples

List the fields of a custom KPI source Returns the fields usable in a KPI built on the given source, including the fields of the joined relations. Use each field's path in measures, dimensions, time_field and filters. A field reached through a one-to-many relation (relationCardinality: many) can only be used in filters. GET /v1/custom-stats/kpis/fields listCustomKpiFields Custom KPIs spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. sourceType Type of the source, as returned by listCustomKpiSources. sourceSchema Name of the source schema (schemaName). relationsChain Comma-separated relation names to join, 3 at most (e.g. "contacts,sessions"). Available fields. Client error - Invalid request or authentication issues Server error - Internal processing failure