The daily URL Click extract is used to sync URL click data between Vibes platform and a Customer Relationship Management (CRM) or Campaign Management system.

Standard File Name

The following is the recommended best practice for file names. File naming conventions may be changed upon request.

urls_<company_key>_<date>.<extension>

How to Read Files

Extract files will be delivered in tab-separated value (TSV) text files. The information is separated into rows and columns. Column data will be separated by tabs, while each new row will be separated by a hard return.

File Body

The file body can contain the following fields as data, separated by the delimiter and a header row.

Field Name	Data Type	Field Length	Allows Nulls	Description
click_id	String	255	No	Unique click ID defined by Vibes.
person_id	String	255	Yes	Unique Vibes-specified GUID representing the person. Note that while the field is labeled person_id, the value is the `person_key`.
external_person_id	String	255	Yes	The external_person_id associated with the person.
mdn	String	20	Yes	The MDN associated with the person. The MDN will be in E.164 format. Example: +12295551234.
message_id	String	255	Yes	Unique message ID defined by Vibes.
click_timestamp	Date/Time	N/A	No	The date/time when the URL was clicked. Format example: "2017-04-05 14:30:00 -0600", represents April 5th, 2017 at 2:30PM UTC with a 6 hour offset.
short_domain	String	255	No	Domain that the shortened URL was created on. Example: vbs.cm.
short_key	String	20	No	URI of the shortened URL.
long_url	String	2048	No	Long URL that was shortened.
first_click	String	Boolean	No	Flag - Indicates if this was the first click for this short_key.
first_device_click	String	Boolean	No	Flag - Indicates if this was the first click for this short_key on the mobile device. Note*: The device tracking is managed by utilizing browser cookies, so users clearing their cookies or browser incompatibilities can affect this flag.
activity_type	String	255	No	Type of campaign or activity the message is associated with. See a full list of activity types here.
activity_id	String	255	Yes	ID of the activity the message is associated with.
company_id	String	255	Yes	ID of the company.
user_agent_header	String	255	Yes	The first 255 characters of the browser user-agent header value.

Example File

Download an example file.