API Reference

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

{
	// Date and time that the error occurred in ISO-8601 format
	"occurredOn": "2015-09-08T01:55:28Z",
	"details": {
		// The name of machine this error occurred on
		"machineName": "ServerMachine1",
		// Client defined error grouping key. Must be 1-100 chars, ideally the result of a hash function e.g MD5
		"groupingKey": "ErrorGroup",
		// The version number of your application.
		"version": "1.0.0.1",
		// Information about the client library you are using for talking to the Raygun API
		"client": {
			// Name of the library
			"name": "Example Raygun Client",
			// Version of the library
			"version": "0.0.0.1",
			// URL where the client can be downloaded or viewed
			"clientUrl": "/documentation/integrations/api"
		},
		// Information about the error itself
		"error": {
			// The error that caused the outer error.
			// Has all the same properties as the "error" object that contains it.
			"innerError": {},
			// Data contained in the error object
			"data": {
				"example": 5
			},
			// The name of the error
			"className": "ErrorClass",
			// The error message
			"message": "An error occurred",
			// The collection of stack traces.
			// The first one in the list should be the highest on the stack
			"stackTrace": [
			{
				// The line number of this stack frame
				"lineNumber": 55,
				// The name of the class this stack frame is in
				"className": "BrokenService",
				// The column of the file that this stack frame is in
				"columnNumber": 23,
				// The name of the file this stack frame is in
				"fileName": "BrokenService.cs",
				// The name of the method this stack frame is in
				"methodName": "BreakEverything()"
			}]
		},
		// Information about the environment at the time of the error.
		// Each of these properties are optional
		"environment": {
			// The number of processors in the machine
			"processorCount": 4,
			// The version of the operating system this app is running on
			"osVersion": "Windows 10",
			// The width of the window
			"windowBoundsWidth": 2560,
			// The height of the window
			"windowBoundsHeight": 1440,
			// The width of the browser window
			"browser-Width": 2560,
			// The height of the browser window
			"browser-Height": 1440,
			// The width of the screen
			"screen-Width": 2560,
			// The height of the screen
			"screen-Height": 1440,
			// The scale of the screen
			"resolutionScale": 1.0,
			// Color depth of the screen
			"color-Depth": 24,
			// The orientation of the screen
			"currentOrientation": "Landscape",
			// The type of CPU in the machine
			"cpu": "Intel(R) Core(TM) i5-2500 CPU @ 3.30GHz",
			"packageVersion": "package version",
			// CPU architecture (ARMv8, AMD64, etc)
			"architecture": "ARMv7-A",
			// Device manufacturer
			"deviceManufacturer": "Nokia",
			// Device model
			"model": "Lumia 920",
			// Total RAM in MB
			"totalPhysicalMemory": 1024,
			// Available RAM in MB
			"availablePhysicalMemory": number,
			// Total Virtual Memory in MB - RAM plus swap space
			"totalVirtualMemory": number,
			// Available Virtual Memory in MB
			"availableVirtualMemory": number,
			// Free disk space in GB
			"diskSpaceFree": [50000.52, 2000.104],
			// Name of the device (phone name for instance)
			"deviceName": "Nexus 7",
			// Locale setting of the system
			"locale": "en-nz",
			// Number of hours offset from UTC
			"utcOffset": -12,
			// The browser manufacturer
			"browser": "Mozilla",
			// The browser name
			"browserName": "Netscape",
			// The full user agent string
			"browser-Version": "5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.65 Safari/537.36",
			// OS Name
			"platform": "Win32"
		},
		// Tags that should be applied to the error
		// These will be searchable and filterable on the dashboard.
		"tags": ["tag1", "tag 2", "tag-3"],
		// Any custom data you would like to attach to this error instance.
		// You can search on data entered here.
		"userCustomData": {
			"domain": "WORKPLACE",
			"area": "51"
		},
		// Information about the HTTP request being processed when the error occurred.
		// Only useful in a web environment obviously.
		"request": {
			// The hostName portion of the URL being requested.
			"hostName": "https://raygun.io",
			// The path portion of the URL being requested
			"url": "/documentation/integrations/api",
			// The HTTP method used to request the URL (GET, POST, PUT, etc)
			"httpMethod": "POST",
			// The IP address of the client that initiated the request
			"iPAddress": "127.0.0.1",
			// The query string portion of the URL
			"queryString": {
				"q": "searchParams"
			},
			// The form parameters sent through with the request. Not form encoded.
			"form": {
				"firstName": "Example",
				"lastName": "Person",
				"newsletter": true
			},
			// The HTTP Headers sent as part of the request
			"headers": {
				"Referer": "www.google.com",
				"Host": "raygun.io"
			},
			// The raw request body. Don't include form values here.
			// See the notes for more information
			"rawData": "{\"Test\": 5}"
		},
		// Information about the response that will be sent back to the client.
		"response": {
			// The HTTP status code that will be sent back to the client
			"statusCode": 500
		},
		// Information about the user that caused the error
		"user": {
			// Unique identifier for the user
			"identifier": "123456789",
			// Flag indicating if the user is anonymous or not
			"isAnonymous": false,
			// User's email address
			"email": "test@example.com",
			// User's full name
			"fullName": "Test User",
			// User's first name (what you would use if you were emailing them - "Hi {{firstName}}, ...")
			"firstName": "Test",
			// Device unique identifier. Useful if sending errors from a mobile device.
			"uuid": "783491e1-d4a9-46bc-9fde-9b1dd9ef6c6e"
		},
		// A trail of breadcrumbs leading up to this error
		"breadcrumbs": [{
			// Milliseconds since the Unix Epoch (required)
			"timeStamp": 1504799959639,
			// The display level of the message (valid values are Debug, Info, Warning, Error)
			"level": "info",
			// The type of message (valid values are manual, navigation, click-event, request, console)
			"type": "navigation",
			// Any value to categorize your messages
			"category": "checkout",
			// The message you want to record for this breadcrumb
			"message": "User navigated to the shopping cart",
			// If relevant, a class name from where the breadcrumb was recorded
			"className": "ShoppingCart",
			// If relevant, a method name from where the breadcrumb was recorded
			"methodName": "ViewBasket",
			// If relevant, a line number from where the breadcrumb was recorded
			"lineNumber": 156,
			// Any custom data you want to record about application state when the breadcrumb was recorded
			"customData": { "from": "/category/product/123", "to": "/cart/view" }
		}]
	}
}