Search payloads

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

Page View

Logs endpoints allow you to review log metadata, including relevant timestamps and statuses, or the actual payload. You must be assigned to the appropriate role to view or search log payloads.

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

Search payloads

Retrieve a list of log payloads 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.

Only users assigned to support or engineer roles can search or view log payloads. Learn about roles.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/logs/search/payloads' \
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
  "dateMode": "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
  "searchTerms": [
18
    {
19
      "value": "Nila Jonkel",
20
      "category": "patient"
21
    }
22
  ]
23
}'

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
dateMode
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 endpoint 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
searchTerms
Array of object
Contains any keywords you want to use to search log content by. You can include one term per search.
- value
  string
  Contains the value that you're searching for in the log metadata.
- category
  string
  Specifies that the logs to search are those with the indicated category. By default, if you indicate null, it means that the logs to search are those explicitly with no category.
  Possible Values: patient, provider, visit, record, metadata, null

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
    "results": {
17
      "id": "d758ea49-027b-4d6e-b4dd-a3500d8cc2e8",
18
      "createdAt": "2021-04-02T22.52.38.093Z",
19
      "updatedAt": "2021-05-05T22:52:38:093Z",
20
      "dataModel": "PatientAdmin",
21
      "eventType": "Transfer",
22
      "status": "filtered",
23
      "type": "send",
24
      "source": {
25
        "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
26
        "name": "Redox",
27
        "organization": {
28
          "id": 98765,
29
          "name": "Organization Name"
30
        }
31
      },
32
      "destination": {
33
        "id": "d710d1fd-15ef-4f84-9eab-16f03f9f5f87",
34
        "name": "Redox",
35
        "organization": {
36
          "id": 98765,
37
          "name": "Organization Name"
38
        }
39
      },
40
      "matchCategories": [
41
        "record"
42
      ]
43
    }
44
  }
45
}

Contains the payload and metadata returned for Search 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 Search Logs.
- results
  object
  Indicates the beginning of the payload results returned for Search Logs, which includes the match categories for each result.
  id
  string
  Displays the unique identifier for 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 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.
  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 endpoint of the message.
  id
  string
  Displays the unique identifier of the system containing the endpoint that the message was directed to.
  Format: uuid
  name
  string
  Displays the name of the endpoint 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 search term 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®.