Documentation

Insights

Views, shares and click-throughs — what is counted, what is deliberately not, and why.

Two different questions, answered by two endpoints:

  • What did we issue? GET /api/org/credentials/analytics — volumes by status, type, programme and month, plus email delivery and offer acceptance.
  • Did any of it land? GET /api/org/insights/engagement — views, shares and click-throughs, broken down by channel, referring site, country and day.

Both need analytics:view. Engagement needs the insights plan feature.

What is counted

Kind Recorded when
VIEW A check page, embedded card or badge image was opened
SHARE The holder pushed it somewhere — LinkedIn, WhatsApp, a copied link
CLICK Somebody arrived at a credential from a third-party surface

A view is counted in the browser, not on the server. The check page is cached for 30 seconds, so a server-side count would record one view per cache fill rather than one per reader.

What is deliberately not collected

No IP address. No user agent. No cookie. No visitor identifier of any kind.

The product tells you that your credential was looked at and roughly from where. It does not build a profile of the people doing the looking — they have no account here and never agreed to be measured. Concretely:

  • source is a referrer host, parsed down to the hostname. A full referrer URL routinely carries search terms and sometimes session tokens, and neither belongs in an analytics table.
  • country comes from the hosting edge when it provides one, and is never derived from an IP address by us.
  • Our own hosts are excluded, so the top traffic source on your account is not our check page linking to itself.

Nothing at all is recorded for minors

When a recipient carries isMinor or analyticsSuppressed, no row is written — not an anonymised one, not an aggregate increment.

India's DPDP Rules ban tracking and behavioural monitoring of under-18s, and the Rule 12 carve-out is for "a Data Fiduciary who is an educational institution" — a SaaS vendor is not one, so the obligation applies to us directly. The absence of the data is the control. A row that exists but is filtered on read is a control that lasts until somebody writes a query that forgets.

The practical consequence: a school's engagement figures may be empty, and that is the system working.

Breakdowns

curl "https://api.example.com/api/org/insights/engagement?days=30" \
  -H "Authorization: Bearer $TOKEN"
{
  "totals": { "views": 412, "shares": 38, "clicks": 17 },
  "byChannel": [{ "kind": "SHARE", "channel": "linkedin", "count": 22 }],
  "bySource": [{ "source": "linkedin.com", "views": 96, "clicks": 12 }],
  "byCountry": [{ "country": "IN", "count": 301 }],
  "byDay": [{ "date": "2026-11-12", "views": 31, "shares": 2, "clicks": 1 }]
}

Per recipient: GET /api/org/insights/recipients?days=30, ordered by total engagement — the question it answers is "whose credentials are actually being looked at", and nobody scrolls to find that out.

Per credential: GET /api/org/credentials/:id/engagement.

Export

GET /api/org/insights/export?days=30&format=xlsx — also csv and pdf. Needs analytics:export.

Scheduled reports

A monthly or quarterly summary, emailed with a spreadsheet attached.

PUT /api/org/reports
{ "period": "MONTHLY", "recipients": ["[email protected]"], "isEnabled": true }

Recipients are plain addresses, not members: the person who wants the monthly numbers is often a registrar or a finance contact with no login, and requiring a seat to receive a PDF would be charging for a mailing list.

The figures are frozen as sent. Regenerating March's report in September gives different answers — credentials have been revoked, recipients redacted, engagement accumulated — and somebody who filed the March email needs the copy in their folder to match. Each run stores its own summary.

A period is sent at most once. A failed run is not retried automatically: a wrong address retried every minute would destroy the sending domain's reputation. Fix the addresses and resend from the dashboard.

Needs analytics:reports to change recipients, and the scheduledReports plan feature.