Retrieve a analytics session
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}', 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/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"session": {
"id": "<string>",
"last_seen": "2023-11-07T05:31:56Z",
"origin_url": "<string>",
"origin_source": "<string>",
"utm_params": {
"utm_source": "<string>",
"utm_campaign": "<string>",
"utm_medium": "<string>"
},
"initial_origin_source": "<string>",
"initial_utm_params": {
"utm_source": "<string>",
"utm_campaign": "<string>",
"utm_medium": "<string>"
},
"initial_origin_url": "<string>",
"user_id": "<string>",
"is_anonymous": true,
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"activities": [
{
"id": "<string>",
"event_type": "track",
"event_name": "<string>",
"event_schema_id": "<string>",
"session_id": "<string>",
"session_origin_url": "<string>",
"session_last_seen": "2023-11-07T05:31:56Z",
"user_id": "<string>",
"event_data": {},
"channel": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"message_id": "<string>",
"original_timestamp": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"received_at": "2023-11-07T05:31:56Z",
"anonymous_id": "<string>"
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"previous_page": 123,
"limit": 25,
"next_page": 123
}
}
}Analytics
Retrieve a analytics session
Retrieves a session and its paginated activity list.
GET
/
analytics
/
sessions
/
{id}
Retrieve a analytics session
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}', 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/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/analytics/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"session": {
"id": "<string>",
"last_seen": "2023-11-07T05:31:56Z",
"origin_url": "<string>",
"origin_source": "<string>",
"utm_params": {
"utm_source": "<string>",
"utm_campaign": "<string>",
"utm_medium": "<string>"
},
"initial_origin_source": "<string>",
"initial_utm_params": {
"utm_source": "<string>",
"utm_campaign": "<string>",
"utm_medium": "<string>"
},
"initial_origin_url": "<string>",
"user_id": "<string>",
"is_anonymous": true,
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"activities": [
{
"id": "<string>",
"event_type": "track",
"event_name": "<string>",
"event_schema_id": "<string>",
"session_id": "<string>",
"session_origin_url": "<string>",
"session_last_seen": "2023-11-07T05:31:56Z",
"user_id": "<string>",
"event_data": {},
"channel": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"message_id": "<string>",
"original_timestamp": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"received_at": "2023-11-07T05:31:56Z",
"anonymous_id": "<string>"
}
],
"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.
Path Parameters
session id
Query Parameters
page number of pagination list
Required range:
x >= 1no of rows per page
Required range:
x >= 1Was this page helpful?
⌘I