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.
Path Parameters
- organizationIdrequired, string
Contains the unique identifier of the Redox dashboard organization you're querying on behalf of.
Query Parameters
- dataModelstring
Specifies that you want to get logs for messages using the designated data model.
- eventTypestring
Specifies that you want to get logs for messages using the designated event type.
- createdAfterstring
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). - createdBeforestring
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). - updatedAfterstring
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). - updatedBeforestring
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). - sourceIdstring
Specifies that you want to get logs for messages originating from the system with this unique identifier.
- destinationIdstring
Specifies that you want to get logs for messages sent to the endpoint with this unique identifier.
- typestring
Specifies that you want to get logs of the indicated type [
send
,receive
,request
,respond
, orunknown
]. - statusstring
Specifies that you want to get logs with the indicated status [
succeeded
,failed
,filtered
, orpending
]. - dataModestring
Indicates the type of log traffic to search (e.g.,
backfill
orrealtime
).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. - sortOrderstring
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.
cURL request example
Example payload generated from schema
- metaobject
Contains the metadata information for the returned results, including version and pagination information.
- versionstring
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.
- pageobject
Contains the pagination data for the returned results.
- currentPageinteger
Displays the current page number of returned results you're viewing.
- pageTypestring
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. - pageSizeinteger
Displays the number of results included in each page.
- linksobject
Contains the related pagination links for the returned results.
- selfstring
Links to the current page of results.
- nextstring
Links to the next page of results.
- firststring
Links to the first page of results.
- payloadobject
Contains the payload returned for
Get Logs
.- resultsobject
Contains the details for the returned log entries.
- idstring
Displays the unique identifier for the specific log, which you can use for reference or for a
Get log
search.Format: uuid - createdAtstring
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.
- updatedAtstring
Displays the date and time that the log was last updated in ISO 8601 format.
- dataModelstring
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/). - eventTypestring
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/). - statusstring
Indicates the current status of the log [i.e.,
succeeded
,failed
,filtered
,pending
].Possible Values:succeeded
,failed
,filtered
,pending
- typestring
Indicates the type of data exchange that initiated the log (i.e.,
send
,receive
,request
,respond
,unknown
.Possible Values:send
,receive
,request
,respond
,unknown
- sourceobject
Contains the details for the system that initiated the message associated with the log.
- idstring
Displays the unique identifier for the system that initiated the message.
Format: uuid - namestring
Displays the name of the system that initiated the message.
- organizationobject
Contains the details about the Redox dashboard organization associated with this log.
- idinteger
Displays the unique identifier of the dashboard organization.
- namestring
Displays the name of the dashboard organization.
- destinationobject
Contains the details for the intended endpoint of the message.
- idstring
Displays the unique identifier of the system containing the endpoint that the message was directed to.
Format: uuid - namestring
Displays the name of the endpoint that the message was directed to.
- organizationobject
Contains the details about the Redox dashboard organization associated with this log.
- idinteger
Displays the unique identifier of the dashboard organization.
- namestring
Displays the name of the dashboard organization.
Contains the payload and metadata returned for Get Logs
.