Connection Events Report

Updated on 28 Jan 2025
2 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Standard Report: Connection Events

Purpose:

A flat file option for ingesting connection events. Clients not requiring real time event synchronization OR clients limited by technology resources are able to ingest Connection Events Reports and receive the same level of detail as the Push API. This report is available in both Staging and Production Environments.

Included Events:

Expected Frequency:

The default frequency is daily.

Clients may request the frequency be increased to 4x a day.

In these cases, reports will run with a 1 hour offset, meaning a 6am report will include data from 11pm the prior day to 5am the day of the report.

To account for the potential data delays to the data warehouse in excess of 1 hour, a daily report will be issued in addition to the 4x daily reports.

Standard Report File Properties: Connection Events

Property	Data Type	Length	Primary Key	Description
Client ID	string	100	Yes	The unique identifier of the Client.
CCID	string	255	Yes	The unique identifier of the Customer.
First Name	string	100	No	The first name of the Customer or Patient.
Last Name	string	100	No	The last name of the Customer or Patient.
Event Type	string	100	No	Identifies the main event type category.
Event Subtype	string	100	No	Identifies the subtype of the event.
Event Timestamp	date		Yes	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
Product Group ID	string	100	Yes	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
Channel Address	string	100	No	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
Current Consent	string	100	No	The current consent type for the channel address. Specifies the type of consent assigned to Customer's or Patient's phone number. Valid values are: written The phone number will have express written consent. express The phone number will have express consent. stop The phone number will have stop consent.
Previous Consent	string	100	No	The previous consent type for the channel address. The value may be set to null. Specifies the type of consent assigned to Customer's or Patient's phone number. Valid values are: written The phone number will have express written consent. express The phone number will have express consent. stop The phone number will have stop consent.
Source Channel	string	2	No	Identifies the source where the event originated from. Example values are: add-phone.api api csr file ivr legacy-onboarding.api onboarding-api onboarding.file phone-management-add.file sign-up-page sms_conversation stop-conversation wire.message
Secondary Source	string	10	No	A second level of tracking the source of an update or onboard request. Example: phone number removals occurring as a part of monthly Neustar analysis will have a client_source of Neustar.
Event ID	string	2	No	This is a unique Relay identifier used for tracking.
Custom Data	string	1000	No	If custom data is desired, this field will be added as a JSON blob to include ext fields specific to the client.

Guidance Document and Sample can be found here:

Connection Events Report Guide

119.64 KB

Was this article helpful?

What's Next

Experience Events Report