Track a page view (beacon)

POST

api

stats

analytics

track

Track a page view (beacon)

curl --request POST \
  --url https://api.itemshop.dev/api/v2/stats/analytics/track \
  --header 'Content-Type: application/json' \
  --data '
{
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "path": "/sklep",
  "serverId": "<string>",
  "productId": "<string>",
  "referrer": "<string>",
  "utmSource": "<string>",
  "utmMedium": "<string>",
  "utmCampaign": "<string>"
}
'

import requests

url = "https://api.itemshop.dev/api/v2/stats/analytics/track"

payload = {
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "path": "/sklep",
    "serverId": "<string>",
    "productId": "<string>",
    "referrer": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmCampaign": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    shopId: '664f1a2b3c4d5e6f7a8b9c0d',
    path: '/sklep',
    serverId: '<string>',
    productId: '<string>',
    referrer: '<string>',
    utmSource: '<string>',
    utmMedium: '<string>',
    utmCampaign: '<string>'
  })
};

fetch('https://api.itemshop.dev/api/v2/stats/analytics/track', 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://api.itemshop.dev/api/v2/stats/analytics/track",
  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([
    'shopId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'path' => '/sklep',
    'serverId' => '<string>',
    'productId' => '<string>',
    'referrer' => '<string>',
    'utmSource' => '<string>',
    'utmMedium' => '<string>',
    'utmCampaign' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.itemshop.dev/api/v2/stats/analytics/track"

	payload := strings.NewReader("{\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"path\": \"/sklep\",\n  \"serverId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"utmSource\": \"<string>\",\n  \"utmMedium\": \"<string>\",\n  \"utmCampaign\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.itemshop.dev/api/v2/stats/analytics/track")
  .header("Content-Type", "application/json")
  .body("{\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"path\": \"/sklep\",\n  \"serverId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"utmSource\": \"<string>\",\n  \"utmMedium\": \"<string>\",\n  \"utmCampaign\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/stats/analytics/track")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"path\": \"/sklep\",\n  \"serverId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"utmSource\": \"<string>\",\n  \"utmMedium\": \"<string>\",\n  \"utmCampaign\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {},
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Body

application/json

shopId

string

required

Shop ID

Example:

"664f1a2b3c4d5e6f7a8b9c0d"

path

string

required

Page path

Required string length: 1 - 512

Example:

"/sklep"

serverId

string

Server ID

productId

string

Product ID

referrer

string

Referrer

Maximum string length: 1024

utmSource

string

utm_source

Maximum string length: 128

utmMedium

string

utm_medium

Maximum string length: 128

utmCampaign

string

utm_campaign

Maximum string length: 128

Response

success

boolean

Example:

true

data

object

message

string

Page-view analytics

Track a page view (beacon)

curl --request POST \
  --url https://api.itemshop.dev/api/v2/stats/analytics/track \
  --header 'Content-Type: application/json' \
  --data '
{
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "path": "/sklep",
  "serverId": "<string>",
  "productId": "<string>",
  "referrer": "<string>",
  "utmSource": "<string>",
  "utmMedium": "<string>",
  "utmCampaign": "<string>"
}
'

import requests

url = "https://api.itemshop.dev/api/v2/stats/analytics/track"

payload = {
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "path": "/sklep",
    "serverId": "<string>",
    "productId": "<string>",
    "referrer": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmCampaign": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    shopId: '664f1a2b3c4d5e6f7a8b9c0d',
    path: '/sklep',
    serverId: '<string>',
    productId: '<string>',
    referrer: '<string>',
    utmSource: '<string>',
    utmMedium: '<string>',
    utmCampaign: '<string>'
  })
};

fetch('https://api.itemshop.dev/api/v2/stats/analytics/track', 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://api.itemshop.dev/api/v2/stats/analytics/track",
  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([
    'shopId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'path' => '/sklep',
    'serverId' => '<string>',
    'productId' => '<string>',
    'referrer' => '<string>',
    'utmSource' => '<string>',
    'utmMedium' => '<string>',
    'utmCampaign' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.itemshop.dev/api/v2/stats/analytics/track"

	payload := strings.NewReader("{\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"path\": \"/sklep\",\n  \"serverId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"utmSource\": \"<string>\",\n  \"utmMedium\": \"<string>\",\n  \"utmCampaign\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.itemshop.dev/api/v2/stats/analytics/track")
  .header("Content-Type", "application/json")
  .body("{\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"path\": \"/sklep\",\n  \"serverId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"utmSource\": \"<string>\",\n  \"utmMedium\": \"<string>\",\n  \"utmCampaign\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/stats/analytics/track")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"path\": \"/sklep\",\n  \"serverId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"utmSource\": \"<string>\",\n  \"utmMedium\": \"<string>\",\n  \"utmCampaign\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {},
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Getting started

Basics

Payments

Order fulfillment

Configuration

API Keys

Shops

Servers

Products

Payment Methods

Blacklist

Discounts

Vouchers

Stats

Storage

Orders

Payments

Components

Metrics

Track a page view (beacon)

Body

Response