getConversions
V1. Retrieves conversions for a folder based on the Create date.
Input parameters
Parameter | Type | Version | Required | Description |
---|---|---|---|---|
FolderID |
string id |
All |
yes |
The identifier of the folder to retrieve data from |
FromDate |
date |
All |
no |
The start date |
ToDate |
date |
All |
no |
The end date |
PageStart |
integer |
v1 |
no |
The number of elements to skip in the result set. |
PageSize |
integer |
v1 |
no |
The number of results in the returned set. This can be used to limit the returned set to less than the server maximum (this will not allow you to exceed the server page size, which is 1000 records in most cases.) |
Return values
Parameter | Type | Version | Description |
---|---|---|---|
Data |
json array |
All |
A JSON array of JSON objects with the mappings of fields to values |
ConversionID | long | The conversion ID | |
VisitID | long | The visit ID | |
WebsiteDefID | long | The website definition ID | |
CountryCode | string | The country code of the customer | |
RegionCode | string | The region code of the customer | |
OperatorID | long | The agent assigned credit for this conversion | |
RefererID | long | The referrer ID | |
Created | date - ISO/UTC | The time this conversion was created | |
ConversionCodeID | long | The conversion code | |
ConversionRef | string | The value of the conversion reference optionally passed through in the conversion code for this conversion | |
ConversionAmount | double | The monetary value given to this conversion | |
InviteStatusType | byte | The invitation status of the visit when the conversion occurred. | |
ChatStatusType | byte | The chat status of the visit when the conversion occurred. 0 - None. 1 - Last page was the pre-chat form. 2 - Last page was the chat page. 3 - The pre-chat form was closed. 5 - Last page was the post-chat form. 6 - The post-chat form was submitted. 7 - The chat was unavailable. 8 - An unavailable email was sent. 10 - The chat was blocked. 11 - The chat was unavailable because of the ACD queue size. 12 - The chat was unavailable due to agent hours. 13 - The chat was blocked and an unavailable email was sent. 14 - The chat was unavailable because of the ACD queue size, and an unavailable email was sent. 15 - The chat was unavailable due to agent hours, and an unavailable email was sent | |
CallStatusType | byte | The call status of the visit when the conversion occurred | |
VisitCount | integer | The total number of visits to the site prior to conversion | |
PageViewCount | integer | The total number of page views on the active visit prior to conversion | |
VisitCreated | date - ISO/UTC | The time the visit on which the conversion occurred was created | |
ChatInvitationTemplateVariantID | long | The chat invitation credited with this conversion | |
CallInvitationTemplateVariantID | long | The call invitation credited with this conversion | |
FolderID | long | The folder this conversion is in | |
Keywords | ? | ||
VisitorID | long | The customer ID | |
Experiments | ? | ||
ExperimentDate | ? | ||
ConversionInfo | string | The value of the conversion info optionally passed through in the conversion code for this conversion | |
LastAssignedByOperatorID | long | The agent who assigned credit for this conversion to the operatorID associated with this conversion | |
OperatorStatusType | byte | The type of interaction the agent had with the customer. 0: Chat in Previous Visit. 1: Call in Previous Visit. 2: Chat in Current Visit. 3: Call in Current Visit | |
OperatorActionType | byte | How the customer initiated their interaction with the agent. 0: Button Click. 2: Agent Invited. 4: Auto Invited | |
RefererUrl | string | The referring location given credit for referring the customer to the site initially to make the conversion | |
EntryUrl | string | The initial landing page of the customer after being referred from the refererUrl location | |
RefererQuery | string | The search query, if recognized, given by the refererUrl used to refer the customer to the site | |
OperatorCount | integer | The total number of agents that could have been given credit for this conversion | |
OperatorActionTime | date - ISO/UTC | The time the agent assigned to this conversion interacted with the customer causing the conversion | |
PageViewID | ? | ||
Truncated |
boolean |
All |
Whether or not the above JSON array is the complete result set, or if the server limited the returned results. |
Next |
json object |
v1 |
If the method called supports it, and the data is truncated, the Next parameter will contain the necessary parameters to pass back to the same server method to get more results. |
Additional information
Maximum page size: 5000 records