Get Logs

get/v1/organizations/{organizationId}/logs

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 Logs

This query allows you to retrieve a list of logs with their related metadata based on the criteria you specify with the query parameters. Usually, the list is qualified by a specific time range, like if you want to see what kind of traffic has happened within the last 3 hours.

If you're retrieving a large list of logs, we recommend setting a date range with updatedAfter and updatedBefore to improve query performance and to ensure you retrieve an accurate dataset.

Request parameters

Path Parameters

organizationId
required, string
Contains the unique identifier of the Redox dashboard organization you're querying on behalf of.

Query Parameters

dataModel
string
Specifies that you want to get logs for messages using the designated data model.
eventType
string
Specifies that you want to get logs for messages using the designated event type.
createdAfter
string
Used with createdBefore to set a date range for the returned logs, which we recommend if you plan to export large amounts of log metadata. This parameter designates that the creation date for the returned logs should be equal to or greater than the date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
createdBefore
string
Used with createdAfter to set a date range for the returned logs, which we recommend if you plan to export large amounts of log metadata. This parameter designates that the creation date for the returned logs should be less than or equal to the date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
updatedAfter
string
Used with updatedBefore to set a date range for the returned logs, which we recommend if you plan to export large amounts of log metadata. This parameter designates that the updated date for the returned logs should equal to or greater than the date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
updatedBefore
string
Used with updatedAfter to set a date range for the returned logs, which we recommend if you plan to export large amounts of log metadata. This parameter designates that the updated date for the returned logs should be less than or equal to the date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
sourceId
string
Specifies that you want to get logs for messages originating from the system with this unique identifier.
destinationId
string
Specifies that you want to get logs for messages sent to the endpoint with this unique identifier.
type
string
Specifies that you want to get logs of the indicated type [send, receive, request, respond, or unknown].
status
string
Specifies that you want to get logs with the indicated status [succeeded, failed, filtered, or pending].
sortOrder
string
Indicates how the returned logs should be sorted, whether in order of ascending (oldest to newest) or descending (newest to oldest) time. If not indicated, the returned logs are returned in descending order by default.

Select example

cURL request example

cURL

curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/logs' \
--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": {
    "results": {
      "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"
        }
      }
    }
  }
}

Contains the payload and metadata returned for Get Logs.

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 payload returned for Get Logs.
- results
  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.