Skip to main content
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'

{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.neyrs.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization

​
Authorization
string
required
Bearer token. Format: Bearer neyrs_live_abc123def456

​
Query Parameters

​
startDate
string
Start date for metrics. Format: ISO 8601 (YYYY-MM-DD)
​
endDate
string
End date for metrics. Format: ISO 8601 (YYYY-MM-DD)

​
Response

​
period
object
Time period for metricsProperties:
  • startDate (string): Start date
  • endDate (string): End date
​
sessions
object
Session metricsProperties:
  • total (number): Total sessions
  • active (number): Currently active sessions
  • avgDuration (number): Average duration in seconds
​
messages
object
Message metricsProperties:
  • total (number): Total messages
  • avgPerSession (number): Average messages per session
​
transactions
object
Transaction metricsProperties:
  • total (number): Total transactions
  • successful (number): Successful transactions
  • failed (number): Failed transactions
  • totalVolume (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'

{
  "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
  }
}