Skip to content
bynhDocs
Log in

Get trust center visitors

GET/workspaces/{workspace}/visitors

Shows who reads your trust center over the last 7, 30 or 90 days: visits, companies that requested access and what they opened, anonymous visits, a daily series, most-opened items and top referrers.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Query parameters

  • rangeenumdefault 30

    Days. “Pick 7, 30 or 90 days.” One of 7, 30, 90.

Response

200 OK

Visitor stats.

  • rangeintegerDays.
  • statsobjectvisits, visits_change (percent vs the previous period, or null), companies, documents_opened, documents_behind_nda, badge_clicks, badge_sites.
  • companies[]objectBy email domain: name, domain, people, status (localized: NDA signed | access shared | waiting for approval | access ended | declined), visits, opened (titles), last_seen_at.
  • anonymous{visits, last_seen_at}Visitors with no access request.
  • series[]{day, visits}One per day in the range.
  • most_opened[]{label, count}Most-opened sections and documents.
  • referrers[]{host, views}Top 5 referring hosts.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.
404The token belongs to another workspace, or its owner is no longer a member.
422range not 7, 30 or 90.

Every error is JSON with a message. See Errors.

curl "https://api.bynh.io/api/v1/workspaces/dokan/visitors?range=30" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": {
    "range": 30,
    "stats": {
      "visits": 1284,
      "visits_change": 12,
      "companies": 9,
      "documents_opened": 57,
      "documents_behind_nda": 21,
      "badge_clicks": 140,
      "badge_sites": 3
    },
    "companies": [
      {
        "name": "Almarai Retail",
        "domain": "almarai-retail.sa",
        "people": 2,
        "status": "NDA signed",
        "visits": 6,
        "opened": [
          "ISO 27001 certificate 2025",
          "SOC 2 Type II report"
        ],
        "last_seen_at": "2026-09-30T13:40:00+00:00"
      }
    ],
    "anonymous": {
      "visits": 1201,
      "last_seen_at": "2026-10-01T08:12:00+00:00"
    },
    "series": [
      {
        "day": "2026-09-02",
        "visits": 38
      },
      {
        "day": "2026-09-03",
        "visits": 41
      }
    ],
    "most_opened": [
      {
        "label": "Status",
        "count": 312
      },
      {
        "label": "ISO 27001 certificate 2025",
        "count": 44
      }
    ],
    "referrers": [
      {
        "host": "dokan.sa",
        "views": 690
      },
      {
        "host": "www.google.com",
        "views": 211
      }
    ]
  }
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.