Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Converted from version '1.2'.

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. 

Note
Note: If your extracts are not in the following format, it was a custom creation and you should reach out to your Customer Success representative for more information about your extract.


File Name

urls_YYYY-MM-DD.txt

Tab Delimited Files

Extract files will have each column delimited by a tab, as well as each record delimited by a line feed.

Contents of Each File

Each row represents a click on a URL that was shortened by the Vibes Platform.

File Body

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

Each row represents a click on a URL that was shortened by the Vibes Platform.


     

Field Name

Data Type

Field LengthAllows Nulls

Description

click_idString50
Unique click ID defined by Vibes.
person_idString255✔︎Unique Vibes-specified GUID representing the Person.
external_person_idString40✔︎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

40✔︎

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 - if this was the first click.
first_device_clickStringBoolean
Flag - if this was the first click by the mobile device.
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.csv
height150
 
View file
nameurl_click_extract_samplefile_txt.txt
height150