Get sites overview stats REST API

GET

/api/sites/overview

const url = 'https://hitkeep.com/api/sites/overview';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

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/sites/overview \
  --cookie hk_token=<hk_token>

Returns lightweight overview metrics and chart data for all sites visible to the caller.

Authorizations

Parameters

Query Parameters

from

string format: date-time

Responses

200

Sites overview stats

application/json

object

sites

required

Array<object>

object

bounce_rate

required

number

chart_data

required

Array<object>

object

pageviews

integer

time

string format: date-time

visitors

integer

error

string

site_id

required

string format: uuid

status

required

string

Allowed values: ready error

total_pageviews

required

integer

unique_sessions

required

integer

Example

{
  "sites": [
    {
      "status": "ready"
    }
  ]
}