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 specific Redox organization you're operating in or on behalf of.
logId
required, string
Identifies the specific log that you'd like to retrieve metadata for.

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
    "page": {
5
      "currentPage": 1,
6
      "pageType": "offset",
7
      "pageSize": 50,
8
      "links": {
9
        "self": "/organizations/12345/logs",
10
        "next": "/organizations/12345/logs?_page=2&_count=50",
11
        "first": "/organizations/12345/logs?_page=1&_count=50"
12
      }
13
    }
14
  },
15
  "payload": {
16
    "id": "d758ea49-027b-4d6e-b4dd-a3500d8cc2e8",
17
    "createdAt": "2021-04-02T22.52.38.093Z",
18
    "updatedAt": "2021-05-05T22:52:38:093Z",
19
    "dataModel": "PatientAdmin",
20
    "eventType": "Transfer",
21
    "status": "filtered",
22
    "type": "send",
23
    "source": {
24
      "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
25
      "name": "Redox",
26
      "organization": {
27
        "id": 98765,
28
        "name": "Organization Name"
29
      }
30
    },
31
    "destination": {
32
      "id": "d710d1fd-15ef-4f84-9eab-16f03f9f5f87",
33
      "name": "Redox",
34
      "organization": {
35
        "id": 98765,
36
        "name": "Organization Name"
37
      }
38
    },
39
    "attempts": {
40
      "total": 25,
41
      "latest": {
42
        "id": "d99bda81-5a95-4e7a-9b90-10ee3562c210",
43
        "attemptAt": "2021-05-06T22:52:38.093Z",
44
        "status": "succeeded",
45
        "operations": [
46
          {
47
            "type": "translations",
48
            "operationId": "0775c68a-92a9-4ed7-800b-8da972eabbca",
49
            "order": 1,
50
            "version": 1,
51
            "attemptStage": "process-request",
52
            "startTime": "2024-01-01T00:00:00Z",
53
            "endTime": "2024-01-01T00:00:00Z",
54
            "error": {
55
              "id": "string",
56
              "code": "customer.translation.error",
57
              "meta": {},
58
              "title": "string",
59
              "detail": "string"
60
            },
61
            "details": {
62
              "translations": [
63
                {
64
                  "translationSetLinkId": "a942047b-5132-4066-997c-e94972b11a83",
65
                  "translationSetId": "6fd5458f-c6e0-47d5-b2c3-699639a48728",
66
                  "processingLocation": "source-request",
67
                  "processingDirection": "from-to",
68
                  "fields": [
69
                    {
70
                      "status": "translated",
71
                      "fieldPath": "string",
72
                      "matchedPath": "string"
73
                    }
74
                  ]
75
                }
76
              ]
77
            }
78
          }
79
        ],
80
        "failedStage": "receive-request",
81
        "stages": {
82
          "request": {
83
            "number": 1,
84
            "name": "Request",
85
            "status": "succeeded",
86
            "timestamp": "2021-04-02T23:15:58.960Z",
87
            "dataFormat": "HL7v2",
88
            "communicationMethod": "MLLP",
89
            "code": "ACK",
90
            "error": {
91
              "message": "string"
92
            },
93
            "dataUnavailable": false
94
          },
95
          "process-request": {
96
            "number": 1,
97
            "name": "Request",
98
            "status": "succeeded",
99
            "timestamp": "2021-04-02T23:15:58.960Z",
100
            "dataFormat": "HL7v2",
101
            "communicationMethod": "MLLP",
102
            "code": "ACK",
103
            "error": {
104
              "message": "string"
105
            },
106
            "dataUnavailable": false
107
          },
108
          "receive-request": {
109
            "number": 1,
110
            "name": "Request",
111
            "status": "succeeded",
112
            "timestamp": "2021-04-02T23:15:58.960Z",
113
            "dataFormat": "HL7v2",
114
            "communicationMethod": "MLLP",
115
            "code": "ACK",
116
            "error": {
117
              "message": "string"
118
            },
119
            "dataUnavailable": false
120
          },
121
          "respond": {
122
            "number": 1,
123
            "name": "Request",
124
            "status": "succeeded",
125
            "timestamp": "2021-04-02T23:15:58.960Z",
126
            "dataFormat": "HL7v2",
127
            "communicationMethod": "MLLP",
128
            "code": "ACK",
129
            "error": {
130
              "message": "string"
131
            },
132
            "dataUnavailable": false
133
          },
134
          "process-response": {
135
            "number": 1,
136
            "name": "Request",
137
            "status": "succeeded",
138
            "timestamp": "2021-04-02T23:15:58.960Z",
139
            "dataFormat": "HL7v2",
140
            "communicationMethod": "MLLP",
141
            "code": "ACK",
142
            "error": {
143
              "message": "string"
144
            },
145
            "dataUnavailable": false
146
          },
147
          "receive-response": {
148
            "number": 1,
149
            "name": "Request",
150
            "status": "succeeded",
151
            "timestamp": "2021-04-02T23:15:58.960Z",
152
            "dataFormat": "HL7v2",
153
            "communicationMethod": "MLLP",
154
            "code": "ACK",
155
            "error": {
156
              "message": "string"
157
            },
158
            "dataUnavailable": false
159
          }
160
        }
161
      }
162
    }
163
  }
164
}

Contains the metadata of a specific log matching the query parameter criteria.

meta
object
Contains the metadata information for the returned results, including version and pagination information.
- 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.
- page
  object
  Contains the pagination data for the returned results.
  currentPage
  integer
  Displays the current page number of returned results you're viewing.
  pageType
  string
  Displays the type of pagination supported for the returned results. Currently, we only support the offset type, which determines the page number by taking the page size and offsetting the number of records from the start.
  pageSize
  integer
  Displays the number of results included in each page.
  links
  object
  Contains the related pagination links for the returned results.
  self
  string
  Links to the current page of results.
  next
  string
  Links to the next page of results.
  first
  string
  Links to the first page of results.
payload
object
Contains the details for the returned log entries.
- id
  string
  Contains the unique identifier of the specific log, which you can use for reference or for a Get log search.
  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.
- updatedAt
  string
  Displays the date and time that the log was last updated in ISO 8601 format.
- dataModel
  string
  Indicates the data model used to exchange data.
  
  This 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.
  
  This is the equivalent of the Meta.EventType field in our data models.
- status
  string
  Indicates the current status of the log [i.e., succeeded, failed, filtered, pending].
  Possible Values: succeeded, failed, filtered, pending
- type
  string
  Indicates the type of data exchange that initiated the log (i.e., send, receive, request, respond, unknown.
  Possible Values: send, receive, request, respond, unknown
- source
  object
  Contains the details for the system that initiated the message associated with the log.
  id
  string
  Contains the unique identifier of the system that initiated the message.
  Format: uuid
  name
  string
  Displays the name of the system that initiated the message.
  organization
  object
  Contains the details about the Redox organization associated with this log.
  id
  integer
  Identifies the specific Redox organization that you're operating in or on behalf of.
  name
  string
  Displays the human readable name of the Redox organization.
- destination
  object
  Contains the details for the intended destination of the message.
  id
  string
  Displays the unique identifier of the system containing the destination that the message was directed to.
  Format: uuid
  name
  string
  Displays the name of the destination that the message was directed to.
  organization
  object
  Contains the details about the Redox organization associated with this log.
  id
  integer
  Identifies the specific Redox organization that you're operating in or on behalf of.
  name
  string
  Displays the human readable name of the Redox organization.
- attempts
  object
  Describes whether any retries have been performed on the specific log. A log may be retried multiple times to either send the same message again or resolve an issue when a log has a failed status. One “attempt” is equivalent to one retry; each attempt has more details related to the message's processing stage.
  total
  integer
  Displays the total number of attempts made for this log.
  latest
  object
  Describes the most recent attempt for this log.
  id
  string
  Contains the unique identifier of the most recent log 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 most recent log attempt (e.g., succeeded, failed, filtered, pending.
  Possible Values: succeeded, failed, filtered, pending
  operations
  Array of TranslationOperation or FilterOperation
  Any of:
  Contains a payload object with details about any operations (e.g., filters, translations) that were performed during log processing.
  type
  required, string
  Indicates the type of data operation that was performed. This value determines what's returned in the details object.
  Possible Values: translations, filters
  operationId
  required, string
  Displays the unique identifier of the given operation.
  order
  required, number
  Indicates the sequence of the given operation during log processing. The first operation will have an order number of 1.
  version
  required, number
  Identifies the Redox version of the given operation.
  attemptStage
  required, string
  Describes the processing stage where the given operation occurred.
  Possible Values: request, process-request, receive-request, respond, process-response, receive-response, send, process, receive, accept, process
  startTime
  required, string
  Contains the date-time in ISO 8601 format to indicate when the operation began during log processing.
  endTime
  required, string
  Contains the date-time in ISO 8601 format to indicate when the operation finished during log processing.
  details
  required, object
  translations
  Array of object
  translationSetLinkId
  string
  Displays the unique identifier of the translation set link used for this operation.
  translationSetId
  string
  Displays the unique identifier of the translation set referenced in the translation set link.
  processingLocation
  string
  If applicable, describes the processing stage where the given translation occurred.
  Possible Values: source-request, destination-request, source-response, destination-response
  processingDirection
  string
  Describes the processing direction of the translation.
  Possible Values: from-to, to-from
  fields
  Array of object
  status
  string
  Describes the outcome of the given field's translation. The translated value means that the field was translated as expected. The field-not-found value means that the field wasn't found at all, so the translation wasn't successful. The value-not-found value means that the field was found, but the value didn't match the linked translation set, so the translation set wasn't successful.
  Possible Values: translated, field-not-found, value-not-found
  fieldPath
  string
  Contains the JSON path of the field to be translated, as specified in the translation set.
  matchedPath
  string
  Contains the actual JSON path 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 the matchedPath would be SomeArray[0].SomeProperty.
  error
  object
  Contains errors related to the operation, if any occurred during log processing.
  id
  string
  Contains the unique identifier of this error.
  code
  string
  Contains a code indicating the kind of error which occurred.
  meta
  object
  Contains metadata with details about the error which occurred. This metadata object can be variable based on the specific error.
  title
  string
  Contains a human-readable description of the error which ocurred.
  detail
  string
  Contains an explanation of the error which is more specific than the title property.
  failedStage
  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
  Processing stages represent the phases of a given log attempt. Each stage contains details and outcomes for that specific phase of processing.
  request
  object
  Contains data for processing stages. The fields in this object are optional unless marked required. Details for some stages are consistently persisted. If other details aren't yet or won't be available for a given stage, this is populated with "dataUnavailable": true.
  number
  required, integer
  Indicates the sequential order of a given stage in the processing order.
  name
  required, string
  Displays the name of the processing stage.
  status
  nullable, required, string
  Indicates the overall status of the stage. If processing didn't reach the given stage, this field equals null.
  Possible Values: succeeded, failed, filtered, pending
  timestamp
  nullable, string
  Displays the timestamp associated with outcome of the given processing stage. This field is nullable.
  Format: date-time
  dataFormat
  string
  Describes the format the data is in when exchanged during the given processing stage.
  communicationMethod
  string
  Describes the type of communication method used to exchange data during the given processing stage.
  code
  string
  Displays the response code for the request made or received during the given processing stage; the response code varies based on the communicationMethod.
  error
  object
  Stage error
  message
  string
  Contains the text description of the error that occurred during the given processing stage. You can only view this if you have PHI access.
  dataUnavailable
  boolean
  Indicates whether more details are or will be available for this processing stage. If set to true, more details aren't or won't be available.
  process-request
  object
  Contains data for processing stages. The fields in this object are optional unless marked required. Details for some stages are consistently persisted. If other details aren't yet or won't be available for a given stage, this is populated with "dataUnavailable": true.
  number
  required, integer
  Indicates the sequential order of a given stage in the processing order.
  name
  required, string
  Displays the name of the processing stage.
  status
  nullable, required, string
  Indicates the overall status of the stage. If processing didn't reach the given stage, this field equals null.
  Possible Values: succeeded, failed, filtered, pending
  timestamp
  nullable, string
  Displays the timestamp associated with outcome of the given processing stage. This field is nullable.
  Format: date-time
  dataFormat
  string
  Describes the format the data is in when exchanged during the given processing stage.
  communicationMethod
  string
  Describes the type of communication method used to exchange data during the given processing stage.
  code
  string
  Displays the response code for the request made or received during the given processing stage; the response code varies based on the communicationMethod.
  error
  object
  Stage error
  message
  string
  Contains the text description of the error that occurred during the given processing stage. You can only view this if you have PHI access.
  dataUnavailable
  boolean
  Indicates whether more details are or will be available for this processing stage. If set to true, more details aren't or won't be available.
  receive-request
  object
  Contains data for processing stages. The fields in this object are optional unless marked required. Details for some stages are consistently persisted. If other details aren't yet or won't be available for a given stage, this is populated with "dataUnavailable": true.
  number
  required, integer
  Indicates the sequential order of a given stage in the processing order.
  name
  required, string
  Displays the name of the processing stage.
  status
  nullable, required, string
  Indicates the overall status of the stage. If processing didn't reach the given stage, this field equals null.
  Possible Values: succeeded, failed, filtered, pending
  timestamp
  nullable, string
  Displays the timestamp associated with outcome of the given processing stage. This field is nullable.
  Format: date-time
  dataFormat
  string
  Describes the format the data is in when exchanged during the given processing stage.
  communicationMethod
  string
  Describes the type of communication method used to exchange data during the given processing stage.
  code
  string
  Displays the response code for the request made or received during the given processing stage; the response code varies based on the communicationMethod.
  error
  object
  Stage error
  message
  string
  Contains the text description of the error that occurred during the given processing stage. You can only view this if you have PHI access.
  dataUnavailable
  boolean
  Indicates whether more details are or will be available for this processing stage. If set to true, more details aren't or won't be available.
  respond
  object
  Contains data for processing stages. The fields in this object are optional unless marked required. Details for some stages are consistently persisted. If other details aren't yet or won't be available for a given stage, this is populated with "dataUnavailable": true.
  number
  required, integer
  Indicates the sequential order of a given stage in the processing order.
  name
  required, string
  Displays the name of the processing stage.
  status
  nullable, required, string
  Indicates the overall status of the stage. If processing didn't reach the given stage, this field equals null.
  Possible Values: succeeded, failed, filtered, pending
  timestamp
  nullable, string
  Displays the timestamp associated with outcome of the given processing stage. This field is nullable.
  Format: date-time
  dataFormat
  string
  Describes the format the data is in when exchanged during the given processing stage.
  communicationMethod
  string
  Describes the type of communication method used to exchange data during the given processing stage.
  code
  string
  Displays the response code for the request made or received during the given processing stage; the response code varies based on the communicationMethod.
  error
  object
  Stage error
  message
  string
  Contains the text description of the error that occurred during the given processing stage. You can only view this if you have PHI access.
  dataUnavailable
  boolean
  Indicates whether more details are or will be available for this processing stage. If set to true, more details aren't or won't be available.
  process-response
  object
  Contains data for processing stages. The fields in this object are optional unless marked required. Details for some stages are consistently persisted. If other details aren't yet or won't be available for a given stage, this is populated with "dataUnavailable": true.
  number
  required, integer
  Indicates the sequential order of a given stage in the processing order.
  name
  required, string
  Displays the name of the processing stage.
  status
  nullable, required, string
  Indicates the overall status of the stage. If processing didn't reach the given stage, this field equals null.
  Possible Values: succeeded, failed, filtered, pending
  timestamp
  nullable, string
  Displays the timestamp associated with outcome of the given processing stage. This field is nullable.
  Format: date-time
  dataFormat
  string
  Describes the format the data is in when exchanged during the given processing stage.
  communicationMethod
  string
  Describes the type of communication method used to exchange data during the given processing stage.
  code
  string
  Displays the response code for the request made or received during the given processing stage; the response code varies based on the communicationMethod.
  error
  object
  Stage error
  message
  string
  Contains the text description of the error that occurred during the given processing stage. You can only view this if you have PHI access.
  dataUnavailable
  boolean
  Indicates whether more details are or will be available for this processing stage. If set to true, more details aren't or won't be available.
  receive-response
  object
  Contains data for processing stages. The fields in this object are optional unless marked required. Details for some stages are consistently persisted. If other details aren't yet or won't be available for a given stage, this is populated with "dataUnavailable": true.
  number
  required, integer
  Indicates the sequential order of a given stage in the processing order.
  name
  required, string
  Displays the name of the processing stage.
  status
  nullable, required, string
  Indicates the overall status of the stage. If processing didn't reach the given stage, this field equals null.
  Possible Values: succeeded, failed, filtered, pending
  timestamp
  nullable, string
  Displays the timestamp associated with outcome of the given processing stage. This field is nullable.
  Format: date-time
  dataFormat
  string
  Describes the format the data is in when exchanged during the given processing stage.
  communicationMethod
  string
  Describes the type of communication method used to exchange data during the given processing stage.
  code
  string
  Displays the response code for the request made or received during the given processing stage; the response code varies based on the communicationMethod.
  error
  object
  Stage error
  message
  string
  Contains the text description of the error that occurred during the given processing stage. You can only view this if you have PHI access.
  dataUnavailable
  boolean
  Indicates whether more details are or will be available for this processing stage. If set to true, more details aren't or won't be available.

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®.