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.
This query allows you to retrieve logs with their related metadata and payloads based on the criteria you specify with the query parameters. Typically, you can use this if you're searching for specific data within a log payload and you have a good idea of when the log happened.
If you're retrieving a large list of logs, we recommend setting a date range with createdAfter and createdBefore to improve query performance and to ensure you retrieve an accurate dataset.
If you don't have PHI access in the Redox dashboard, you're able to query this endpoint but can't include any search parameters that may contain PHI data. Also, the response only contains log metadata, not any PHI data from the payload. This applies to all environments for users without PHI access.
Contains the unique identifier of the Redox dashboard organization you're querying on behalf of.
cURL request example
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/logs' \--request POST \--header 'Authorization: Bearer $API_TOKEN' \--header 'accept: application/json' \--header 'content-type: application/json' \--data '{"searchTerms": [{"value": "Nila Jonkel","category": "patient"}],"dataModel": "Patient Admin","eventType": "Admit","createdAfter": "2020-01-01T00:00:00.000Z","createdBefore": "2020-01-01T00:00:00.000Z","sourceId": "95394e6e-5721-404d-a6f8-ff7132b8b","destinationId": "3d5a0411-10b0-468d-84de-1ad882418","type": "request","status": "failed"}'
Describes the format of a request to perform a log search.
Contains any keywords you want to use to search log content by. You can include one term per search.
Contains the value that you're searching for in the log metadata.
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.
patient, provider, visit, record, metadata, nullSpecifies that the logs to search are those with messages using the designated data model.
Specifies that the logs to search are those with messages using the designated event type.
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).
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).
Specifies that the logs to search are those with messages originating from the system with this unique identifier.
Specifies that the logs to search are those with messages sent to the endpoint with this unique identifier.
Specifies that the logs to search are those with the indicated type (send, receive, request, respond, or unknown).
send, receive, request, respond, unknownSpecifies that the logs to search are those with the indicated status (i.e., succeeded, failed, filtered, or pending).
succeeded, failed, filtered, pending{"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"}},"matchCategories": ["record"]}}}
Contains the payload and metadata returned for Search Logs.
Contains the metadata information for the returned results, including version and pagination information.
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.
Contains the pagination data for the returned results.
Displays the current page number of returned results you're viewing.
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.
Displays the number of results included in each page.
Contains the related pagination links for the returned results.
Links to the current page of results.
Links to the next page of results.
Links to the first page of results.
Contains the payload returned for Search Logs.
Indicates the beginning of the payload results returned for Search Logs, which includes the match categories for each result.
Displays the unique identifier for the specific log, which you can use for reference or for a Get Logs by ID search.
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.
Displays the date and time that the log was last updated in ISO 8601 format.
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/).
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/).
Indicates the current status of the log [i.e., succeeded, failed, filtered, pending].
succeeded, failed, filtered, pendingIndicates the type of data exchange that initiated the log (i.e., send, receive, request, respond, unknown.
send, receive, request, respond, unknownContains the details for the system that initiated the message associated with the log.
Displays the unique identifier for the system that initiated the message.
Displays the name of the system that initiated the message.
Contains the details about the Redox dashboard organization associated with this log.
Displays the unique identifier of the dashboard organization.
Displays the name of the dashboard organization.
Contains the details for the intended endpoint of the message.
Displays the unique identifier of the system containing the endpoint that the message was directed to.
Displays the name of the endpoint that the message was directed to.
Contains the details about the Redox dashboard organization associated with this log.
Displays the unique identifier of the dashboard organization.
Displays the name of the dashboard organization.
Identifies the category that the matched search term belongs to (e.g., patient, provider, visit, record, metadata, null)