Count a view or a read

POST

/api/v1/stats/hit

const url = 'https://example.com/api/v1/stats/hit';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"event":"view","id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","kind":"home","locale":"th","referrer":"example","width":1}'
};

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

curl --request POST \
  --url https://example.com/api/v1/stats/hit \
  --header 'Content-Type: application/json' \
  --data '{ "event": "view", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "home", "locale": "th", "referrer": "example", "width": 1 }'

Answers 204 whether or not the hit was counted. In bundled mode only this site may send; in headless mode any origin may, with Content-Type: application/json.

Request Body^required

application/json

object

event

required

string

Allowed values: view read

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: home post page

locale

required

string

Allowed values: th en

referrer

string

<= 2048 characters

width

required

integer

>= 1 <= 20000

Responses

204

Received. The answer is the same whether or not the hit was counted.

Count a view or a read

Request Bodyrequired

Responses

204

Request Body^required