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.
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.
cURL request example
Path Parameters
- environmentIdrequired, string
Identifies the specific environment that you're operating in or on behalf of.
Query Parameters
- _countnumber
Defines the number of results to return per page. The maximum value per page is 50.
- _cursorstring
Identifies the next set of results for a given search.
Request Body Schema
- facilityCodestring
Searches the FacilityCode field specified in Redox JSON's Meta header
- 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 tobackfill
. Leaving this parameter blank maintains default behavior.Possible Values:realtime
,backfill
- serviceRegionstring
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
- dataModelstring
Indicates the data model used to exchange data.\n\nThis is the equivalent of the
Meta.DataModel
field in our data models. - eventTypestring
Indicates the particular event type of a data model that's used to exchange data.\n\nThis is the equivalent of the
Meta.EventType
field in our data models. - createdAfterstring
Used 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 - createdBeforestring
Used 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 - updatedAfterstring
Used 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 last updated date for the logs to search should be equal to or creater than the date and time in this format (YYYY-MM-DDThh:mm:ss.sssZ).
Format: date-time - updatedBeforestring
Used 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 last updated 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 - sourceIdstring
Contains the unique identifier of the source.
Format: uuid - destinationIdstring
Contains the unique identifier of the destination.
Format: uuid - typestring
Indicates the type of data exchange that initiated the log (e.g.,
send
,receive
,request
,respond
,unknown
).Possible Values:receive
,request
,respond
,send
,unknown
- statusstring
Indicates the current status of the log [e.g.,
succeeded
,failed
,filtered
,pending
].Possible Values:failed
,filtered
,pending
,succeeded
You must include a requestBody
, even if it's empty.
- metaobject
Contains metadata about paginated results of returned data.
- 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.
- linksobject
- selfstring
Links to the current page of results.
- firststring
Links to the first page of results.
- nextstring
Links to the next page of results.
- pageSizenumber
Describes the number of records included in each page of the current result set.
- pageTypestring
Describes the pagination algorithm. This endpoint only supports cursor pagination.
Value:cursor
- payloadobject
Contains the query results for each log entry.
- resultsArray of object
- idstring
Contains the unique identifier of the log.
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.
Format: date-time - updatedAtstring
Displays the date and time when the log was last updated in ISO 8601 format.
Format: date-time - dataModelstring
Indicates the data model used to exchange data.\n\nThis is the equivalent of the
Meta.DataModel
field in our data models. - eventTypestring
Indicates the particular event type of a data model that's used to exchange data.\n\nThis is the equivalent of the
Meta.EventType
field in our data models. - statusstring
Indicates the current status of the log [e.g.,
succeeded
,failed
,filtered
,pending
].Possible Values:failed
,filtered
,pending
,succeeded
- typestring
Indicates the type of data exchange that initiated the log (e.g.,
send
,receive
,request
,respond
,unknown
).Possible Values:receive
,request
,respond
,send
,unknown
- sourceobject
Describes the system that initiated the log.
- idstring
Contains the unique identifier of the source.
Format: uuid - namenullable, string
Displays the human-readable name of the source.
- organizationobject
Contains metadata about the Redox organization.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.
- destinationobject
Describes the intended destination of the log.
- idstring
Contains the unique identifier of the destination.
Format: uuid - namenullable, string
Displays the human-readable name of the destination.
- organizationobject
Contains metadata about the Redox organization.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.