List tracked sites, or read a site's numbers

GET

/api-v1

const url = 'https://api.nexacloser.com/v1/api-v1?action=get_sites&days=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <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://api.nexacloser.com/v1/api-v1?action=get_sites&days=1' \
  --header 'Authorization: Bearer <token>'

One endpoint, picked by action:

action=get_sites lists the websites tracked by NexaCloser analytics.
action=get_analytics&site_id=…&days=… returns visitors, page views, sessions, form conversion rate and the top page for the last days days (1 to 90, default 1).

An organization key sees every site of its workspace. A personal key sees the sites it can see in that workspace.

Authorizations

apiKey

Parameters

Query Parameters

action

required

string

Allowed values: get_sites get_analytics

site_id

string

Required for get_analytics. From get_sites.

days

integer

default: 1 >= 1 <= 90

For get_analytics. Window in days, clamped to 1–90.

Responses

200

The sites, or the site’s numbers.

application/json

One of:

object
object

object

sites

Array<object>

object

site_id

string

name

string

domain

string | null

user_id

The user the key acts as.

string

object

visitors

integer

pageviews

integer

sessions

integer

conversion_rate

Form submits ÷ form starts, in percent. null when no form was started.

integer | null

top_page

object

url

string

views

integer

Examples

{
  "sites": [
    {
      "site_id": "a1b2c3d4",
      "name": "Main website",
      "domain": "www.example.com"
    }
  ],
  "user_id": "0e985456-cd0a-4417-acb0-6faffd37b88e"
}

{
  "visitors": 12,
  "pageviews": 14,
  "sessions": 16,
  "conversion_rate": null,
  "top_page": {
    "url": "https://www.example.com/pricing",
    "views": 6
  }
}

Headers

X-RateLimit-Limit

integer

Requests allowed in the current short window.

X-RateLimit-Remaining

integer

Requests left in the current short window.

400

Missing site_id, or an unknown action (the body lists the available actions).

application/json

Older endpoints return a short English message instead of a code.

object

error

required

string

Example

{
  "error": "Missing site_id"
}

401

Missing, wrong, revoked or expired key.

application/json

Older endpoints return a short English message instead of a code.

object

error

required

string

Example

{
  "error": "Unauthorized"
}

404

The site does not exist or is not in this workspace.

application/json

Older endpoints return a short English message instead of a code.

object

error

required

string

Example

{
  "error": "Site not found"
}

429

Too many requests. Wait Retry-After seconds.

application/json

object

error

string

Allowed value: rate_limited

message

string

retry_after

Seconds to wait.

integer

Example

{
  "error": "rate_limited",
  "message": "Too many requests",
  "retry_after": 7
}

Headers

Retry-After

integer

Seconds to wait before retrying.