Save an analytics layout

Authorization

AuthorizationBearer <token>

API key from Settings → API keys

In: header

Path Parameters

storeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

name*string

Length1 <= length <= 80

metricKeys*array<>

Items1 <= items <= 8

showActivityMap?boolean

Defaultfalse

isDefault?boolean

Defaultfalse

Response Body

`application/json`

curl -X PUT "https://example.com/v1/stores/string/reporting/layouts" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "metricKeys": [      "revenue"    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "metricKeys": [    "revenue"  ],  "showActivityMap": false,  "isDefault": false,  "createdAt": "string",  "updatedAt": "string"}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`