Overview
The following reconciliation reports are supported by Nuclei Firehose:
- Reconciliation Daily
- Reconciliation Weekly
- Reconciliation Monthly
Reports are distributed via email with report data attached in CSV format.
Report Distribution
Reconciliation Daily
Daily reconciliation reports are sent daily at 7:00 AM EST.
Reconciliation Weekly
Weekly reconciliation reports are sent every Monday at 7:00 AM EST.
Reconciliation Monthly
Monthly reconciliation reports are sent on the first day of the month at 7:00 AM EST.
Report Summary
The following summary information is included with each report instance (email body):
- Report Name
- Source Data
- Start Date
- End Date
- Total Events
- Archived Events
- Unarchived Events
Report Data
The following event metadata is included within each reconciliation report instance:
- customer_id
- feed_id
- nuclei_event_id
- archive_id
- event_start
- event_state
- network_name
- participants
- source_event_id
- source_event_type
- source_thread_id
- speech_to_text
Definitions
Report Summary
Report Name
The name of report instance. (Reconciliation Daily, Weekly, or Monthly)
Source Data
This describes all event sources included in the report.
Start Date
This is the start datetime for all data included in the report.
End Date
This is the end datetime for all data included in the report.
Total Events
This is the total number of events within the reporting period.
Archived Events
This is the total number of archived events within the reporting period.
Unarchived Events
This is the total number of unarchived events within the reporting period.
Report Data
customer_id
This is your customer ID.
feed_id
This is the ID of the data source feed.
nuclei_event_id
Global event ID within Nuclei Firehose.
archive_id
This is the unique ID assigned to the event by the downstream archiving integration.
event_start
This is the start datetime for the related event.
event_state
This is the state of the event within Nuclei Firehose. Valid states include:
- CREATED
- New, successfully ingested event.
- EMPTY
- Empty event (no content), with nothing to archive.
- PACKAGED
- Event successfully packaged for archiving.
- PACKAGING_FAILED
- Event packaging for archiving failed.
- ARCHIVED
- Event archived successfully.
- ARCHIVING_FAILED
- Event archiving failed.
- ARCHIVE_SUBMITTED
- Event submitted to archive (unknown or pending archive state)
network_name
This is the name of the source network for the event.
participants
This is a summary of the unique participants IDs that were included in the event.
source_event_id
This the unique ID of the event from the source system.
source_event_type
This it the type of the event within the source system.
source_thread_id
This is the unique ID of a thread of related events from the source system.
speech_to_text
This indicates if speech to text processing was used on the related event.
More Information
For more information on the reporting capabilities of Nuclei Firehose, please contact our support team at support@nuclei.ai.
Comments
0 comments
Article is closed for comments.