Skip to main content

Data Structure Fields

Field NameData/Description Stored in FieldJava Mapping TypeField that must be enabled in settings to be included in message
@timestampTime StampInstantDefinition Information
aciApinizer Correlation IDStringDefinition Information
eiEnvironment IDStringDefinition Information
piProject IDStringDefinition Information
appiApplication IDStringAPI Proxy Information
appinApplication NameStringAPI Proxy Information
apiAPI Proxy IDStringAPI Proxy Information
apnAPI Proxy NameStringAPI Proxy Information
eatAPI TypeStringAPI Proxy Information
aprpAPI Proxy Relative PathStringAPI Proxy Information
apmiAPI Proxy Method IDStringAPI Proxy Information
apmnAPI Proxy Method NameStringAPI Proxy Information
xffX Forwarded ForStringRequest Information
hr1raHttp Request Remote AddressStringRequest Information
hr1hmHttp Request Http MethodStringRequest Information
hr1ctHttp Request Content TypeStringRequest Information
hr1piHttp Request Path InfoStringRequest Information
uokUsername or KeyStringRequest Information
hr1cpHttp Request Context PathStringRequest Information
hr1qsHttp Request Query StringStringRequest Information (Only when “Trace” is enabled)
hr1ruHttp Request Remote UserStringRequest Information (Only when “Trace” is enabled)
hr1rsiHttp Request Requested Session IdStringRequest Information (Only when “Trace” is enabled)
hr1r1uHttp Request Request URIStringRequest Information (Only when “Trace” is enabled)
hr1ceHttp Request Character EncodingStringRequest Information (Only when “Trace” is enabled)
hr1clHttp Request Content LengthIntegerRequest Information (Only when “Trace” is enabled)
hr1pHttp Request ProtocolStringRequest Information (Only when “Trace” is enabled)
hr1sHttp Request SchemeStringRequest Information (Only when “Trace” is enabled)
hr1snHttp Request Server NameStringRequest Information (Only when “Trace” is enabled)
hr1spHttp Request Server PortIntegerRequest Information (Only when “Trace” is enabled)
locLocationGeoLocation{Double lat, Double lon}Request Information
hr1rhHttp Request Remote HostStringRequest Information (Only when “Trace” is enabled)
hr1rpHttp Request Remote PortIntegerRequest Information (Only when “Trace” is enabled)
hr1lnHttp Request Local NameStringRequest Information (Only when “Trace” is enabled)
hr1laHttp Request Local AddressStringRequest Information (Only when “Trace” is enabled)
hr1lpHttp Request Local PortStringRequest Information (Only when “Trace” is enabled)
trqptTimeRequestPipelineTotalIntegerMetric Information
trsptTimeResponsePipelineTotalIntegerMetric Information
rrcRoutingRetryCountIntegerMetric Information
rfcRoutingFailoverCountIntegerMetric Information
trtTimeRoutingTotalIntegerMetric Information
taptTimeApiProxyTotalIntegerMetric Information
chCacheHitBooleanMetric Information
sr1tSizeRequestTotalIntegerMetric Information
sr2tSizeResponseTotalIntegerMetric Information
scStatus CodeIntegerResponse Information
rtResult TypeEnumResponse Information
etError TypeEnumResponse Information
petParent Error TypeEnumResponse Information
fcrpFrom Client Read Only ParameterMap<String,String>Header from Client
fcrhFrom Client Read Only HeaderMap<String,String>Param from Client
fcrbFrom Client Read Only BodyStringBody from Client
tbapTo Backend API ParameterMap<String,String>Header to Backend API
tbahTo Backend API HeaderMap<String,String>Parameter to Backend API
tbaTo Backend API BodyStringBody to Backend API
fbarhFrom Backend API Read Only HeaderMap<String,String>Header from Backend API
fbarbFrom Backend API Read Only BodyStringBody from Backend API
tchTo Client HeaderMap<String,String>Header to Client
tcbTo Client BodyStringBody to Client
The order of fields may change.

Example JSON Data

Example JSON data created:
{
  "@timestamp" : "2023-10-16T14:48:07.662Z",
  "aci" : "<correlation id>",
  "ei" : "<environment id>",
  "pi" : "<project id>",
  "appi" : "<api proxy group id>",
  "appin" : "<api proxy group name>",
  "api" : "<api proxy id>",
  "apn" : "<api proxy name>",
  "eat" : "REST",
  "aprp" : "<api proxy relative path>",
  "apmi" : "<api proxy method id>",
  "apmn" : "<api proxy method name>",
  "xff" : "<x-forwarded-for>",
  "hr1ra" : "<client address>",
  "hr1hm" : "<HTTP Method>",
  "hr1ct" : "<Content-Type>",
  "hr1pi" : "<http request path info>",
  "uok" : "<username or key>",
  "hr1cp" : "<http request context path>",
  "ra" : "<backend api address>",
  "rrc" : 0,
  "rfc" : 0,
  "trqpt" : 20,
  "trspt" : 30,
  "trt" : 100,
  "tapt" : 150,
  "sr1t" : 100,
  "sr2t" : 250,
  "ch" : false,
  "sc" : 200,
  "et" : "APIPROXY",
  "pet" : "API_PROXY",
  "rt" : "SUCCESS",
  "hr1qs" : "<Http Request Query String>",
  "hr1ru" : "<Http Request Remote User>",
  "hr1rsi" : "<Http Request Requested Session Id>",
  "hr1r1u" : "<Http Request Request URI>",
  "hr1ce" : "<Http Request Character Encoding>",
  "hr1cl" : 100,
  "hr1p" : "<Http Request Protocol>",
  "hr1s" : "<Http Request Scheme>",
  "hr1sn" : "<Http Request Server Name>",
  "hr1sp" : 443,
  "loc" : {
   "lat" : 45.405,
   "lon" : 11.1617
   },
  "hr1rh" : "<Http Request Remote Host>",
  "hr1rp" : 8443,
  "hr1ln" : "<Http Request Local Name>",
  "hr1la" : "<Http Request Local Addr>",
  "hr1lp" : 443,
  "fcrp" : [ {
    "k" : "key1",
    "v" : "value1"
  }, {
    "k" : "key2",
    "v" : "value2"
  }, {
    "k" : "key3",
    "v" : "value3"
  } ],
  "fcrh" : [ {
    "k" : "key1",
    "v" : "value1"
  }, {
    "k" : "key2",
    "v" : "value2"
  }, {
    "k" : "key3",
    "v" : "value3"
  } ],
  "fcrb" : "<request body from client>",
  "tbap" : [ {
    "k" : "key1",
    "v" : "value1"
  }, {
    "k" : "key2",
    "v" : "value2"
  }, {
    "k" : "key3",
    "v" : "value3"
  } ],
  "tbah" : [ {
    "k" : "key1",
    "v" : "value1"
  }, {
    "k" : "key2",
    "v" : "value2"
  }, {
    "k" : "key3",
    "v" : "value3"
  } ],
  "tba" : "<request body to backend api>",
  "fbarh" : [ {
    "k" : "key1",
    "v" : "value1"
  }, {
    "k" : "key2",
    "v" : "value2"
  }, {
    "k" : "key3",
    "v" : "value3"
  } ],
  "fbarb" : "<body response from backend api>",
  "tch" : [ {
    "k" : "key1",
    "v" : "value1"
  }, {
    "k" : "key2",
    "v" : "value2"
  }, {
    "k" : "key3",
    "v" : "value3"
  } ],
  "tcb" : "<body response to client>"
}
You can examine the list of values in the “rt” field in the “Result Type Enum Values” table on the Error Messages page.You can examine the list of values in the “pet” field in the “Error Parent Type Enum Values” table on the Error Messages page.You can examine the list of values in the “et” field in the “Error Type Values” table on the Error Messages page.