Skip to main content
GET

Authorization

string
required
Bearer token. Format: Bearer neyrs_live_abc123def456

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