POST:analytics/custom_report.json
Commerce APIPOST:analytics/custom_report.json

POST:analytics/custom_report.json

Description

Execute or analyze custom SQL query.

Permission bit: "analytics.read"

Topic: Analytics

Query Parameters

analyze_only: Boolean

Analyze only, don't execute

Example: ?analyze_only=true


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

AnalyticsQuery

{
  "query": "",
  "variables": [
    {
      "key": "",
      "value": ""
    }
  ]
}

Response Body

AnalyticsReport

Response Body Type

Loading module