curl --request GET \
--url 'https://api.neyrs.cloud/v1/analytics/metrics?startDate=2024-03-01&endDate=2024-03-08' \
--header 'Authorization: Bearer neyrs_live_abc123def456'
const response = await fetch(
'https://api.neyrs.cloud/v1/analytics/metrics?startDate=2024-03-01&endDate=2024-03-08',
{
headers: {
'Authorization': `Bearer ${process.env.NEYRS_API_KEY}`
}
}
);
import requests
response = requests.get(
'https://api.neyrs.cloud/v1/analytics/metrics',
params={
'startDate': '2024-03-01',
'endDate': '2024-03-08'
},
headers={
'Authorization': f'Bearer {api_key}'
}
)
{
"period": {
"startDate": "2024-03-01",
"endDate": "2024-03-08"
},
"sessions": {
"total": 1247,
"active": 23,
"avgDuration": 342
},
"messages": {
"total": 8934,
"avgPerSession": 7.2
},
"transactions": {
"total": 2847,
"successful": 2791,
"failed": 56,
"totalVolume": 1847392.47
}
}
Analytics
Get Metrics
Retrieve usage metrics and statistics
GET
/
v1
/
analytics
/
metrics
curl --request GET \
--url 'https://api.neyrs.cloud/v1/analytics/metrics?startDate=2024-03-01&endDate=2024-03-08' \
--header 'Authorization: Bearer neyrs_live_abc123def456'
const response = await fetch(
'https://api.neyrs.cloud/v1/analytics/metrics?startDate=2024-03-01&endDate=2024-03-08',
{
headers: {
'Authorization': `Bearer ${process.env.NEYRS_API_KEY}`
}
}
);
import requests
response = requests.get(
'https://api.neyrs.cloud/v1/analytics/metrics',
params={
'startDate': '2024-03-01',
'endDate': '2024-03-08'
},
headers={
'Authorization': f'Bearer {api_key}'
}
)
{
"period": {
"startDate": "2024-03-01",
"endDate": "2024-03-08"
},
"sessions": {
"total": 1247,
"active": 23,
"avgDuration": 342
},
"messages": {
"total": 8934,
"avgPerSession": 7.2
},
"transactions": {
"total": 2847,
"successful": 2791,
"failed": 56,
"totalVolume": 1847392.47
}
}
Authorization
string
required
Bearer token. Format:
Bearer neyrs_live_abc123def456Query Parameters
string
Start date for metrics. Format: ISO 8601 (YYYY-MM-DD)
string
End date for metrics. Format: ISO 8601 (YYYY-MM-DD)
Response
object
Time period for metricsProperties:
startDate(string): Start dateendDate(string): End date
object
Session metricsProperties:
total(number): Total sessionsactive(number): Currently active sessionsavgDuration(number): Average duration in seconds
object
Message metricsProperties:
total(number): Total messagesavgPerSession(number): Average messages per session
object
Transaction metricsProperties:
total(number): Total transactionssuccessful(number): Successful transactionsfailed(number): Failed transactionstotalVolume(number): Total volume in USD
curl --request GET \
--url 'https://api.neyrs.cloud/v1/analytics/metrics?startDate=2024-03-01&endDate=2024-03-08' \
--header 'Authorization: Bearer neyrs_live_abc123def456'
const response = await fetch(
'https://api.neyrs.cloud/v1/analytics/metrics?startDate=2024-03-01&endDate=2024-03-08',
{
headers: {
'Authorization': `Bearer ${process.env.NEYRS_API_KEY}`
}
}
);
import requests
response = requests.get(
'https://api.neyrs.cloud/v1/analytics/metrics',
params={
'startDate': '2024-03-01',
'endDate': '2024-03-08'
},
headers={
'Authorization': f'Bearer {api_key}'
}
)
{
"period": {
"startDate": "2024-03-01",
"endDate": "2024-03-08"
},
"sessions": {
"total": 1247,
"active": 23,
"avgDuration": 342
},
"messages": {
"total": 8934,
"avgPerSession": 7.2
},
"transactions": {
"total": 2847,
"successful": 2791,
"failed": 56,
"totalVolume": 1847392.47
}
}