Atatus groups similar exceptions that we call errors.
Getting a list of all errors
To get a list of all errors, send the following request:
GET /v2/projects/:projectId/errors
Sample
copy
curl -H "X-API-KEY: <YOUR_API_KEY>" \
"https://api.atatus.com/v2/projects/<projectId>/errors?timeDur=7d&status=Open&limit=2&sortby=lastAt"
copy
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
"https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/errors?timeDur=7d&status=Open&limit=2&sortby=lastAt"
Parameters
Some of the following parameters are required to monitor and identify the errors present in your application.
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 |
status (Required) | Only errors with the status. Example: Open, Resolved, Ignored |
browser | Only errors with the given browser: Chrome, Firefox, Safari, IE, Opera, Mobile Safari, Android Browser |
browserVersion | Only errors with the given browser version: 4.0, 11.0, 37.0, 47.0 |
os | Only errors with the given OS: Windows, Mac OS, Linux, iOS, Android |
osVersion | Only errors with the given OS version: 7, 8.1, 10.04, 10.8 |
version | Only errors with the given app version |
tags | Only errors with the given tags |
url | Only errors with the given url |
user | Only errors with the given user |
device | Only errors with the given device. Example, desktop and mobile devices |
message | Search by name of the error |
limit | Number of errors to be returned. Range between 1 and 100 |
page | Page number. Pagination parameter used to select the page to retrieve |
sortby | Sort by: events, firstAt, lastAt |
Response
{
"data" : [
{
"id" : "257113987:d34f4eab8d1255681716992d5fa42419",
"hashName" : "d34f4eab8d1255681716992d5fa42419",
"message" : "Cannot read property '7' of undefined",
"status" : "Open",
"users" : 15,
"events" : 28,
"comments" : 7,
"bugHerdLink" : "",
"pivotalLink" : "",
"jiraLink" : "",
"asanaLink" : "",
"youTrackLink" : "",
"lighthouseLink" : "",
"projectId" : "257113987",
"teamId" : "736128479015720349",
"trends" : [ 7, 0, 0, 1, 0, 9, 0, 5, 0, 0, 2, 0, 0, 4 ],
"created" : "2020-02-02T16:55:58.572Z",
"firstAt" : "2020-02-02T16:55:58.572Z",
"lastAt" : "2020-02-02T16:55:58.572Z"
},
{
"id" : "257113987:d36f22f1cc8fdba76e4b1d4ce46b25cd",
"hashName" : "d36f22f1cc8fdba76e4b1d4ce46b25cd",
"message" : "$scope1 is not defined",
"status" : "Open",
"users" : 5,
"events" : 12,
"comments" : 4,
"bugHerdLink" : "",
"pivotalLink" : "",
"jiraLink" : "",
"asanaLink" : "",
"youTrackLink" : "",
"lighthouseLink" : "",
"projectId" : "257113987",
"teamId" : "736128479015720349",
"trends" : [ 2, 0, 0, 1, 0, 0, 4, 0, 1, 0, 3, 0, 0, 1 ],
"created" : "2020-01-31T07:22:49.607Z",
"firstAt" : "2020-01-31T07:22:49.607Z",
"lastAt" : "2020-01-31T07:22:49.607Z"
}
],
"trendDates" : [ "2020-01-29 12:00", "2020-01-30 00:00", "2020-01-30 12:00", "2020-01-31 00:00", "2020-01-31 12:00", "2020-02-01 00:00", "2020-02-01 12:00", "2020-02-02 00:00", "2020-02-02 12:00", "2020-02-03 00:00", "2020-02-03 12:00", "2020-02-04 00:00", "2020-02-04 12:00", "2020-02-05 00:00" ],
"count" : 2,
"limit" : 2,
"page" : 1,
"totalCount" : 4,
"totalPages" : 2,
"hasMore" : true
}
Getting a specific error
To get only a specific error detail, send the following request:
GET /v2/projects/:projectId/errors/:errorId
Sample
copy
curl -H "X-API-KEY: <YOUR_API_KEY>" \
"https://api.atatus.com/v2/projects/<projectId>/errors/<errorId>?timeDur=7d"
copy
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
"https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/errors/d36f22f1cc8fdba76e4b1d4ce46b25cd?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. |
errorId (Required) | ID of the specific error |
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 |
browser | Only errors with the given browser: Chrome, Firefox, Safari, IE, Opera, Mobile Safari, Android Browser |
browserVersion | Only errors with the given browser version: 4.0, 11.0, 37.0, 47.0 |
os | Only errors with the given OS: Windows, Mac OS, Linux, iOS, Android |
osVersion | Only errors with the give OS version: 7, 8.1, 10.04, 10.8 |
version | Only errors with the given app version |
tags | Only errors with the given tags |
url | Only errors with the given url |
user | Only errors with the given user |
device | Only errors with the given device. Example, desktop and mobile devices |
Response
{
"id" : "257113987:d36f22f1cc8fdba76e4b1d4ce46b25cd",
"hashName" : "d36f22f1cc8fdba76e4b1d4ce46b25cd",
"message" : "$scope1 is not defined",
"status" : "Open",
"users" : 5,
"events" : 12,
"comments" : 4,
"bugHerdLink" : "",
"pivotalLink" : "",
"jiraLink" : "",
"asanaLink" : "",
"youTrackLink" : "",
"lighthouseLink" : "",
"projectId" : "257113987",
"teamId" : "736128479015720349",
"trends" : [ 2, 0, 0, 1, 0, 0, 4, 0, 1, 0, 3, 0, 0, 1 ],
"created" : "2020-01-31T07:22:49.607Z",
"firstAt" : "2020-01-31T07:22:49.607Z",
"lastAt" : "2020-01-31T07:22:49.607Z"
}
Getting a list of error events
Atatus represents individual crashes in your application that we call events. To get the details of a specific error event, send the following request:
GET /v2/projects/:projectId/errors/:errorId/events
Sample
copy
curl -H "X-API-KEY: <YOUR_API_KEY>" \
"https://api.atatus.com/v2/projects/<projectId>/errors/<errorId>/events?timeDur=7d"
copy
curl -H "X-API-KEY: 79769089efbb4767a542e0696448e34c" \
"https://api.atatus.com/v2/projects/5c7cb42cdbe639200c330e52/errors/d36f22f1cc8fdba76e4b1d4ce46b25cd/events?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. |
errorId (Required) | ID of the specific error |
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 |
browser | Only errors with the given browser: Chrome, Firefox, Safari, IE, Opera, Mobile Safari, Android Browser |
browserVersion | Only errors with the given browser version: 4.0, 11.0, 37.0, 47.0 |
os | Only errors with the given OS: Windows, Mac OS, Linux, iOS, Android |
osVersion | Only errors with the give OS version: 7, 8.1, 10.04, 10.8 |
version | Only errors with the given app version |
tags | Only errors with the given tags |
url | Only errors with the given url |
user | Only errors with the given user |
device | Only errors with the given device. Example: desktop and mobile devices |
limit | Number of errors to be returned. Range between 1 and 100 |
page | Page number. Pagination parameter used to select the page to retrieve |
Response
{
"data" : [
{
"class" : "ReferenceError",
"name" : "$scope1 is not defined",
"groupName" : "$scope1 is not defined",
"id" : "HmlfE32601V3",
"errorId" : "743648921:d36f22f1cc8fdba76e4b1d4ce46b25cd",
"backTraces" : [
{
"cn" : 5,
"f" : "http://localhost:8080/scripts/controllers/dashboard-controller.js",
"m" : "new DashboardController",
"ln" : 21
},
{
"f" : "http://localhost:8080/bower_components/angular/angular.min.js",
"cn" : 109,
"ln" : 42,
"m" : "Object.instantiate"
},
{
"cn" : 374,
"f" : "http://localhost:8080/bower_components/angular/angular.min.js",
"ln" : 91,
"m" : "at "
}
],
"breadCrumbs" : [
{
"ts" : 1485847368811,
"a" : "click",
"e" : "a ng-click=\"goToReport('daily')\" tooltip=\"Daily Report\""
}
],
"url" : {
"queryParams" : "?timeDur=1d",
"groupHash" : "a4e3686498384b986c00fe42b4105b9a",
"group" : "http://localhost:8080/app/*/dashboard",
"raw" : "http://localhost:8080/app/743648921/dashboard"
},
"user" : {
"id" : "164353474",
"name" : "John Doe",
"email" : "john_doe@acme.com",
"hash" : "d0f42b3974b6af7d4c02b98dc929dc92"
},
"env" : {
"device" : "Desktop",
"os" : "Mac OS",
"osVersion" : "10.10.1",
"browserVersion" : "55.0.2883.95",
"browser" : "Chrome",
"ip" : "81.137.100.158"
},
"geo" : {
"asn" : "AS2856",
"country" : "GB",
"region" : "ENG"
},
"request" : {
"h" : 1080,
"ua" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.95 Safari/537.36",
"url" : "http://localhost:8080/app/743648921/dashboard",
"w" : 1920
},
"customData" : {},
"tags" : [ "production", "paid_user" ],
"version" : "1.0.0",
"sourcemap" : false,
"agentVersion" : "3.0.0",
"teamId" : "736128479015720349",
"projectId" : "257113987",
"sid" : "601665c988804881b22576046b132b42",
"timestamp" : "2020-01-31T07:22:49.607Z"
}
],
"count" : 1,
"limit" : 20,
"page" : 1,
"totalCount" : 1,
"totalPages" : 1,
"hasMore" : false
}