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/):


Requests


    GetStatisticsSummary

    Retrieve Summary Statistics.
    Retrieve summary performance statistics given specified filter criteria.

    Request   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of ReportStatStatistics 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of ReportPlacementStatStatistics 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.
    targetNumberStringOptionalFiltering criteria enabling the specification of call details to be restricted to a single tracked telephone number.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of CallDetailCall 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of ImDetailIM/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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique identifier of the IM conversation. See VisitId

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyImDetailIM/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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of LeadStatLead 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique identifier of the IM conversation. See VisitId

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyImConversationTranscriptContext 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    targetDateTimeRequiredDate for which summarization status is requested. Format: yyyy-mm-dd

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyBoolean
    • True - Data summarization has been completed for the requested Target date.
    • False- Data summarization has not yet completed for the requested Target date.
    GetMTCConversationTranscript

    Retrieve Mobile Text Connect Conversation Transcript.
    Returns the conversation context and text transcript of a specified Mobile Text Connect conversation.

    Request   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique identifier of the IM conversation. See VisitId

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyMTCConversationTranscriptContext 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of MTCDetailMobile 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique identifier of the IM conversation. See VisitId

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyMTCDetailMobile 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique identifier of the IM conversation. See VisitId

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyAsynchronousConversationTranscriptContext 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of MessageConversationDetailIn 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique identifier of the IM conversation. See VisitId

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyMessageConversationDetailIn 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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    filterReportFilterCriteriaRequiredFiltering criteria enabling the specification of Statistics to be returned.

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header.
    BodyArray of ImpressionHourlySummaryImpression data retrieved for the specified filter criteria. A row in the array is returned for hour meeting the specified filter criteria.