Read API endpoints
Personal API tokens give read-only access to a documented subset of the Nexly API. This page lists what a token can call. See Personal API tokens for how to create and store a token.
Basics
- Base URL:
https://app.nexly.to - Authentication:
Authorization: Bearer nxp_your_token - Method:
GETonly. Personal tokens cannot create, update, or delete anything. - Anything not listed here answers
401 Unauthorizedfor a personal token, including account management, credential, and team administration endpoints.
curl \
-H "Authorization: Bearer nxp_your_token" \
"https://app.nexly.to/v1/properties/PROPERTY_ID/stats"
Property ids come from GET /v1/apps.
Account and properties
| Endpoint | Returns |
|---|---|
GET /v1/account | The token owner's account identity. |
GET /v1/apps | Properties the token owner can access. |
GET /v1/dashboard/summary | Headline summary across all accessible properties. |
GET /v1/properties/{id} | Property detail. |
Traffic analytics
| Endpoint | Returns |
|---|---|
GET /v1/properties/{id}/stats | Headline stats for a period. |
GET /v1/properties/{id}/timeseries | Visitors, visits, and pageviews over time. |
GET /v1/properties/{id}/realtime | Currently active sessions. |
GET /v1/properties/{id}/acquisition | Sources, channels, and campaigns. |
GET /v1/properties/{id}/top-pages | Top pages. |
GET /v1/properties/{id}/entry-pages | Entry pages. |
GET /v1/properties/{id}/exit-pages | Exit pages. |
GET /v1/properties/{id}/top-countries | Top countries. |
GET /v1/properties/{id}/top-regions | Top regions. |
GET /v1/properties/{id}/top-cities | Top cities. |
GET /v1/properties/{id}/top-browsers | Browser breakdown. |
GET /v1/properties/{id}/top-devices | Device breakdown. |
GET /v1/properties/{id}/top-os | Operating system breakdown. |
GET /v1/properties/{id}/stickiness | Monthly stickiness. |
GET /v1/properties/{id}/time-heatmap | Visits by weekday and hour. |
Events
| Endpoint | Returns |
|---|---|
GET /v1/properties/{id}/events | The raw events feed. |
GET /v1/properties/{id}/custom-events | Custom event breakdown. |
GET /v1/properties/{id}/custom-properties | Custom property breakdown. |
GET /v1/properties/{id}/custom-definitions | Registered custom event definitions. |
Bots and AI crawlers
| Endpoint | Returns |
|---|---|
GET /v1/properties/{id}/bots/overview | Bot traffic overview. |
GET /v1/properties/{id}/bots/coverage | Bot coverage breakdown. |
GET /v1/properties/{id}/bots/ai-referrals | Traffic referred by AI assistants. |
GET /v1/properties/{id}/top-clients | Top non-browser clients. |
Reports
| Endpoint | Returns |
|---|---|
GET /v1/properties/{id}/reports | Generated reports for a property. |
GET /v1/properties/{id}/reports/{report_id} | A single report. |
Anomalies
| Endpoint | Returns |
|---|---|
GET /v1/properties/{id}/anomalies | Detected anomalies. |
Errors
401 Unauthorized— the token is missing, revoked, malformed, or the endpoint is not part of the read API.404 Not Found— the property exists but the token owner has no access to it, or the id is wrong.429 Too Many Requests— slow down; API reads are rate limited.