Transactions API help you to get the performance metrics of custom transactions.

Getting a list of transactions

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

GET /v2/projects/:projectId/transactions

Sample

copy
icon/buttons/copy 
curl -H "X-API-KEY: <YOUR_API_KEY>" \
     "https://api.atatus.com/v2/projects/<projectId>/transactions?timeDur=7d"
copy
icon/buttons/copy 
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
     "https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/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. 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": "5943fb053f4e9cd4834bb34fa25752ad",
      "name": "SignUp",
      "successCount": 1,
      "failureCount": 0,
      "totalCount": 1,
      "successTime": 17,
      "failureTime": 0,
      "throughputPercentage": 33.33,
      "underOnePercent": false
    },
    {
      "id": "d9776f0775997b2e698c6975420b5c5d",
      "name": "Reset Password",
      "successCount": 1,
      "failureCount": 0,
      "totalCount": 1,
      "successTime": 16,
      "failureTime": 0,
      "throughputPercentage": 33.33,
      "underOnePercent": false
    },
    {
      "id": "15b4df284e1c41e278f991a25e930c28",
      "name": "Forgot Password",
      "successCount": 1,
      "failureCount": 0,
      "totalCount": 1,
      "successTime": 17,
      "failureTime": 0,
      "throughputPercentage": 33.33,
      "underOnePercent": false
    }
  ],
  "stats": {
    "failureTime": 0,
    "successTime": 16.67,
    "successCount": 3,
    "failureCount": 0,
    "totalCount": 3
  }
}

Getting a specific transaction by Id

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

GET /v2/projects/:projectId/transactions/:transactionId

Sample

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

{
  "data": [
    {
      "id": "5943fb053f4e9cd4834bb34fa25752ad",
      "name": "SignUp",
      "successCount": 1,
      "failureCount": 0,
      "totalCount": 1,
      "successTime": 17,
      "failureTime": 0,
      "throughputPercentage": 33.33,
      "underOnePercent": false
    },
  ],
  "stats": {
    "failureTime": 0,
    "successTime": 16,
    "successCount": 1,
    "failureCount": 0,
    "totalCount": 1
  }
}

Getting a transactions with specific path

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

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

Sample

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

{
  "data": [
    {
      "id": "d9776f0775997b2e698c6975420b5c5d",
      "name": "Reset Password",
      "successCount": 1,
      "failureCount": 0,
      "totalCount": 1,
      "successTime": 16,
      "failureTime": 0,
      "throughputPercentage": 33.33,
      "underOnePercent": false
    },
    {
      "id": "15b4df284e1c41e278f991a25e930c28",
      "name": "Forgot Password",
      "successCount": 1,
      "failureCount": 0,
      "totalCount": 1,
      "successTime": 17,
      "failureTime": 0,
      "throughputPercentage": 33.33,
      "underOnePercent": false
    }
  ],
  "stats": {
    "failureTime": 0,
    "successTime": 16.5,
    "successCount": 2,
    "failureCount": 0,
    "totalCount": 2
  }
}