Reporting Service
Description
The Reporting Service provides operations for retrieving performance statistics and lead content from ContactAtOnce!
Version 3 WSDL
Format: XML
Method: POST
URL (regionally defined. Note: The SOAP action between regions does not change and will always be at base url https://services.contactatonce.com/):
- North America : https://services.contactatonce.com/contactatoncereportingservice.asmx?wsdl
- Australia : https://services.contactatonce.com.au/contactatoncereportingservice.asmx?wsdl
- Europe : https://services.contactatonce.co.uk/contactatoncereportingservice.asmx?wsdl
Requests
GetStatisticsSummary
Retrieve Summary Statistics.
Retrieve summary performance statistics given specified filter criteria.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of ReportStat | Statistics retrieved for the specified filter criteria. The statistics are summarized for the specified filter criteria. |
GetPlacementStatisticsSummary
Retrieve Summary Statistics summarized by Advertiser and Placement.
Retrieve summary performance statistics given specified filter criteria. The statistics are summarized by AdvertiserId and PlacementId.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of ReportPlacementStat | Statistics retrieved for the specified filter criteria. The statistics are summarized for the specified filter criteria. |
GetCallDetail
Retrieve Advertiser Call Details.
Retrieve a list of tracked calls delivered meeting the filter criteria. Details of all observed calls are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
targetNumber | String | Optional | Filtering criteria enabling the specification of call details to be restricted to a single tracked telephone number. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of CallDetail | Call details retrieved for the specified filter criteria. A row in the array is returned for each observed call meeting the specified filter criteria. |
GetIMDetail
Retrieve Advertiser Chat/IM Session Details.
Retrieve a list of IM/Chat sessions meeting the filter criteria. Details of all observed IM/chat sessions are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of ImDetail | IM/Chat session details retrieved for the specified filter criteria. A row in the array is returned for each observed Im/Chat session meeting the specified filter criteria. |
GetIMDetailByVisitId
Retrieve Advertiser Chat/IM Session Details for single visit. Details of the observed IM/chat session are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | ImDetail | IM/Chat session details retrieved for the specified filter criteria. A single row is returned for the Im/Chat session meeting the specified filter criteria. |
GetLeadDetail
Retrieve Advertiser Lead Details.
Retrieve a list of leads delivered meeting the ReportFilterCriteria. Details of all supported lead types are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of LeadStat | Lead details retrieved for the specified filter criteria. A row in the array is returned for each observed lead meeting the specified filter criteria. |
GetImConversationTranscript
Retrieve Instant Messaging Conversation Transcript.
Returns the conversation context and text transcript of an Instant Messaging conversation.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | ImConversationTranscript | Context and individual messages that constitute the instant messaging conversation transcript. |
IsSummarizationComplete
Returns Data Summarization status for a specified date.
GetStatisticsSummary returns certain data (primarily presence information) that is summarized in periodic batch processes. IsSummarizationComplete allows processes that consume GetStatisticsSummary to ensure the currency of data for a requested period, prior to consuming the service.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
target | DateTime | Required | Date for which summarization status is requested. Format: yyyy-mm-dd |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Boolean |
|
GetMTCConversationTranscript
Retrieve Mobile Text Connect Conversation Transcript.
Returns the conversation context and text transcript of a specified Mobile Text Connect conversation.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | MTCConversationTranscript | Context and individual messages that constitute the instant messaging conversation transcript. |
GetMTCConversationDetail
Retrieve a list of Mobile Text Connect conversations meeting the filter criteria. Details of all observed MTC conversations are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of MTCDetail | Mobile Text Connect conversation details retrieved for the specified filter criteria. A row in the array is returned for each observed conversation meeting the specified filter criteria. |
GetMTCConversationDetailByVisitId
Retrieve a specific Mobile Text Connect conversations meeting the filter criteria. Details of all observed MTC conversation are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | MTCDetail | Mobile Text Connect conversation details retrieved for the specified filter criteria. A single object is returned for the conversation meeting the specified filter criteria. |
GetMessageConversationTranscript
Retrieve In App Message Conversation Transcript.
Returns the conversation context and text transcript of a specified In App Message conversation.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | AsynchronousConversationTranscript | Context and individual messages that constitute the In App Messaging conversation transcript. |
GetMessageConversationDetail
Retrieve a list of In App Message conversations meeting the filter criteria. Details of all observed In App Message conversations are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of MessageConversationDetail | In App Messaging conversation details retrieved for the specified filter criteria. A row in the array is returned for each observed conversation meeting the specified filter criteria. |
GetMessageConversationDetailByVisitId
Retrieve a specific In App Message conversations meeting the filter criteria. Details of all observed In App Message conversation are returned.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | MessageConversationDetail | In App Messaging conversation details retrieved for the specified filter criteria. A single row is returned for the conversation meeting the specified criteria. |
GetHourlyPresenceSummary
Get hourly impression data over a period of time. Returns total impressions and total present impressions for each hour of a specific time frame for a specific Advertiser.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Array of ImpressionHourlySummary | Impression data retrieved for the specified filter criteria. A row in the array is returned for hour meeting the specified filter criteria. |