analytics API1.2.0

ErrorDetailV3

Type that defines the fields that can be returned in an error.

Type that uses ErrorDetailV3

Call that uses ErrorDetailV3

Fields

Field
Type
Description
category
Identifies whether the error was in the REQUEST or happened when running the APPLICATION.
domain
The primary system where the error occurred. This is relevant for application errors. For Analytics errors, it always has the value API_ANALYTICS.
errorId
A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Traffic report error IDs range from 50001 to 50500.
inputRefIds
array of string
Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.
longMessage
A more detailed explanation of the error than given in the message error field.
message
Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.
outputRefIds
array of string
Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.
parameters
This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.
subdomain
If present, indicates which subsystem in which the error occurred.