Dynamic query
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schema_name": "analytics_log",
"query_type": "stats",
"query": {
"aggregate": [
{
"type": "COUNT",
"field_name": "id",
"alias": "events_count"
}
],
"group_by": {
"fields": "origin_source",
"having_condition": [
{
"field_name": "events_count",
"operator": "greater",
"value": 2000
}
]
},
"filters": [
{
"field_name": "origin_source",
"operator": "is-not-empty",
"value": null
}
],
"sort_by": {
"origin_source": "asc"
},
"limit": 25,
"offset": 0
}
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query"
payload = {
"schema_name": "analytics_log",
"query_type": "stats",
"query": {
"aggregate": [
{
"type": "COUNT",
"field_name": "id",
"alias": "events_count"
}
],
"group_by": {
"fields": "origin_source",
"having_condition": [
{
"field_name": "events_count",
"operator": "greater",
"value": 2000
}
]
},
"filters": [
{
"field_name": "origin_source",
"operator": "is-not-empty",
"value": None
}
],
"sort_by": { "origin_source": "asc" },
"limit": 25,
"offset": 0
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
schema_name: 'analytics_log',
query_type: 'stats',
query: {
aggregate: [{type: 'COUNT', field_name: 'id', alias: 'events_count'}],
group_by: {
fields: 'origin_source',
having_condition: [{field_name: 'events_count', operator: 'greater', value: 2000}]
},
filters: [{field_name: 'origin_source', operator: 'is-not-empty', value: null}],
sort_by: {origin_source: 'asc'},
limit: 25,
offset: 0
}
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'schema_name' => 'analytics_log',
'query_type' => 'stats',
'query' => [
'aggregate' => [
[
'type' => 'COUNT',
'field_name' => 'id',
'alias' => 'events_count'
]
],
'group_by' => [
'fields' => 'origin_source',
'having_condition' => [
[
'field_name' => 'events_count',
'operator' => 'greater',
'value' => 2000
]
]
],
'filters' => [
[
'field_name' => 'origin_source',
'operator' => 'is-not-empty',
'value' => null
]
],
'sort_by' => [
'origin_source' => 'asc'
],
'limit' => 25,
'offset' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query"
payload := strings.NewReader("{\n \"schema_name\": \"analytics_log\",\n \"query_type\": \"stats\",\n \"query\": {\n \"aggregate\": [\n {\n \"type\": \"COUNT\",\n \"field_name\": \"id\",\n \"alias\": \"events_count\"\n }\n ],\n \"group_by\": {\n \"fields\": \"origin_source\",\n \"having_condition\": [\n {\n \"field_name\": \"events_count\",\n \"operator\": \"greater\",\n \"value\": 2000\n }\n ]\n },\n \"filters\": [\n {\n \"field_name\": \"origin_source\",\n \"operator\": \"is-not-empty\",\n \"value\": null\n }\n ],\n \"sort_by\": {\n \"origin_source\": \"asc\"\n },\n \"limit\": 25,\n \"offset\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schema_name\": \"analytics_log\",\n \"query_type\": \"stats\",\n \"query\": {\n \"aggregate\": [\n {\n \"type\": \"COUNT\",\n \"field_name\": \"id\",\n \"alias\": \"events_count\"\n }\n ],\n \"group_by\": {\n \"fields\": \"origin_source\",\n \"having_condition\": [\n {\n \"field_name\": \"events_count\",\n \"operator\": \"greater\",\n \"value\": 2000\n }\n ]\n },\n \"filters\": [\n {\n \"field_name\": \"origin_source\",\n \"operator\": \"is-not-empty\",\n \"value\": null\n }\n ],\n \"sort_by\": {\n \"origin_source\": \"asc\"\n },\n \"limit\": 25,\n \"offset\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_name\": \"analytics_log\",\n \"query_type\": \"stats\",\n \"query\": {\n \"aggregate\": [\n {\n \"type\": \"COUNT\",\n \"field_name\": \"id\",\n \"alias\": \"events_count\"\n }\n ],\n \"group_by\": {\n \"fields\": \"origin_source\",\n \"having_condition\": [\n {\n \"field_name\": \"events_count\",\n \"operator\": \"greater\",\n \"value\": 2000\n }\n ]\n },\n \"filters\": [\n {\n \"field_name\": \"origin_source\",\n \"operator\": \"is-not-empty\",\n \"value\": null\n }\n ],\n \"sort_by\": {\n \"origin_source\": \"asc\"\n },\n \"limit\": 25,\n \"offset\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"content": {
"data": [
{}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": 123,
"limit": 25,
"next_page": 123
}
}
}Analytics
Dynamic query
Retrive analytics data as per dynamic query passed.
POST
/
analytics
/
dynamic-query
Dynamic query
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schema_name": "analytics_log",
"query_type": "stats",
"query": {
"aggregate": [
{
"type": "COUNT",
"field_name": "id",
"alias": "events_count"
}
],
"group_by": {
"fields": "origin_source",
"having_condition": [
{
"field_name": "events_count",
"operator": "greater",
"value": 2000
}
]
},
"filters": [
{
"field_name": "origin_source",
"operator": "is-not-empty",
"value": null
}
],
"sort_by": {
"origin_source": "asc"
},
"limit": 25,
"offset": 0
}
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query"
payload = {
"schema_name": "analytics_log",
"query_type": "stats",
"query": {
"aggregate": [
{
"type": "COUNT",
"field_name": "id",
"alias": "events_count"
}
],
"group_by": {
"fields": "origin_source",
"having_condition": [
{
"field_name": "events_count",
"operator": "greater",
"value": 2000
}
]
},
"filters": [
{
"field_name": "origin_source",
"operator": "is-not-empty",
"value": None
}
],
"sort_by": { "origin_source": "asc" },
"limit": 25,
"offset": 0
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
schema_name: 'analytics_log',
query_type: 'stats',
query: {
aggregate: [{type: 'COUNT', field_name: 'id', alias: 'events_count'}],
group_by: {
fields: 'origin_source',
having_condition: [{field_name: 'events_count', operator: 'greater', value: 2000}]
},
filters: [{field_name: 'origin_source', operator: 'is-not-empty', value: null}],
sort_by: {origin_source: 'asc'},
limit: 25,
offset: 0
}
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'schema_name' => 'analytics_log',
'query_type' => 'stats',
'query' => [
'aggregate' => [
[
'type' => 'COUNT',
'field_name' => 'id',
'alias' => 'events_count'
]
],
'group_by' => [
'fields' => 'origin_source',
'having_condition' => [
[
'field_name' => 'events_count',
'operator' => 'greater',
'value' => 2000
]
]
],
'filters' => [
[
'field_name' => 'origin_source',
'operator' => 'is-not-empty',
'value' => null
]
],
'sort_by' => [
'origin_source' => 'asc'
],
'limit' => 25,
'offset' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query"
payload := strings.NewReader("{\n \"schema_name\": \"analytics_log\",\n \"query_type\": \"stats\",\n \"query\": {\n \"aggregate\": [\n {\n \"type\": \"COUNT\",\n \"field_name\": \"id\",\n \"alias\": \"events_count\"\n }\n ],\n \"group_by\": {\n \"fields\": \"origin_source\",\n \"having_condition\": [\n {\n \"field_name\": \"events_count\",\n \"operator\": \"greater\",\n \"value\": 2000\n }\n ]\n },\n \"filters\": [\n {\n \"field_name\": \"origin_source\",\n \"operator\": \"is-not-empty\",\n \"value\": null\n }\n ],\n \"sort_by\": {\n \"origin_source\": \"asc\"\n },\n \"limit\": 25,\n \"offset\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schema_name\": \"analytics_log\",\n \"query_type\": \"stats\",\n \"query\": {\n \"aggregate\": [\n {\n \"type\": \"COUNT\",\n \"field_name\": \"id\",\n \"alias\": \"events_count\"\n }\n ],\n \"group_by\": {\n \"fields\": \"origin_source\",\n \"having_condition\": [\n {\n \"field_name\": \"events_count\",\n \"operator\": \"greater\",\n \"value\": 2000\n }\n ]\n },\n \"filters\": [\n {\n \"field_name\": \"origin_source\",\n \"operator\": \"is-not-empty\",\n \"value\": null\n }\n ],\n \"sort_by\": {\n \"origin_source\": \"asc\"\n },\n \"limit\": 25,\n \"offset\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/dynamic-query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_name\": \"analytics_log\",\n \"query_type\": \"stats\",\n \"query\": {\n \"aggregate\": [\n {\n \"type\": \"COUNT\",\n \"field_name\": \"id\",\n \"alias\": \"events_count\"\n }\n ],\n \"group_by\": {\n \"fields\": \"origin_source\",\n \"having_condition\": [\n {\n \"field_name\": \"events_count\",\n \"operator\": \"greater\",\n \"value\": 2000\n }\n ]\n },\n \"filters\": [\n {\n \"field_name\": \"origin_source\",\n \"operator\": \"is-not-empty\",\n \"value\": null\n }\n ],\n \"sort_by\": {\n \"origin_source\": \"asc\"\n },\n \"limit\": 25,\n \"offset\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"content": {
"data": [
{}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": 123,
"limit": 25,
"next_page": 123
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Was this page helpful?
⌘I