Shared site stats REST API

GET

/api/share/{token}/sites/{id}/stats

const url = 'https://hitkeep.com/api/share/example/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stats';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://hitkeep.com/api/share/example/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stats

Returns stats through share token.

Parameters

Path Parameters

token

required

string

required

string format: uuid

Query Parameters

from

string format: date-time

filter

string

Filter in form type:value (repeatable). Supported types: path, hostname, referrer, referrer_host, device, country, city, provider, asn, browser, language, utm_campaign, utm_content, utm_medium, utm_source, utm_term, qr_code_id.

filter_type

string

filter_value

string

goal_id

string format: uuid

funnel_id

string format: uuid

Responses

200

Site stats

application/json

object

ai_bot_hits

integer

ai_source_visits

integer

avg_session_duration

number

bounce_rate

number

chart_data

Array<object>

object

pageviews

integer

time

string format: date-time

visitors

integer

funnels

Array<object>

object

created_at

string format: date-time

string format: uuid

name

string

site_id

string format: uuid

steps

Array<object>

object

type

string

Allowed values: event path

value

string

goals

Array<object>

object

conversion_rate

number

conversions

integer

goal_id

string format: uuid

name

string

imported_excluded

Array<object>

object

detail

string

reason

string

live_visitors

integer

pages_per_session

number

top_ai_bots

Array<object>

object

name

string

value

integer

top_ai_sources

Array<object>

object

name

string

value

integer

top_asns

Array<object>

object

name

string

value

integer

top_cities

Array<object>

object

name

string

value

integer

top_countries

Array<object>

object

name

string

value

integer

top_devices

Array<object>

object

name

string

value

integer

top_exit_pages

Array<object>

object

name

string

value

integer

top_landing_pages

Array<object>

object

name

string

value

integer

top_languages

Array<object>

object

name

string

value

integer

top_pages

Array<object>

object

name

string

value

integer

top_providers

Array<object>

object

name

string

value

integer

top_referrers

Array<object>

object

name

string

value

integer

top_utm_campaigns

Array<object>

object

name

string

value

integer

top_utm_contents

Array<object>

object

name

string

value

integer

top_utm_mediums

Array<object>

object

name

string

value

integer

top_utm_sources

Array<object>

object

name

string

value

integer

top_utm_terms

Array<object>

object

name

string

value

integer

total_pageviews

integer

unique_sessions

integer

utm_campaign_hits

integer

utm_content_hits

integer

utm_medium_hits

integer

utm_source_hits

integer

utm_term_hits

integer

Example

{
  "funnels": [
    {
      "steps": [
        {
          "type": "event"
        }
      ]
    }
  ]
}