Logs endpoints allow you to review log metadata, including relevant timestamps and statuses. Or, if you want to dig into a log for troubleshooting purposes, you can run log inspector.
You can retrieve a list of log metadata, search for specific data within log payloads, retrieve one log with its metadata, or run log inspector.
Run log inspector
Run log inspector to review metadata and operation details for a given log.
This doesn't re-send the log; it's only a preview option for troubleshooting. Or, you can run log inspector as you make changes to operation settings (e.g., translations, filters, config modifiers) to preview the impact of your changes before applying to real-time traffic.
cURL request example
Path Parameters
- logIdrequired, string
Identifies the specific log that you'd like to troubleshoot with Redox's log inspector.
Query Parameters
- inlineOperationTemplatesboolean
Determines whether or not template-able operations such as config modifiers will be included in the list of operations.
Request Body Schema
- environmentrequired, object
Describes the environment the log belongs to.
- idrequired, string
Identifies the specific environment that the log belongs to.
- inspectorOverridesobject
Describes unsaved changes to operations that will only apply during this run of log inspector. These changes won't apply to real-time logs until they're saved.
- source-requestobject
Describes the changes to apply to a payload at the given processing location, whether on the source or destination side of the exchange.
- configModifiersArray of object
- flavorrequired, string
Indicates the type, or flavor, of config modifier. A
put
flavor alters data (creates or replaces) in a payload, while adelete
flavor removes data from a payload.Possible Values:delete
,put
- selectorrequired, string
Indicates the location(s) within the payload that the config modifier will operate on.
- eventTypesrequired, Array of string
Indicates which event type(s) of the subscription the config modifier will operate on. If not restricted to certain event types, you must explicitly set this field to
null
; this means the config modifier will operate on all event types. - idstring
Contains the unique identifier of an existing config modifier. If an
id
isn't provided, the config modifier described here will be processed as if it were newly created and will be assigned a temporary unique id.Format: uuid - linkIdstring
Specifies the subscription that an existing config modifier is linked to.
Format: uuid - schemaobject
Required for a
put
flavor config modifier. Indicates how to build the value at the location the selector specifies.
- destination-requestobject
Describes the changes to apply to a payload at the given processing location, whether on the source or destination side of the exchange.
- configModifiersArray of object
- flavorrequired, string
Indicates the type, or flavor, of config modifier. A
put
flavor alters data (creates or replaces) in a payload, while adelete
flavor removes data from a payload.Possible Values:delete
,put
- selectorrequired, string
Indicates the location(s) within the payload that the config modifier will operate on.
- eventTypesrequired, Array of string
Indicates which event type(s) of the subscription the config modifier will operate on. If not restricted to certain event types, you must explicitly set this field to
null
; this means the config modifier will operate on all event types. - idstring
Contains the unique identifier of an existing config modifier. If an
id
isn't provided, the config modifier described here will be processed as if it were newly created and will be assigned a temporary unique id.Format: uuid - linkIdstring
Specifies the subscription that an existing config modifier is linked to.
Format: uuid - schemaobject
Required for a
put
flavor config modifier. Indicates how to build the value at the location the selector specifies.
- destination-responseobject
Describes the changes to apply to a payload at the given processing location, whether on the source or destination side of the exchange.
- configModifiersArray of object
- flavorrequired, string
Indicates the type, or flavor, of config modifier. A
put
flavor alters data (creates or replaces) in a payload, while adelete
flavor removes data from a payload.Possible Values:delete
,put
- selectorrequired, string
Indicates the location(s) within the payload that the config modifier will operate on.
- eventTypesrequired, Array of string
Indicates which event type(s) of the subscription the config modifier will operate on. If not restricted to certain event types, you must explicitly set this field to
null
; this means the config modifier will operate on all event types. - idstring
Contains the unique identifier of an existing config modifier. If an
id
isn't provided, the config modifier described here will be processed as if it were newly created and will be assigned a temporary unique id.Format: uuid - linkIdstring
Specifies the subscription that an existing config modifier is linked to.
Format: uuid - schemaobject
Required for a
put
flavor config modifier. Indicates how to build the value at the location the selector specifies.
- source-responseobject
Describes the changes to apply to a payload at the given processing location, whether on the source or destination side of the exchange.
- configModifiersArray of object
- flavorrequired, string
Indicates the type, or flavor, of config modifier. A
put
flavor alters data (creates or replaces) in a payload, while adelete
flavor removes data from a payload.Possible Values:delete
,put
- selectorrequired, string
Indicates the location(s) within the payload that the config modifier will operate on.
- eventTypesrequired, Array of string
Indicates which event type(s) of the subscription the config modifier will operate on. If not restricted to certain event types, you must explicitly set this field to
null
; this means the config modifier will operate on all event types. - idstring
Contains the unique identifier of an existing config modifier. If an
id
isn't provided, the config modifier described here will be processed as if it were newly created and will be assigned a temporary unique id.Format: uuid - linkIdstring
Specifies the subscription that an existing config modifier is linked to.
Format: uuid - schemaobject
Required for a
put
flavor config modifier. Indicates how to build the value at the location the selector specifies.
- metaobject
- versionstring
Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
- payloadobject
- resultobject
Contains the results after running log inspector on the specified log. You can use the results for troubleshooting or comparison purposes.
- idrequired, string
Contains the unique identifier of the log inspector processing attempt. This is different from the original log id.
Format: uuid - timestamprequired, string
Displays the date and time that log inspector ran in ISO 8601 format.
- statusrequired, string
Indicates the log status after running log inspector.
Possible Values:failed
,filtered
,pending
,succeeded
- attemptrequired, object
Describes an attempt at processing a log.
- idrequired, string
Contains the unique identifier of the specific log attempt.
Format: uuid - statusrequired, string
Indicates the current status of the attempt.
Possible Values:failed
,filtered
,pending
,succeeded
- timestamprequired, string
Displays the date and time in ISO 8601 format indicating when the attempt was made.
- stagesrequired, object
Describes a phase of log processing, which includes at least one operation or a collection of operations.
- requestobject
- numberrequired, integer
Indicates the sequential order in log processing where this stage occurs.
- namerequired, string
Displays the human-readable name of this processing stage.
- statusnullable, required, string
Indicates the overall status of a stage. Will be
null
if processing didn't reach this stage.Possible Values:failed
,filtered
,pending
,succeeded
- communicationMethodstring
Indicates the communication method used during this processing stage.
- dataFormatstring
Describes the format the data was in when exchanged during this processing stage.
- timestampnullable, string
Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
- process-requestobject
- numberrequired, integer
Indicates the sequential order in log processing where this stage occurs.
- namerequired, string
Displays the human-readable name of this processing stage.
- statusnullable, required, string
Indicates the overall status of a stage. Will be
null
if processing didn't reach this stage.Possible Values:failed
,filtered
,pending
,succeeded
- dataFormatstring
Describes the format the data was in when exchanged during this processing stage.
- timestampnullable, string
Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
- receive-requestobject
- numberrequired, integer
Indicates the sequential order in log processing where this stage occurs.
- namerequired, string
Displays the human-readable name of this processing stage.
- statusnullable, required, string
Indicates the overall status of a stage. Will be
null
if processing didn't reach this stage.Possible Values:failed
,filtered
,pending
,succeeded
- communicationMethodstring
Indicates the communication method used during this processing stage.
- dataFormatstring
Describes the format the data was in when exchanged during this processing stage.
- timestampnullable, string
Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
- respondobject
- numberrequired, integer
Indicates the sequential order in log processing where this stage occurs.
- namerequired, string
Displays the human-readable name of this processing stage.
- statusnullable, required, string
Indicates the overall status of a stage. Will be
null
if processing didn't reach this stage.Possible Values:failed
,filtered
,pending
,succeeded
- communicationMethodstring
Indicates the communication method used during this processing stage.
- dataFormatstring
Describes the format the data was in when exchanged during this processing stage.
- timestampnullable, string
Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
- process-responseobject
- numberrequired, integer
Indicates the sequential order in log processing where this stage occurs.
- namerequired, string
Displays the human-readable name of this processing stage.
- statusnullable, required, string
Indicates the overall status of a stage. Will be
null
if processing didn't reach this stage.Possible Values:failed
,filtered
,pending
,succeeded
- dataFormatstring
Describes the format the data was in when exchanged during this processing stage.
- timestampnullable, string
Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
- receive-responseobject
- numberrequired, integer
Indicates the sequential order in log processing where this stage occurs.
- namerequired, string
Displays the human-readable name of this processing stage.
- statusnullable, required, string
Indicates the overall status of a stage. Will be
null
if processing didn't reach this stage.Possible Values:failed
,filtered
,pending
,succeeded
- dataFormatstring
Describes the format the data was in when exchanged during this processing stage.
- timestampnullable, string
Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
- operationsrequired, Array of BLOB resolvers, Cleansers, Conductors, Config modifiers
Describes any operations (e.g., filters, translations) that were performed during log processing.
- typerequired, string
Indicates the type of operation performed. The type determines what data is included in the
Details
property.Possible Values:blobResolvers
,cleansers
,conductors
,configModifiers
,deliveries
,filters
,jsonConverters
,preParsers
,redoxConfigurations
,redoxFilters
,taggers
,translations
- operationIdrequired, string
Contains the unique identifier of the given operation.
Format: uuid - versionrequired, number
Displays the Redox version of the given operation.
- orderrequired, number
Indicates the sequential order in log processing where the operation occurs. The first operation will have an order number of 1.
- attemptStagerequired, string
Describes the processing stage where the given operation occurred.
Possible Values:send
,process
,receive
,request
,process-request
,receive-request
,respond
,process-response
,receive-response
- startTimerequired, string
Displays the date and time that the operation began processing in ISO 8601 format.
- endTimerequired, string
Displays the date and time that the operation finished processing in ISO 8601 format.
- typeCanModifyPayloadrequired, boolean
Indicates whether the operation can alter any payload content.
- managedByrequired, string
Indicates whether you (i.e.,
customer
) can create and manage this operation type, or if only a Redoxer (i.e.,redox
) can.Possible Values:redox
,customer
- detailsrequired, object
- blobResolversrequired, Array of object
- idrequired, number
Contains the unique identifier of the BLOB resolver.
- statusrequired, string
Indicates whether the BLOB file location referenced in the payload could be found and resolved to its file contents.
Possible Values:found
,not-found
- errorobject
Describes any errors related to the operation that occurred during log processing.
- idstring
Contains the unique identifier of the error.
Format: uuid - codestring
Displays a code that indicates the type of error that occurred.
- metaobject
Contains metadata about the error that occurred. This can vary depending on the specific error.
- titlestring
Contains a human-readable description of the error.
- detailstring
Explains the error in more detail.
- inputSnapshotIdsArray of string
Lists the unique identifiers that correlate to each input snapshot, respectively, for a given log, which represent the full payload input to the given operation.
- outputSnapshotIdsArray of string
Lists the unique identifiers that correlate to each output snapshot, respectively, for a given log, which represent the full payload output from the given operation.
- managedByOrganizationobject
Describes the Redox organization that owns and manages a given operation.
- idnullable, number
Contains the unique identifier of the organization.
- namestring
Displays the human-readable name for the organization.
- snapshotsrequired, Array of object
Describes how the log payload looks at a specific moment during log processing. Snapshots show how and when data changed during log processing for troubleshooting or comparison purposes.
- idstring
Contains the unique identifier of the snapshot.
Format: uuid - namestring
Displays the human-readable name of the stage where the snapshot occurred.
- datanullable,
Contains the log payload content at the time of the snapshot. This data could be an object, string, null, or undefined.
- dataFormatstring
Describes the language and format of the snapshot.
- customProcessingrequired, object
Describes metadata and outcomes of operations you manage (e.g., filters, translations).
- filtersArray of object
Describes any customer-managed filters applied during log processing.
- operationIdstring
Displays the unique identifier of this customer-managed operation.
- shouldFilterboolean
Indicates whether the log should be sent (i.e., not filtered) or not sent (i.e., filtered).
- filtersArray of object
- actionrequired, string
Describes the type of filter that will apply to the log. A
block-all
value indicates that any logs that meet the criteria will be blocked. Asend
value indicates that a log meeting the filter criteria will be allowed through.Possible Values:send
,block-all
- filterVersionrequired, number
Displays the version of the filter that was applied to the log. A filter's version number is incremented every time the filter is updated.
- outcomerequired, string
Summarizes the outcomes of all the defined rules for this filter operation. If
evaluated
, all filter rules were evaluated; this doesn't mean all criteria was satisfied but that each rule was evaluated without encountering errors. Ifskipped
, another filter ran before this one and blocked this log; in other words, this filter didn't need to be evaluated. Ifdisqualified
, the filter is invalid due to its configuration settings (e.g., invalid path syntax in one of the filters rules), so the filter failed to run.Possible Values:disqualified
,evaluated
,skipped
- rulesrequired, Array of object
- pathrequired, string
Displays the JSON path of the fields which are compared against the filter criteria defined in the rule.
- outcomerequired, string
Describes the result of an individual
send-if
filter rule. Ifsatisfied
, the filter rule's criteria was met, and the next filter rule in the sequence was evaluated. Ifunsatisfied
, the filter rule's criteria wasn't met, so the log wasn't sent per the definedsend-if
filter. Ifskipped
, the previous filter rule wasunsatisfied
, so this rule wasn't evaluated. Ifdisqualified
, the filter rule is invalid due to its configuration settings (e.g., invalid field path syntax).Possible Values:disqualified
,satisfied
,skipped
,unsatisfied
- translationsArray of object
Describes any customer-managed translations applied during log processing.
- operationIdstring
Displays the unique identifier of this customer-managed operation.
- translationsArray of object
- translationSetLinkIdstring
Contains the unique identifier of the translation set link, which applies the translation to the appropriate subscription and event type(s).
Format: uuid - translationSetIdstring
Contains the unique identifier of the translation set, which defines the translation logic and is referenced in the translation set link.
Format: uuid - fieldsArray of object
- statusstring
Describes the outcome of a given field's translation. If
translated
, the field was translated as expected. Iffield-not-found
, the field wasn't found in the payload, so no translation occurred. Ifvalue-not-found
, the value in the specified field didn't match the mapped value in the linked translation set, so no translation occurred.Possible Values:translated
,field-not-found
,value-not-found
- fieldPathstring
Contains the JSON path of the field to translate, as specified in the translation set.
- matchedPathstring
Contains the actual JSON for the matching translation value. For example, if the
fieldPath
is$.SomeArray[*].SomeProperty
and the translation value was matched at the first item in the array, then thematchedPath
would beSomeArray[0].SomeProperty
.
- logTyperequired, string
Specifies the directionality of the traffic, whether asynchronous (i.e, uni-directional) or synchronous (i.e., bi-directional).
Possible Values:sync
,async
- sourcerequired, object
Describes the system that initiated the log.
- idstring
Contains the unique identifier of the source.
Format: uuid - namestring
Displays the human-readable name of the source.
- organizationobject
Identifies the Redox organization associated with this source.
- idinteger
Displays the unique identifier of the Redox organization.
- namestring
Displays the human-readable name of the Redox organization.
- communicationMethodstring
Describes the source's type of communication method to send and/or receive data.
- transmissionUniqueIdsArray of string
Contains the unique identifier(s) of the transmissions that the destination normally would've received; however, no data is sent to destinations when running log inspector.
Format: uuid - destinationobject
Describes the intended endpoint of the log.
- idstring
Contains the unique identifier of the destination.
Format: uuid - namestring
Displays the human-readable name of the destination.
- organizationobject
Describes the Redox organization associated with this destination.
- idinteger
Displays the unique identifier of the Redox organization.
- namestring
Displays the human-readable name of the Redox organization.
- communicationMethodstring
Describes the destination's type of communication method to receive and/or send data.
- communicationMethodFlavorstring
Describes a subset of communication method the destination uses, if applicable.
- subscriptionobject
Describes the connection between the log's source and destination.
- idstring
Displays the unique identifier of the subscription.
- dataModelstring
Identifies the Redox data model used to exchange data for a given subscription.