Get portal verifications

Return a verification analytics timeseries for the authenticated portal session’s end user.

Authenticates only with a portal session cookie and always restricts results to verification events attributed to the session’s external identity. Unlike analytics.getVerifications, this endpoint takes a fixed time window (no query language) and returns a zero-filled, outcome-broken-out timeseries. Bucket granularity is chosen automatically from the window size.

POST /v2/portal.getVerifications

Python (SDK)

Python

from unkey.py import Unkey, models


with Unkey() as unkey:

    res = unkey.portal.get_verifications(security=models.PortalGetVerificationsSecurity(
        portal_session="<YOUR_API_KEY_HERE>",
    ), start_time=1704067200000, end_time=1704672000000, key_id="key_1234abcd")

    # Handle response
    print(res)

200

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "time": 1704067200000,
      "total": 123,
      "valid": 123,
      "rateLimited": 123,
      "insufficientPermissions": 123,
      "forbidden": 123,
      "disabled": 123,
      "expired": 123,
      "usageExceeded": 123
    }
  ]
}

Authorizations

portal_session · string · cookie · required

Browser session cookie for the Customer Portal. Set by portal.exchangeSession and sent automatically by the browser on portal.* requests. Portal sessions are scoped to a single end user (external identity) and can only access the portal.* routes.

Body

application/json

startTime · integer<int64> · required

Start of the query window as a unix timestamp in milliseconds (inclusive).

Example:

1704067200000

endTime · integer<int64> · required

End of the query window as a unix timestamp in milliseconds (exclusive). Bucket granularity (minute, hour, or day) is chosen automatically from the window size.

Example:

1704672000000

keyId · string

Optional. Restrict results to a single key. The key must belong to the authenticated end user; results are always scoped to the session identity regardless of this value.

Example:

"key_1234abcd"

Response

200

application/json

Successfully retrieved verification analytics.

meta · object · required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data · object[] · required

Zero-filled verification timeseries for the authenticated end user, ordered by time ascending. Buckets with no verifications are present with zero counts so the series is contiguous across the requested window.

Show child attributes