Viewrium Docs
HTTP referenceBeacon

Record a viewer event

POST/v1/beacon

Records a view, an AR entry or an AR session's end, as the embed does. Accepts a publishable key from one of your allowed domains. Always answers 204; only a malformed body is refused (422).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

One viewer event from the embed: a view, entering AR, or an AR session ending (with its duration).

Response Body

application/json

curl -X POST "https://example.com/v1/beacon" \  -H "Content-Type: application/json" \  -d '{    "model_id": "f8ff2fb8-4acc-4e48-bd83-cbdac23e1224",    "event_type": "view"  }'
Empty
{  "error": {    "code": "string",    "message": "string",    "details": null  }}

Get usage GET

Event counts per hour or day over a window (default: the last 30 days), with totals and AR session time. Reads one organization (`org_id`, or your only one), every one you reach (`scope=all`), or one product (`product_id`). Your organization's own traffic is left out unless `include_internal=true`. `group_by=product` adds `by_product`: the window's best-performing products, ranked by 3D views then AR entries, each with its title. `400` when `start` is not before `end`.

List webhook endpoints GET

Lists your organization's webhook endpoints.