Twilee Docs

Page Views Resource

PageView documents track each time a hosted landing page linked to a QR code is viewed. Use this resource to monitor engagement on Twilee-hosted experiences.

Resource Representation

Each page view captures when the landing page was loaded, which QR code generated the view, and the country inferred from the visitor. Entries are returned newest first.

{
  "id": "68d12b6e7df5d4583403a912",
  "datetime": "2025-09-21T17:05:11+00:00",
  "qrCode": "/qr_codes/68cdbbe0ed096c7b590277c6",
  "country": "FR"
}

Field reference

Field Type Description
id string Unique identifier of the page view entry.
datetime datetime ISO 8601 timestamp for when the landing page was viewed.
qrCode string IRI of the QR code whose landing page was visited.
country string|null Two-letter country code derived from the visitor IP.

Note: Internal fields such as IP address, timezone, and user agent are stored for analytics but are not included in the API response.

List Page Views — GET /qr_codes/{id}/page-views

Return the landing page view history for a QR code that belongs to your team. Results are sorted by datetime descending.

curl -X GET "https://api.twilee.com/qr_codes/68cdbbe0ed096c7b590277c6/page-views" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response (JSON-LD)

{
  "@context": "/contexts/PageView",
  "@id": "/qr_codes/68cdbbe0ed096c7b590277c6/page-views",
  "@type": "Collection",
  "totalItems": 3,
  "member": [
    {
      "@id": "/page_views/68d12b6e7df5d4583403a912",
      "@type": "PageView",
      "datetime": "2025-09-21T17:05:11+00:00",
      "qrCode": "/qr_codes/68cdbbe0ed096c7b590277c6",
      "country": "FR"
    }
  ]
}

Paginate through additional records with the page parameter:

GET /qr_codes/{id}/page-views?page=2

Pagination behaves according to the default API Platform settings.