πŸ”—
Data API V1
The Data API v1 is now available. Almost all the data obtained by Nucleus can be retrieved using this API.
This API is in beta for now, please let us know if you encounter any issue or if you need to fetch a specific data that isn't documented here, we strive to be fast to respond. We will add more endpoints over time.

Authentication

Nucleus expects the API key to be included in all requests to the server in a auth header:
Authorization: your_access_token
Example:
curl "api_endpoint_here" h -H "Authorization: your_access_token"
You may also send it in the body of a POST request as the parameter token.

Quick Glance

get
https://app.nucleus.sh/api/v1/apps/:appId/analytics/quickglance
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/analytics/quickglance" -H "Authorization: your_access_token"

Daily Analytics

get
https://app.nucleus.sh/api/v1/apps/:appId/analytics
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/analytics?start=1618010248&end=1618211950&utcOffset=480" -H "Authorization: your_access_token"

Events

get
https://app.nucleus.sh/api/v1/apps/:appId/analytics/events
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/analytics/events?start=1618010248&end=1618211950&utcOffset=480" -H "Authorization: your_access_token"

Event Properties

get
https://app.nucleus.sh/api/v1/apps/:appId/analytics/eventsprops
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/analytics/eventsprops?start=1618010248&end=1618211950&utcOffset=480" -H "Authorization: your_access_token"

Event Attributes

get
https://app.nucleus.sh/api/v1/apps/:appId/analytics/events/:event/:attr
Example:
curl "https://app.nucleus.sh/api/v1/apps/appId/analytics/events/init/plan?start=1617358132&end=1617962932&utcOffset=480" -H "Authorization: your_access_token"

Errors

get
https://app.nucleus.sh/api/v1/apps/:appId/analytics/errors
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/analytics/errors?start=1618010248&end=1618211950&utcOffset=480" -H "Authorization: your_access_token"

Users

get
https://app.nucleus.sh/api/v1/apps/:appId/users
The Users list for your application.
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/users" -H "Authorization: your_access_token"

User Details

​
get
https://app.nucleus.sh/api/v1/apps/:appId/users/:userId
User data
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/users/:userId" -H "Authorization: your_access_token"

User Session Events

​
get
https://app.nucleus.sh/api/v1/apps/:appId/users/:userId/session/:sessionId
curl "https://app.nucleus.sh/api/v1/apps/:appId/users/:userId/session/:sessionId?device=:deviceId" -H "Authorization: your_access_token"

Delete User

​
delete
https://app.nucleus.sh/api/v1/apps/:appId/users/:userId
Example:
curl -X DELETE "https://app.nucleus.sh/api/v1/apps/:appId/users/:userId" -H "Authorization: your_access_token"

Live Events

​
get
https://app.nucleus.sh/api/v1/apps/:appId/live/events
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/live/events" -H "Authorization: your_access_token"

Live Users Count

get
https://app.nucleus.sh/api/v1/apps/:appId/live/users/count
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/live/users/count" -H "Authorization: your_access_tokenbh

Live Users List

​
get
https://app.nucleus.sh/api/v1/apps/:appId/live/users
Example:
curl "https://app.nucleus.sh/api/v1/apps/:appId/live/users" -H "Authorization: your_access_token"