Get log by id

get/v1/organizations/{organizationId}/logs/{logId}

Page View

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.

Log payloads not returned

You can search log metadata or payloads via API, but you won't receive log payloads in the responses. You can only review log payload contents in the Redox dashboard (if you're assigned to an engineer or support role).

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.

Get log by id

Retrieve one specific log and its related metadata based on the unique log identifier.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/logs/{logId}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

organizationId
required, string
Identifies the Redox organization that you're operating in or on behalf of.
logId
required, string
Contains the unique identifier of the log that you want to retrieve.

Query Parameters

dataMode
string
Indicates the type of log traffic to search (e.g., backfill or realtime). Backfill traffic is typically historical data that populates your system prior to go-live with your connection. Real-time traffic is normal traffic that happens between you and your connection after go-live. By default, log searches only query your database for real-time traffic unless you set this parameter to backfill. Leaving this parameter blank maintains default behavior.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "result": {
7
      "attempts": {
8
        "total": 2,
9
        "latest": {
10
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
11
          "attemptAt": "2019-08-24T14:15:22Z",
12
          "status": "succeeded",
13
          "operations": [
14
            {
15
              "type": "blobResolvers",
16
              "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
17
              "version": 1,
18
              "order": 1,
19
              "attemptStage": "request",
20
              "startTime": "2024-06-04T00:00:00Z",
21
              "endTime": "2024-06-04T00:00:00Z",
22
              "error": {
23
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
24
                "code": "customer.translation.error",
25
                "meta": {},
26
                "title": "string",
27
                "detail": "string"
28
              },
29
              "inputSnapshotIds": [
30
                "string"
31
              ],
32
              "outputSnapshotIds": [
33
                "string"
34
              ],
35
              "typeCanModifyPayload": false,
36
              "managedBy": "redox",
37
              "managedByOrganization": {
38
                "id": 0,
39
                "name": "string"
40
              },
41
              "details": {
42
                "blobResolvers": [
43
                  {
44
                    "id": 0,
45
                    "status": "found"
46
                  }
47
                ]
48
              }
49
            }
50
          ],
51
          "failedState": "receive-request",
52
          "stages": {
53
            "request": {
54
              "number": 1,
55
              "name": "Request",
56
              "communicationMethod": "Redox API",
57
              "status": "succeeded",
58
              "dataFormat": "HL7v2",
59
              "timestamp": "2024-06-04T09:21:58.960Z"
60
            },
61
            "process-request": {
62
              "number": 2,
63
              "name": "Process",
64
              "status": "succeeded",
65
              "dataFormat": "HL7v2",
66
              "timestamp": "2024-06-04T09:21:58.960Z"
67
            },
68
            "receive-request": {
69
              "number": 3,
70
              "name": "Receive",
71
              "communicationMethod": "Redox API",
72
              "status": "succeeded",
73
              "dataFormat": "HL7v2",
74
              "timestamp": "2024-06-04T09:21:58.960Z"
75
            },
76
            "respond": {
77
              "number": 4,
78
              "name": "Respond",
79
              "communicationMethod": "Redox API",
80
              "status": "succeeded",
81
              "dataFormat": "HL7v2",
82
              "timestamp": "2024-06-04T09:21:58.960Z"
83
            },
84
            "process-response": {
85
              "number": 5,
86
              "name": "Process",
87
              "status": "succeeded",
88
              "dataFormat": "HL7v2",
89
              "timestamp": "2024-06-04T09:21:58.960Z"
90
            },
91
            "receive-response": {
92
              "number": 6,
93
              "name": "Receive",
94
              "status": "succeeded",
95
              "dataFormat": "HL7v2",
96
              "timestamp": "2024-06-04T09:21:58.960Z"
97
            }
98
          }
99
        }
100
      },
101
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
102
      "createdAt": "2024-02-27T17:50:10.584Z",
103
      "updatedAt": "2024-02-27T17:50:10.584Z",
104
      "dataModel": "PatientAdmin",
105
      "eventType": "Transfer",
106
      "status": "succeeded",
107
      "type": "receive",
108
      "source": {
109
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
110
        "name": "string",
111
        "organization": {
112
          "id": 122,
113
          "name": "string"
114
        }
115
      },
116
      "destination": {
117
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
118
        "name": "string",
119
        "organization": {
120
          "id": 122,
121
          "name": "string"
122
        }
123
      }
124
    }
125
  }
126
}

meta
object
- version
  string
  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.
payload
object
- result
  object
  Contains a log and its related details.
  attempts
  object
  total
  integer
  Displays the total number of attempts made for this log.
  latest
  object
  id
  string
  Contains the unique identifier of the most recent attempt.
  Format: uuid
  attemptAt
  string
  Displays the timestamp for when the most recent retry was attempted in ISO 8601 format.
  Format: date-time
  status
  string
  Indicates the status for the log attempt (e.g., succeeded, failed, filtered, pending).
  Possible Values: failed, filtered, pending, succeeded
  operations
  Array of BLOB resolvers, Cleansers, Conductors, Config modifiers
  Describes any operations (e.g., filters, translations) that were performed during log processing.
  Any of:
  type
  required, 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
  operationId
  required, string
  Contains the unique identifier of the given operation.
  Format: uuid
  version
  required, number
  Displays the Redox version of the given operation.
  order
  required, number
  Indicates the sequential order in log processing where the operation occurs. The first operation will have an order number of 1.
  attemptStage
  required, 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
  startTime
  required, string
  Displays the date and time that the operation began processing in ISO 8601 format.
  endTime
  required, string
  Displays the date and time that the operation finished processing in ISO 8601 format.
  typeCanModifyPayload
  required, boolean
  Indicates whether the operation can alter any payload content.
  managedBy
  required, 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
  details
  required, object
  blobResolvers
  required, Array of object
  id
  required, number
  Contains the unique identifier of the BLOB resolver.
  status
  required, 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
  error
  object
  Describes any errors related to the operation that occurred during log processing.
  id
  string
  Contains the unique identifier of the error.
  Format: uuid
  code
  string
  Displays a code that indicates the type of error that occurred.
  meta
  object
  Contains metadata about the error that occurred. This can vary depending on the specific error.
  title
  string
  Contains a human-readable description of the error.
  detail
  string
  Explains the error in more detail.
  inputSnapshotIds
  Array 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.
  outputSnapshotIds
  Array 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.
  managedByOrganization
  object
  Describes the Redox organization that owns and manages a given operation.
  id
  nullable, number
  Contains the unique identifier of the organization.
  name
  string
  Displays the human-readable name for the organization.
  failedState
  string
  If the log status equals failed, this field is populated with the processing stage when an error occurred; otherwise, this field is set to null.
  stages
  object
  Describes a phase of log processing, which includes at least one operation or a collection of operations.
  One of:
  request
  object
  number
  required, integer
  Indicates the sequential order in log processing where this stage occurs.
  name
  required, string
  Displays the human-readable name of this processing stage.
  status
  nullable, 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
  communicationMethod
  string
  Indicates the communication method used during this processing stage.
  dataFormat
  string
  Describes the format the data was in when exchanged during this processing stage.
  timestamp
  nullable, string
  Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
  process-request
  object
  number
  required, integer
  Indicates the sequential order in log processing where this stage occurs.
  name
  required, string
  Displays the human-readable name of this processing stage.
  status
  nullable, 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
  dataFormat
  string
  Describes the format the data was in when exchanged during this processing stage.
  timestamp
  nullable, string
  Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
  receive-request
  object
  number
  required, integer
  Indicates the sequential order in log processing where this stage occurs.
  name
  required, string
  Displays the human-readable name of this processing stage.
  status
  nullable, 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
  communicationMethod
  string
  Indicates the communication method used during this processing stage.
  dataFormat
  string
  Describes the format the data was in when exchanged during this processing stage.
  timestamp
  nullable, string
  Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
  respond
  object
  number
  required, integer
  Indicates the sequential order in log processing where this stage occurs.
  name
  required, string
  Displays the human-readable name of this processing stage.
  status
  nullable, 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
  communicationMethod
  string
  Indicates the communication method used during this processing stage.
  dataFormat
  string
  Describes the format the data was in when exchanged during this processing stage.
  timestamp
  nullable, string
  Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
  process-response
  object
  number
  required, integer
  Indicates the sequential order in log processing where this stage occurs.
  name
  required, string
  Displays the human-readable name of this processing stage.
  status
  nullable, 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
  dataFormat
  string
  Describes the format the data was in when exchanged during this processing stage.
  timestamp
  nullable, string
  Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
  receive-response
  object
  number
  required, integer
  Indicates the sequential order in log processing where this stage occurs.
  name
  required, string
  Displays the human-readable name of this processing stage.
  status
  nullable, 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
  dataFormat
  string
  Describes the format the data was in when exchanged during this processing stage.
  timestamp
  nullable, string
  Indicates the date and time of the outcome of this processing stage in ISO 8601 format.
  id
  string
  Contains the unique identifier of the log.
  Format: uuid
  createdAt
  string
  Displays the date and time that the log was originally created in ISO 8601 format, which is associated with the date and time that the related data exchange took place.
  Format: date-time
  updatedAt
  string
  Displays the date and time when the log was last updated in ISO 8601 format.
  Format: date-time
  dataModel
  string
  Indicates the data model used to exchange data.\n\nThis is the equivalent of the Meta.DataModel field in our data models.
  eventType
  string
  Indicates the particular event type of a data model that's used to exchange data.\n\nThis is the equivalent of the Meta.EventType field in our data models.
  status
  string
  Indicates the current status of the log [e.g., succeeded, failed, filtered, pending].
  Possible Values: failed, filtered, pending, succeeded
  type
  string
  Indicates the type of data exchange that initiated the log (e.g., send, receive, request, respond, unknown).
  Possible Values: receive, request, respond, send, unknown
  source
  object
  Describes the system that initiated the log.
  id
  string
  Contains the unique identifier of the source.
  Format: uuid
  name
  nullable, string
  Displays the human-readable name of the source.
  organization
  object
  Contains metadata about the Redox organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.
  destination
  object
  Describes the intended destination of the log.
  id
  string
  Contains the unique identifier of the destination.
  Format: uuid
  name
  nullable, string
  Displays the human-readable name of the destination.
  organization
  object
  Contains metadata about the Redox organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.