analytics

Read a site's visitor numbers

Page views of the live site by people, with pages, sources, countries and devices, over a period. No credits. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.

GET/v1/sites/{site_id}/analytics

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/analytics' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/analytics"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/analytics", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>/analytics");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.atelier201.com/v1/sites/<site_id>/analytics", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>/analytics"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>/analytics")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "period": "today",
    "from": "<string>",
    "to": "<string>",
    "visitor_counting": true,
    "totals": {
      "views": 123.45,
      "visitors": null,
      "visits": null,
      "bounce_rate": null,
      "visit_seconds": null,
      "views_per_visit": null
    },
    "previous": {
      "views": 123.45,
      "visitors": null,
      "visits": null,
      "bounce_rate": null,
      "visit_seconds": null,
      "views_per_visit": null
    },
    "series": [
      {
        "at": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "pages": [
      {
        "key": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "sources": [
      {
        "key": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "countries": [
      {
        "key": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "devices": [
      {
        "key": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "browsers": [
      {
        "key": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "os": [
      {
        "key": "<string>",
        "views": 123.45,
        "visitors": null
      }
    ],
    "bot_views": 123.45,
    "updated_at": null
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Requires sites:read. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.

Authorizations

Authorizationbearerin headerrequired

Path parameters

site_idstringrequired

The site's id, or its slug (the address before .atelier201.page).

Query parameters

periodenum<string>one of: today, 7d, 30d, 90d, 12m

today, 7d, 30d, 90d or 12m. Default 30d.

Response

application/json

Read a site's visitor numbers

dataobjectrequired

Show child attributes

data.periodenum<string>requiredone of: today, 7d, 30d, 90d, 12m

data.fromstringrequired

First UTC day covered.

data.tostringrequired

Last UTC day covered: yesterday when today's live read was not available.

data.visitor_countingbooleanrequired

False when the owner turned visitor counting off: the visitor figures are then null.

data.totalsobjectrequired

Show child attributes

data.totals.viewsnumberrequired

data.totals.visitorsnumbernullrequired

data.totals.visitsnumbernullrequired

data.totals.bounce_ratenumbernullrequired

Share of visits with a single page view, 0 to 1.

data.totals.visit_secondsnumbernullrequired

data.totals.views_per_visitnumbernullrequired

data.previousobject | nullrequired

The same number of days just before. Null when there is no data then, and for today.

Show child attributes

data.previous.viewsnumberrequired

data.previous.visitorsnumbernullrequired

data.previous.visitsnumbernullrequired

data.previous.bounce_ratenumbernullrequired

Share of visits with a single page view, 0 to 1.

data.previous.visit_secondsnumbernullrequired

data.previous.views_per_visitnumbernullrequired

data.seriesobject[]required

Show child attributes

data.series.atstringrequired

data.series.viewsnumberrequired

data.series.visitorsnumbernullrequired

data.pagesobject[]required

Show child attributes

data.pages.keystringrequired

data.pages.viewsnumberrequired

data.pages.visitorsnumbernullrequired

data.sourcesobject[]required

Where views arrived from. Clicks inside the site are not arrivals, so these add up to fewer than the total.

Show child attributes

data.sources.keystringrequired

data.sources.viewsnumberrequired

data.sources.visitorsnumbernullrequired

data.countriesobject[]required

Show child attributes

data.countries.keystringrequired

data.countries.viewsnumberrequired

data.countries.visitorsnumbernullrequired

data.devicesobject[]required

Show child attributes

data.devices.keystringrequired

data.devices.viewsnumberrequired

data.devices.visitorsnumbernullrequired

data.browsersobject[]required

Show child attributes

data.browsers.keystringrequired

data.browsers.viewsnumberrequired

data.browsers.visitorsnumbernullrequired

data.osobject[]required

Show child attributes

data.os.keystringrequired

data.os.viewsnumberrequired

data.os.visitorsnumbernullrequired

data.bot_viewsnumberrequired

Views by bots, kept apart from every figure above.

data.updated_atstringnullrequired

When the last full day was rolled up. Null before the first night.

request_idstringrequired

{ "data": { "period": "today", "from": "<string>", "to": "<string>", "visitor_counting": true, "totals": { "views": 123.45, "visitors": null, "visits": null, "bounce_rate": null, "visit_seconds": null, "views_per_visit": null }, "previous": { "views": 123.45, "visitors": null, "visits": null, "bounce_rate": null, "visit_seconds": null, "views_per_visit": null }, "series": [ { "at": "<string>", "views": 123.45, "visitors": null } ], "pages": [ { "key": "<string>", "views": 123.45, "visitors": null } ], "sources": [ { "key": "<string>", "views": 123.45, "visitors": null } ], "countries": [ { "key": "<string>", "views": 123.45, "visitors": null } ], "devices": [ { "key": "<string>", "views": 123.45, "visitors": null } ], "browsers": [ { "key": "<string>", "views": 123.45, "visitors": null } ], "os": [ { "key": "<string>", "views": 123.45, "visitors": null } ], "bot_views": 123.45, "updated_at": null }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Read a site's visitor numbers

Authorizations

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies