Reports API

Reports API allow you to get detailed report on error and performance of your app. You can use this API for any third party dashboards.

Get full report

This API is used to get error and performance metrics for the specific duration.

Request
GET /api/browser/reports
Sample Request
curl  "https://api.atatus.com/api/browser/reports?admin_api_key=79769089efbb4767a542e0696448e34c&timeDur=7d"
Parameters
Name Description
timeDur Required The time duration. Eg: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M, 2M, 3M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd.
Format: YYYY-MM-DD+HH:mm Eg: timeStart=2017-03-01+00:00&timeEnd=2017-03-06+00:00
Response
{
   "apdex" : {
      "page" : {
         "score" : 0.78,
         "satisfied" : 1557,
         "tolerated" : 1009,
         "frustrated" : 69,
         "total" : 2635
      }
   },
   "errors" : {
      "device" : {
         "desktop" : 13,
         "mobile" : 12
      },
      "errors" : 7,
      "events" : 25
   },
   "pages" : {
      "throughput" : 2635,
      "page" : {
         "throughput" : 2635,
         "loadTime" : 3115.16,
         "frontendTime" : 2562.49,
         "networkTime" : 552.67,
         "renderTime" : 804.67,
         "domTime" : 1757.82
      },
      "spa" : {
         "throughput" : 0,
         "spaTime" : 0,
         "javascriptTime" : 0,
         "waitTime" : 0
      }
   },
   "ajax" : {
      "throughput" : 22577,
      "errorCount" : 242,
      "responseTime" : 1151.94,
      "callbackTime" : 104.54,
      "totalTime" : 1256.48,
      "receivedSize" : 6136.09,
      "sentSize" : 161.9
   },
   "transactions" : {
      "totalCount" : 118,
      "successCount" : 84,
      "failureCount" : 34,
      "successTime" : 4431.38,
      "failureTime" : 803.78
   }
}
Get experience report

Experience report gives you the statistics about how your users are actually experiencing your web site.

Request
GET /api/browser/reports/apdex
Sample Request
curl  "https://api.atatus.com/api/browser/reports/apdex?admin_api_key=79769089efbb4767a542e0696448e34c&timeDur=7d"
Parameters
Name Description
timeDur Required The time duration. Eg: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M, 2M, 3M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd.
Format: YYYY-MM-DD+HH:mm Eg: timeStart=2017-03-01+00:00&timeEnd=2017-03-06+00:00
Response
{
  "page" : {
     "score" : 0.78,
     "satisfied" : 1557,
     "tolerated" : 1009,
     "frustrated" : 69,
     "total" : 2635
  }
}
Get errors report

This API is used to get only error metrics for the specific duration.

Request
GET /api/browser/reports/errors
Sample Request
curl  "https://api.atatus.com/api/browser/reports/errors?admin_api_key=79769089efbb4767a542e0696448e34c&timeDur=7d"
Parameters
Name Description
timeDur Required The time duration. Eg: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M, 2M, 3M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd.
Format: YYYY-MM-DD+HH:mm Eg: timeStart=2017-03-01+00:00&timeEnd=2017-03-06+00:00
Response
{
  "device" : {
     "desktop" : 13,
     "mobile" : 12
  },
  "errors" : 7,
  "events" : 25
}

Get pages report

This API is used to get only page metrics for the specific duration.

Request
GET /api/browser/reports/pages
Sample Request
curl  "https://api.atatus.com/api/browser/reports/pages?admin_api_key=79769089efbb4767a542e0696448e34c&timeDur=7d"
Parameters
Name Description
timeDur Required The time duration. Eg: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M, 2M, 3M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd.
Format: YYYY-MM-DD+HH:mm Eg: timeStart=2017-03-01+00:00&timeEnd=2017-03-06+00:00
Response
{
  "throughput" : 2635,
  "page" : {
     "throughput" : 2635,
     "loadTime" : 3115.16,
     "frontendTime" : 2562.49,
     "networkTime" : 552.67,
     "renderTime" : 804.67,
     "domTime" : 1757.82
  },
  "spa" : {
     "throughput" : 0,
     "spaTime" : 0,
     "javascriptTime" : 0,
     "waitTime" : 0
  }
}
Get Ajax report

This API is used to get only ajax metrics for the specific duration.

Request
GET /api/browser/reports/ajax
Sample Request
curl  "https://api.atatus.com/api/browser/reports/ajax?admin_api_key=79769089efbb4767a542e0696448e34c&timeDur=7d"
Parameters
Name Description
timeDur Required The time duration. Eg: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M, 2M, 3M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd.
Format: YYYY-MM-DD+HH:mm Eg: timeStart=2017-03-01+00:00&timeEnd=2017-03-06+00:00
Response
{
  "throughput" : 22577,
  "errorCount" : 242,
  "responseTime" : 1151.94,
  "callbackTime" : 104.54,
  "totalTime" : 1256.48,
  "receivedSize" : 6136.09,
  "sentSize" : 161.9
}
Get transactions report

This API is used to get only transaction metrics for the specific duration.

Request
GET /api/browser/reports/transactions
Sample Request
curl  "https://api.atatus.com/api/browser/reports/transactions?admin_api_key=79769089efbb4767a542e0696448e34c&timeDur=7d"
Parameters
Name Description
timeDur Required The time duration. Eg: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M, 2M, 3M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd.
Format: YYYY-MM-DD+HH:mm Eg: timeStart=2017-03-01+00:00&timeEnd=2017-03-06+00:00
Response
{
  "totalCount" : 118,
  "successCount" : 84,
  "failureCount" : 34,
  "successTime" : 4431.38,
  "failureTime" : 803.78
}
Document Sections