Get Log by ID

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

Page View

This category contains log details, whether metadata like relevant timestamps and statuses or the actual payload.

You can retrieve a list of log metadata, search for specific data within log payloads, or retrieve a specific log payload for review.

Get Log by ID

This query allows you to retrieve one specific log and its related payload based on the unique log identifier. This may be helpful if you find a log that you want to review in more detail after performing a Get Logs query.

Request parameters

Path Parameters

organizationId
required, string
Contains the unique identifier of the Redox dashboard organization you're querying on behalf of.
logId
required, string
Identifies the specific log that you'd like to retrieve metadata for.

Select example

cURL request example

cURL

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

Response fields and example

Example payload generated from schema

{
  "meta": {
    "version": "1.0.0",
    "page": {
      "currentPage": 1,
      "pageType": "offset",
      "pageSize": 50,
      "links": {
        "self": "/organizations/12345/logs",
        "next": "/organizations/12345/logs?_page=2&_count=50",
        "first": "/organizations/12345/logs?_page=1&_count=50"
      }
    }
  },
  "payload": {
    "id": "d758ea49-027b-4d6e-b4dd-a3500d8cc2e8",
    "createdAt": "2021-04-02T22.52.38.093Z",
    "updatedAt": "2021-05-05T22:52:38:093Z",
    "dataModel": "PatientAdmin",
    "eventType": "Transfer",
    "status": "filtered",
    "type": "send",
    "source": {
      "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
      "name": "Redox",
      "organization": {
        "id": 98765,
        "name": "Organization Name"
      }
    },
    "destination": {
      "id": "d710d1fd-15ef-4f84-9eab-16f03f9f5f87",
      "name": "Redox",
      "organization": {
        "id": 98765,
        "name": "Organization Name"
      }
    },
    "attempts": {
      "total": 25,
      "latest": {
        "id": "d99bda81-5a95-4e7a-9b90-10ee3562c210",
        "attemptAt": "2021-05-06T22:52:38.093Z",
        "status": "succeeded",
        "failedStage": "receive-request",
        "stages": {
          "request": {
            "number": 1,
            "name": "Request",
            "status": "succeeded",
            "timestamp": "2021-04-02T23:15:58.960Z",
            "dataFormat": "HL7v2",
            "communicationMethod": "MLLP",
            "code": "ACK",
            "error": {
              "message": "string"
            },
            "dataUnavailable": false
          },
          "process-request": {
            "number": 1,
            "name": "Request",
            "status": "succeeded",
            "timestamp": "2021-04-02T23:15:58.960Z",
            "dataFormat": "HL7v2",
            "communicationMethod": "MLLP",
            "code": "ACK",
            "error": {
              "message": "string"
            },
            "dataUnavailable": false
          },
          "receive-request": {
            "number": 1,
            "name": "Request",
            "status": "succeeded",
            "timestamp": "2021-04-02T23:15:58.960Z",
            "dataFormat": "HL7v2",
            "communicationMethod": "MLLP",
            "code": "ACK",
            "error": {
              "message": "string"
            },
            "dataUnavailable": false
          },
          "respond": {
            "number": 1,
            "name": "Request",
            "status": "succeeded",
            "timestamp": "2021-04-02T23:15:58.960Z",
            "dataFormat": "HL7v2",
            "communicationMethod": "MLLP",
            "code": "ACK",
            "error": {
              "message": "string"
            },
            "dataUnavailable": false
          },
          "process-response": {
            "number": 1,
            "name": "Request",
            "status": "succeeded",
            "timestamp": "2021-04-02T23:15:58.960Z",
            "dataFormat": "HL7v2",
            "communicationMethod": "MLLP",
            "code": "ACK",
            "error": {
              "message": "string"
            },
            "dataUnavailable": false
          },
          "receive-response": {
            "number": 1,
            "name": "Request",
            "status": "succeeded",
            "timestamp": "2021-04-02T23:15:58.960Z",
            "dataFormat": "HL7v2",
            "communicationMethod": "MLLP",
            "code": "ACK",
            "error": {
              "message": "string"
            },
            "dataUnavailable": false
          }
        }
      }
    }
  }
}

Contains the metadata, payload, and attempt information returned for Get Logs by ID.

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
  Displays the unique identifier for the specific log, which you can use for reference or for a Get Logs by ID search.
- 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 which data model was used in the data exchange that triggered the creation of the log.
  
  This is the same as the Meta.DataModel field in our data models (https://developer.redoxengine.com/data-models/).
- eventType
  string
  Indicates which event type was used in the data exchange that triggered the creation of the log.
  
  This is the same as the Meta.EventType field in our data models (https://developer.redoxengine.com/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
  Displays the unique identifier for the system that initiated the message.
  name
  string
  Displays the name of the system that initiated the message.
  organization
  object
  Contains the details about the Redox dashboard organization associated with this log.
  id
  integer
  Displays the unique identifier of the dashboard organization.
  name
  string
  Displays the name of the dashboard organization.
- destination
  object
  Contains the details for the intended endpoint of the message.
  id
  string
  Displays the unique identifier of the system containing the endpoint that the message was directed to.
  name
  string
  Displays the name of the endpoint that the message was directed to.
  organization
  object
  Contains the details about the Redox dashboard organization associated with this log.
  id
  integer
  Displays the unique identifier of the dashboard organization.
  name
  string
  Displays the name of the dashboard 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
  Displays the unique identifier for the most recent log attempt.
  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
  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 of the attempt, with details related to success or error. Each stage has it’s own key within this object: async: send / process / receive sync: request / process-request / receive-request / respond / process-response / receive-response unknown: accept / 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
  integer
  Indicates the sequential order of a given stage in the processing order.
  name
  string
  Displays the name of the processing stage.
  status
  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, null
  timestamp
  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
  integer
  Indicates the sequential order of a given stage in the processing order.
  name
  string
  Displays the name of the processing stage.
  status
  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, null
  timestamp
  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
  integer
  Indicates the sequential order of a given stage in the processing order.
  name
  string
  Displays the name of the processing stage.
  status
  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, null
  timestamp
  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
  integer
  Indicates the sequential order of a given stage in the processing order.
  name
  string
  Displays the name of the processing stage.
  status
  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, null
  timestamp
  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
  integer
  Indicates the sequential order of a given stage in the processing order.
  name
  string
  Displays the name of the processing stage.
  status
  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, null
  timestamp
  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
  integer
  Indicates the sequential order of a given stage in the processing order.
  name
  string
  Displays the name of the processing stage.
  status
  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, null
  timestamp
  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.