The Apdex (Application Performance Index) score provides insight into how users perceive the performance of your application. You can use the Apdex API to programmatically access these metrics.

Getting Apdex Metrics

To retrieve Apdex metrics for a specific project and time range, use the following endpoint:

GET /v2/projects/:projectId/apdex

Sample Requests

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/apdex?timeDur=7d"
copy
icon/buttons/copy 
# Includes filters (e.g., for a specific route)
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/apdex?timeDur=7d&search=/health"
copy
icon/buttons/copy 
curl -H "X-API-KEY: ak_daaa54399f0a4d77b971b118ed21fb82" \
     "https://api.atatus.com/v2/projects/67aae79855bb5c77c2d6f4c3/apdex?timeDur=7d"

Parameters

Name (Required) Description
apiKey API Key to read data. See here to generate a new API Key.
projectId A unique identifier for the project. See here
timeDur The time duration for which to fetch the Apdex score. Examples: 30m, 1d, 7d, 1M, etc.

Response

{
  "satisfied": 3076,
  "tolerated": 539,
  "frustrated": 0,
  "score": 0.925,
  "total": 3615,
  "satisfiedPercentage": 85.0899,
  "toleratedPercentage": 14.9101,
  "frustratedPercentage": 0
}

This response provides detailed insights into how many requests fall into each satisfaction category and the overall Apdex score.