Get UTM Campaign Stats

curl --request GET \
  --url http://localhost:8080/website/{hostname}/campaigns \
  --cookie _me_sess=

const options = {method: 'GET', headers: {cookie: '_me_sess='}};

fetch('http://localhost:8080/website/{hostname}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/website/{hostname}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "_me_sess=",
]);

$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 := "http://localhost:8080/website/{hostname}/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "_me_sess=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/website/{hostname}/campaigns")

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

request = Net::HTTP::Get.new(url)
request["cookie"] = '_me_sess='

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

[
  {
    "campaign": "<string>",
    "visitors": 123,
    "visitors_percentage": 123,
    "bounce_percentage": 123,
    "duration": 123
  }
]

{
  "error": {
    "code": 400,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 403,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 404,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 500,
    "message": "<string>"
  }
}

GET

website

{hostname}

campaigns

Get UTM Campaign Stats

curl --request GET \
  --url http://localhost:8080/website/{hostname}/campaigns \
  --cookie _me_sess=

const options = {method: 'GET', headers: {cookie: '_me_sess='}};

fetch('http://localhost:8080/website/{hostname}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/website/{hostname}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "_me_sess=",
]);

$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 := "http://localhost:8080/website/{hostname}/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "_me_sess=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/website/{hostname}/campaigns")

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

request = Net::HTTP::Get.new(url)
request["cookie"] = '_me_sess='

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

[
  {
    "campaign": "<string>",
    "visitors": 123,
    "visitors_percentage": 123,
    "bounce_percentage": 123,
    "duration": 123
  }
]

{
  "error": {
    "code": 400,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 403,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 404,
    "message": "<string>"
  }
}

{
  "error": {
    "code": 500,
    "message": "<string>"
  }
}

Authorizations

_me_sess

string

required

Session token for authentication.

Path Parameters

hostname

string<hostname>

required

Hostname for the website.

Required string length: 1 - 253

Query Parameters

summary

boolean

default:false

Return a summary of the stats.

start

string<date-time>

Period start date using date-time notation in RFC3339 format, for example, (2017-07-21T17:32:28Z).

end

string<date-time>

Period end date using fdate-time notation in RFC3339 format, for example, (2017-07-21T17:32:28Z).

path

object

Path of the page.

Show child attributes

referrer

object

Referrer URL of the page hit.

Show child attributes

utm_source

object

UTM source of the page hit.

Show child attributes

utm_medium

object

UTM medium of the page hit.

Show child attributes

utm_campaign

object

UTM campaign of the page hit.

Show child attributes

browser

object

Browser name.

Show child attributes

object

Operating system name.

Show child attributes

device

object

Device type.

Show child attributes

country

object

Country name.

Show child attributes

language

object

Language code.

Show child attributes

prop_name

object

Name of the property.

Show child attributes

prop_value

object

Value of the property.

Show child attributes

limit

integer

Limit the number of results.

Required range: 1 <= x <= 5000

offset

integer

Offset the results paired with the limit parameter.

Required range: 0 <= x <= 5000

Cookies

_me_sess

string

required

Session token for authentication.

Example:

"_me_sess=token; Path=/; HttpOnly; SameSite=Lax; Secure"

Response

campaign

string

required

UTM campaign.

visitors

integer

required

Number of unique visitors from UTM campaign.

visitors_percentage

number<float>

required

Percentage of unique visitors from UTM campaign relative to all visitors.

bounce_percentage

number<float>

Bounce rate percentage from UTM campaign.

duration

integer

Total time spent on page from UTM campaign in milliseconds.

API Reference

Authentication

Event

User

Website

Stats

Get UTM Campaign Stats

Authorizations

Path Parameters

Query Parameters

Cookies

Response