| Field | Type | Description |
|---|---|---|
| Transcript | Object | Transcript object. |
| Id | String | Engagement's ID |
| EngagementType | Number | Engagement's type (Chat = 1, Call = 2) |
| SiteName | String | Site's Name |
| SiteID | Number | Site's ID |
| GroupName | String | Group's Name |
| GroupID | Number | Group's ID |
| Tier | Number | Tier's ID |
| IsAgentToAgent | Boolean | Is this engagement between agents? |
| StartTime | String | Time engagement was initiated |
| EndTime | String | Time engagement was ended |
| Answered | String | Time the engagement answered |
| Rejected | String | If rejected, time the engagement was rejected |
| Queued | String | If queued, time the engagement entered the queue |
| Transferred | String | If transferred, time the engagement was transferred |
| HasConverted | Boolean | Has the engagement converted? |
| Rating | Number | Rating for the engagement (0 through 10) - used to calculate NPS Score |
| StartHour | Number | Number representing the hour the engagement started |
| Length | String | TimeSpan indicating the duration of the engagement |
| TotalSeconds | Number | TimeSpan indicating the duration of the engagement in seconds. |
| Agents | Object[] | List of UserType objects (Information about the Agents involved with this engagement) |
| UserID | Number | Agent's ID |
| UserLevel | Number | User's level (User = 0, System = 1) |
| IsCreator | Boolean | Was this agent the initiator for the engagement? |
| IP | String | Agent's IP address |
| DisplayName | String | Agent's display name |
| WhenJoined | String | When the agent joined the engagement |
| WhenExited | String | When the agent exited the engagement |
| LastRetrievedText | String | When was the agent's last retrieved text |
| LastSentText | String | When was the agent's last sent text |
| LastTyped | String | When was the agent's last typed |
| Visitor | Object | VisitorType object (Information about the visitor) |
| Id | String | Visitor's ID |
| SessionID | String | Visitor's session ID |
| AreaCode | Number | Visitor's area code |
| BrowserType | String | Visitor's browser type |
| City | String | Visitor's city |
| Country | String | Visitor's country |
| CountryCode | String | Visitor's country code |
| DNS | String | Visitor's DNS |
| EmailAddress | String | Visitor's email address |
| GroupVisited | Number | Group ID of the group the visitor visited |
| IsInvite | Boolean | Was the visitor invited to a chat? |
| ISP | String | Visitor's ISP |
| Keywords | String | Visitor's search query they used to get to the site |
| Latitude | Number | Visitor's latitude |
| Longitude | Number | Visitor's longitude |
| Location | String | Visitor's location |
| Organization | String | Visitor's organization |
| PostalCode | String | Visitor's postal code |
| ReferredBy | String | Visitor's referrer |
| Region | String | Visitor's region |
| URLReferrer | String | Visitor's URL Referrer |
| UserLevel | Number | Visitor's User's level (User = 0, System = 1) |
| IsCreator | Boolean | Was the visitor the initiator of the engagement? |
| IP | String | Visitor's IP address |
| DisplayName | String | Visitor's display name |
| WhenJoined | String | When the visitor joined the engagement |
| WhenExited | String | When the visitor exited the engagement |
| LastRetrievedText | String | When was the visitor's last retrieved text |
| LastSentText | String | When was the visitor's last sent text |
| LastTyped | String | When was the visitor's last typed |
| FirstVisit | String | When was the visitor's first visit |
| Personas | Object[] | List of PersonaType objects (Information about the persona) |
| Id | Number | Persona's ID |
| Name | String | Persona's Name |
| Value | Number | Persona's Value |
| DynamicProperties | Object[] | List of ActionType objects (Information about the visitor's actions) |
| Id | Number | action's ID |
| Type | Number | action's Type |
| Value | Number | action's Value |
| When | String | time the action took place |
| Category | String | DynamicProperty's category |
| Name | String | DynamicProperty's Name |
| Value | String | DynamicProperty's Value |
| LiveChatLines | Object[] | List of LiveChatLineType objects (Information about the chat lines) |
| Id | Number | Line's ID |
| DateCreated | String | Date the line was created |
| UserID | Number | User ID of the creator of the line |
| FromDisplay | String | Display name of the creator of the line |
| LineType | Number | Line's Type (Text = 1, Premade = 2, ModifiedPremade = 3, PushPage = 4) |
| LineCreator | Number | Line's Creator (Agent = 1, System = 2, Notice = 3, Visitor = 4) |
| LineVisibility | Number | Line's Visibility (Agent = 1, All = 2) |
| OwnerLevel | Number | Owner's Level (User = 0, System = 1) |
| Text | String | Line's text |
| Rating | Number | Line's Rating (Unset = 0, Negative = 1, Positive = 2) |
| PremadeID | Number | If line was a Premade Message, the Premade's ID |
| ConvertedLine | Object[] | List of LiveChatConvertedLineType objects (Converted chat lines information [aka translations]) |
| Id | String | Line's ID |
| Text | String | Line's text |
| CustomData | Object[] | List of CustomDataType objects (Information about the custom data) |
| Id | Number | Custom Data's ID |
| Attribute | String | Custom Data's attribute |
| Value | String | Custom Data's value |
| SurveyResults | Object[] | List of SurveyResultType objects (Information about the surveys) |
| Id | Number | Survey Result's ID |
| Question | String | Survey's question |
| Answer | String | Survey's answer |
| SurveyChoices | Object[] | List of SurveyChoicesType objects (Selected options) |
| Id | Number | Choice's ID |
| ChoiceText | String | Choice's Text |
| ChoiceValue | String | Choice's Value |
| SurveyType | Number | Survey's Type (Prechat = 1, Postchat = 2, Unavailable = 3, AgentPostChat = 4) |
Velaro Transcript Field Definitions
Was this article helpful?
Thank you!