Elasticsearch Data Dictionary
Metrics index
Field | Type | Availability | Description |
---|---|---|---|
cache |
Boolean |
Yes |
Indicates whether the response was taken from the cache or not |
insertedOnDate |
Date |
Yes |
Full date from data insertion.
Follows the format: |
receivedOnDate |
Date |
Yes |
Date when the request was received in the format: |
resourceId |
Number |
Yes |
Resource identifier |
requestPayload |
Number |
Yes |
Size of the request payload (bytes) |
receivedOn |
Number |
Yes |
Date when the request was received in UNIX Time format |
operationId |
Number |
Yes |
Operation identifier |
apiId |
Number |
Yes |
API identifier |
responsePayload |
Number |
Yes |
Response payload size (bytes) |
durationMillis |
Number |
Yes |
Period of time for the request to be completed (in milliseconds) |
resultStatus |
Number |
Yes |
Request HTTP Status |
apiName |
String |
Yes |
API Name |
completeUrl |
String |
Yes |
URL used on the request; formed by HTTP Method + URL |
appDeveloper |
String |
Yes |
Login of the developer, the owner of the APP consumed in the request. |
accessToken |
String |
Yes |
Access token code |
billing |
Boolean |
Yes |
It will receive the value "true" when the Billing Hits interceptor is executed |
accessTokenOwner |
String |
Yes |
Owner of the token registered on the access token registration |
method |
String |
Yes |
HTTP method of the request |
yearMonth |
String |
Yes |
Request year and month in the format YYYYMM |
resourceName |
String |
Yes |
Name of the resource used in the request (URI) |
environmentId |
Long |
No |
Identifier of the environment which received the request |
transactionID |
String |
Yes |
Value set when the Transaction ID interceptor is executed |
requestID |
String |
Yes |
Unique identifier of the request |
apiComponentType |
String |
Yes |
Type of the route called (API or OPERATION) |
receivedFromAddress |
String |
Yes |
Request origin address |
clientId |
String |
Yes |
Client ID code (app token) used in the request |
appName |
String |
Yes |
Name of the app |
typeStatus |
String |
Yes |
Request status (success / error / redirect) |
_type |
String |
Yes |
Data type (metric) |
operationName |
String |
Yes |
Singular collection of values, formed by App Name + API Name + HTTP Method + Resource Name |
typeError |
String |
Yes |
Error type (client / server / blocked) |
url |
String |
Yes |
URL used in the request |
environment |
String |
Yes |
Request environment (production / sandbox) |
billingData.billingValue |
Number |
Yes |
Request value incremented into the billing cache |
billingData.appBillingQuota |
Number |
Yes |
Current billing quota value related to a given app |
billingData.accessTokenBillingQuota |
Number |
Yes |
Current billing quota value related to a given access token |
Calls Index
The Calls Index contains all the attributes of the Metrics Index mentioned above. |
Field | Type | Availability | Description |
---|---|---|---|
responseHeaderSize |
Number |
Yes |
Size (bytes) of the response headers |
additionalInfo |
List |
Yes |
Stores the data inserted with the Additional Info interceptor |
responseHeaders |
String |
Yes |
Response headers |
additionalData |
String |
Yes |
Stores environment variables |
requestHeaders |
String |
Yes |
Request headers |
_type |
String |
Yes |
Entry type (trace) |
trace |
String |
Yes |
Gateway execution log with this structure: |
Share your suggestions with us!
Click here and then [+ Submit idea]