Pages API help you to get the performance metrics of any page.

Getting a list of pages

To get a list of pages and its metrics for a specific duration, send the following request:

GET /v2/projects/:projectId/pages

Sample

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

{
    "data" : [
        {
            "id" : "f580a7b276828278f764106d29007a15",
            "url" : "https://www.acme.com/app/dashboard",
            "throughput" : 7,
            "throughputPercentage" : 15.21,
            "underOnePercent" : false,
            "page" : {
                "throughput" : 7,
                "loadTime" : 608.72,
                "frontendTime" : 567.43,
                "networkTime" : 41.29,
                "domTime" : 413.86,
                "renderTime" : 153.57,
                "percentile_99" : 770.04,
                "percentile_95" : 766.2,
                "percentile_90" : 761.4,
                "percentile_50" : 576,
                "percentile_75" : 722.5,
                "throughputPercentage" : 15.21,
                "timeConsumedPercentage" : 3.24,
                "loadTimePercentage" : 5,
                "underOnePercent" : false
            }
        }
    ],
    "count" : 0,
    "limit" : 0,
    "page" : 0,
    "totalPages" : 0,
    "totalCount" : 0,
    "hasMore" : false,
}

Getting a specific page by Id

To get a page and metrics for a specific time duration, send the following request:

GET /v2/projects/:projectId/pages/:pageId

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/pages/<pageId>?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/pages/f580a7b276828278f764106d29007a15?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. See here to locate the Project ID
pageId (Required) ID of the specific page
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

{
    "id" : "f580a7b276828278f764106d29007a15",
    "url" : "https://www.acme.com/app/dashboard",
    "throughput" : 7,
    "throughputPercentage" : 15.21,
    "underOnePercent" : false,
    "page" : {
        "throughput" : 7,
        "loadTime" : 608.72,
        "frontendTime" : 567.43,
        "networkTime" : 41.29,
        "domTime" : 413.86,
        "renderTime" : 153.57,
        "percentile_99" : 770.04,
        "percentile_95" : 766.2,
        "percentile_90" : 761.4,
        "percentile_50" : 576,
        "percentile_75" : 722.5,
        "throughputPercentage" : 15.21,
        "timeConsumedPercentage" : 3.24,
        "loadTimePercentage" : 5,
        "underOnePercent" : false
    }
}

Getting a page with specific path

You can search for specific pages with search query parameter. It allows you to search for a specific keyword in the path field.

GET /v2/projects/:projectId/pages?search=keyword

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/pages?search=<KEY_WORD>&timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/pages?search=dashboard&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. See here to locate the Project ID
search Keyword for search pages.
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

{
  "stats": {
    "page": {
      "loadTime": 14068500,
      "renderTime": 2155875,
      "networkTime": 93375,
      "domTime": 11819250,
      "throughput": 16,
      "errorCount": 88
    }
  },
  "data": [
    {
      "id": "f580a7b276828278f764106d29007a15",
      "url": "https://www.acme.com/app/dashboard-list/*",
      "throughput": 8,
      "loadTime": 17026,
      "domTime": 14050.75,
      "networkTime": 100.25,
      "renderTime": 2875,
      "frontendTime": 16925.75,
      "satisfied": 0,
      "tolerated": 8,
      "frustrated": 0,
      "score": 0.5,
      "percentile_50": 17727.5,
      "percentile_75": 18129,
      "percentile_90": 18894,
      "percentile_95": 18894,
      "percentile_99": 18894,
      "exceptionRate": 937.5,
      "errorCount": 75,
      "page": {
        "loadTime": 17026,
        "renderTime": 2875,
        "networkTime": 100.25,
        "domTime": 14050.75,
        "frontendTime": 16925.75,
        "throughput": 8,
        "percentile_50": 17727.5,
        "percentile_75": 18129,
        "percentile_90": 18894,
        "percentile_95": 18894,
        "percentile_99": 18894
      },
      "timeConsumed": 136208,
      "timeConsumedPercentage": 60.51,
      "throughputPercentage": 50,
      "underOnePercent": false,
      "errorPercentage": 100
    }
  ]
}