Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



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

File Name

urlsYYYY-MM-DD.txt

Tab Delimited Files

Tab delimited files are standard text fields with one record per line, with columns separated by a tab.

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 LengthAllows Nulls

Description

click_idString255
Unique click ID defined by Vibes.
person_idString255✔︎Unique Vibes-specified GUID representing the Person.
external_person_idString255✔︎The external_person_id associated with the Person.
mdnString20✔︎The Mobile Directory Number (MDN) associated with the Person. The Mobile Directory Number (MDN) must be in E.164 format. Example: +12295551234.

message_id

String

255✔︎

Unique message ID defined by Vibes.

click_timestampDate/TimeN/A
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_domainString255
Domain that the shortened URL was created on. Example: vbs.cm.
short_keyString20
URI of the shortened URL.
long_urlString2048
Long URL that was shortened.
first_clickStringBoolean
Flag - Indicates if this was the first click for this short_key.
first_device_clickStringBoolean

Flag - Indicates if this was the first click

by

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_typeString255
Type of activity the message is associated with (Broadcast, Acquisition, and so on).
activity_idString255✔︎ID of the activity the message is associated with.
company_idString255✔︎ID of the company.

Example File

View file
nameurl_click_extract_samplefile_txt.txt
height250