Reports API will provide you with detailed information on any of the errors and also the performance of your application. You can also use this API for any third party dashboards.

Get a full report

To get a full report on the errors and the performance of your applications in a specific time period, send the following request:

GET /v2/projects/:projectId/reports

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/reports?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/reports?timeDur=7d"

Parameters

Name Description
apiKey (Required) API Key to read data. See here to generate new API Key.
projectId (Required) A unique identifier for a project. See here to locate the Project ID
timeDur (Required) The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00

Response

Browser Project Result

{

    "apdex": {
        "page":
        {
            "satisfied": 447,
            "tolerated": 133,
            "frustrated": 5,
            "total": 585,
            "score": 0.87
        }
    },
    "pages": {
        "page": {
            "loadTime": 3559.59,
            "renderTime": 1802.37,
            "networkTime": 501.46,
            "domTime": 1255.76,
            "frontendTime": 3058.13,
            "throughput": 585,
            "percentile_50": 2452.87,
            "percentile_75": 4864,
            "percentile_90": 6189.8,
            "percentile_95": 8695.8,
            "percentile_99": 18812.08
        },
        "throughput": 585
    },
    "ajax": {
        "totalTime": 2413.36,
        "responseTime": 2413.35,
        "callbackTime": 0.01,
        "receivedSize": 12585.85,
        "sentSize": 8.79,
        "errorCount": 183,
        "errorRate": 1.58,
        "throughput": 11556,
        "percentile_50": 884.27,
        "percentile_75": 1542.67,
        "percentile_90": 3470.1,
        "percentile_95": 9834.26,
        "percentile_99": 33381.95
    },
    "transactions": {
        "successTime": 435.52,
        "failureTime": 234.45,
        "successCount": 44,
        "failureCount": 20,
        "totalCount": 64
    },
    "errors": {
        "errors": 18,
        "events": 115,
        "device": {
            "mobile": 3,
            "desktop": 112
        }
    }
}

APM Project Result

{
  "throughput": 8736210,
  "responseTime": 356.73,
  "backgroundThroughput": 781263,
  "backgroundResponseTime": 8119.47,
  "failureCount": 4483,
  "failureRate": 0.051,
  "apdexScore": 0.967
}

Get experience report (For browser project only)

Experience report gives the statistics on the users experiencing your website. To get the experience report, send the following request:

GET /v2/projects/:projectId/reports/apdex

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/reports/apdex?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/reports/apdex?timeDur=7d"

Parameters

Name Description
apiKey (Required) API Key to read data. See here to generate new API Key.
projectId (Required) A unique identifier of the project.
timeDur (Required) The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00

Response

{
    "page": {
        "satisfied": 447,
        "tolerated": 133,
        "frustrated": 5,
        "total": 585,
        "score": 0.87
    }
}

Get error report (For browser project only)

To get only the error metrics for a specific duration, send the following request:

GET /v2/projects/:projectId/reports/errors

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/reports/errors?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/reports/errors?timeDur=7d"

Parameters

Name Description
apiKey (Required) API Key to read data. See here to generate new API Key.
projectId (Required) A unique identifier of the project.
timeDur (Required) The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00

Response

{
    "device" : {
        "desktop" : 13,
        "mobile" : 12
    },
    "errors" : 7,
    "events" : 25
}

Get pages report (For browser project only)

To get only the pages metrics for a specific duration, send the following request:

GET /v2/projects/:projectId/reports/pages

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/reports/pages?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/reports/pages?timeDur=7d"

Parameters

Name Description
apiKey (Required) API Key to read data. See here to generate new API Key.
projectId (Required) A unique identifier of the project.
timeDur (Required) The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00

Response

{
    "throughput" : 585,
    "page" : {
        "loadTime": 3559.59,
        "renderTime": 1802.37,
        "networkTime": 501.46,
        "domTime": 1255.76,
        "frontendTime": 3058.13,
        "throughput": 585,
        "percentile_50": 2452.87,
        "percentile_75": 4864,
        "percentile_90": 6189.8,
        "percentile_95": 8695.8,
        "percentile_99": 18812.08
    }
}

Get Ajax report (For browser project only)

To get only the Ajax report for a specific duration, send the following request:

GET /v2/projects/:projectId/reports/ajax

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/reports/ajax?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
      "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/reports/ajax?timeDur=7d"

Parameters

Name Description
apiKey (Required) API Key to read data. See here to generate new API Key.
projectId (Required) A unique identifier of the project.
timeDur (Required) The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00

Response

{
    "totalTime": 2413.36,
    "responseTime": 2413.35,
    "callbackTime": 0.01,
    "receivedSize": 12585.85,
    "sentSize": 8.79,
    "errorCount": 183,
    "errorRate": 1.58,
    "throughput": 11556,
    "percentile_50": 884.27,
    "percentile_75": 1542.67,
    "percentile_90": 3470.1,
    "percentile_95": 9834.26,
    "percentile_99": 33381.95
}

Get transactions report (For browser project only)

To get only the transactions report for a specific duration, send the following request:

GET /v2/projects/:projectId/reports/transactions

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/reports/transactions?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
      "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/reports/transactions?timeDur=7d"

Parameters

Name Description
apiKey (Required) API Key to read data. See here to generate new API Key.
projectId (Required) A unique identifier of the project.
timeDur (Required) The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
timeStart & timeEnd Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00

Response

{
    "totalCount" : 118,
    "successCount" : 84,
    "failureCount" : 34,
    "successTime" : 4431.38,
    "failureTime" : 803.78
}