v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Dimensions

Retrieve all available dimensions per account. See below a list of main Suggested Dimensions

get/messaging/v3/stores/{store_id}/analytics/explore/dimensions

Path parameters

store_idstring required

The store ID (app_key)

Query parameters

access_tokenstring required

Your Yotpo access token. Click here to learn how to generate one

Request body

{"stackTrail":"paths:/messaging/v3/stores/{store_id}/analytics/explore/dimensions:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

namestring

descriptionstring

categorystring

label_shortstring

typestring

Example response

[
  {
    "name": "channel_type",
    "description": "communication channel related to this entity (SMS, Email...)",
    "category": "dimension",
    "label_short": "Channel Type",
    "type": "string"
  }
]