Search metadata

post/v1/environments/{environmentId}/logs/search/metadata

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.

Search metadata

Query for relevant logs using metadata criteria. This endpoint allows you to search log metadata only.

The response contains a list of metadata for matching logs based on the criteria you specify with 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 retrieving a large list of logs, we recommend setting a date range with updatedAfter and updatedBefore to improve query performance and ensure you retrieve an accurate dataset.

All users can search log metadata.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/logs/search/metadata' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "dataModel": "Patient Admin",
8
  "serviceRegion": "AWS_USA_EAST_1",
9
  "dataMode": "backfill",
10
  "eventType": "Admit",
11
  "createdAfter": "2020-01-01T00:00:00.000Z",
12
  "createdBefore": "2020-01-01T00:00:00.000Z",
13
  "sourceId": "95394e6e-5721-404d-a6f8-ff7132b8b",
14
  "destinationId": "3d5a0411-10b0-468d-84de-1ad882418",
15
  "type": "request",
16
  "status": "failed",
17
  "facilityCode": "2.16.840.1.113883.3.6147.458.2"
18
}'

Path Parameters

environmentId
required, string
Identifies the specific environment that you're operating in or on behalf of.

Query Parameters

_count
number
Defines the maximum number of results to return. For data on demand, the maximum count is 1000.
_cursor
string
Identifies the next set of results for a given search.

Request Body Schema

Describes the format of a request to perform a log search.

dataModel
string
Specifies that the logs to search are those with messages using the designated data model.
serviceRegion
string
This field is required if your environment is configured with multiple regions.
Possible Values: AWS_USA_EAST_1, AWS_CAN_CENTRAL, GCP_USA_CENTRAL_1
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.
Possible Values: realtime, backfill
eventType
string
Specifies that the logs to search are those with messages using the designated event type.
createdAfter
string
Used with createdBefore to set a date range for the logs to search, which we recommend if you plan to export large amounts of log metadata. This parameter designates that the creation date for the logs to search should be equal to or greater than the date and time in this format (YYYY-MM-DDThh:mm:ss.sssZ).
Format: date-time
createdBefore
string
Used with createdAfter to set a date range for the logs to search, which we recommend if you plan to export large amounts of log metadata. This parameter designates that the creation date for the logs to search should be less than or equal to the date and time in this format (YYYY-MM-DDThh:mm:ss.sssZ).
Format: date-time
sourceId
string
Specifies that the logs to search are those with messages originating from the system with this unique identifier.
Format: uuid
destinationId
string
Specifies that the logs to search are those with messages sent to the destination with this unique identifier.
Format: uuid
type
string
Specifies that the logs to search are those with the indicated type (send, receive, request, respond, or unknown).
Possible Values: send, receive, request, respond, unknown
status
string
Specifies that the logs to search are those with the indicated status (i.e., succeeded, failed, filtered, or pending).
Possible Values: succeeded, failed, filtered, pending
facilityCode
string
Searches FacilityCode field specified in Redox JSON's Meta header

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0",
4
    "page": {
5
      "pageType": "cursor",
6
      "pageSize": 50,
7
      "links": {
8
        "self": "/organizations/12345/logs?_count=50",
9
        "next": "/organizations/12345/logs?_count=50&_cursor=2024-11-07T20%3A59%3A09.363Z%2C0193086c-82b3-79e4-86f0-b5c419fb92ee",
10
        "first": "/organizations/12345/logs?_count=50"
11
      }
12
    }
13
  },
14
  "payload": {
15
    "results": {
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
      "matchCategories": [
40
        "record"
41
      ]
42
    }
43
  }
44
}

Contains a list of metadata for logs matching the query parameter criteria.

meta
object
Contains the metadata for returned results, including the version and cursor pagination details.
- 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.
  pageType
  string
  Specifies the supported pagination type for the returned results. For this endpoint, we only support cursor type, which uses a cursor to point to the next set of results.
  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 a list of metadata for logs that match the query parameter criteria.
- results
  object
  Contains the query results, which includes the match categories for each log entry.
  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.
  matchCategories
  Array of string
  Identifies the category that the matched criteria belongs to (e.g., patient, provider, visit, record, metadata, null).

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