An Inx_Api_DataAccess_ClickData object can be used to retrieve information about a specific click accessible through an Inx_Api_DataAccess_ClickDataRowSet.
An Inx_Api_DataAccess_ClickData object can be used to retrieve information about a specific click accessible through an Inx_Api_DataAccess_ClickDataRowSet. A row set can be obtained using various filters:
The following example returns a result set containing click data for the specified mailing and fetches the email address of the recipients:
$oDataAccess = $oSession->getDataAccess(); $oClickData = $oDataAccess->getClickData(); $oRecipientContext = $oSession->createRecipientContext(); $oEmail = $oRecipientContext->getMetaData()->getEmailAttribute(); ... $oClickDataRowSet = $oClickData->selectByMailing( $iMailingId, $oRecipientContext, array($oEmail) );API version 1.11.1 allows you to filter by the type of the clicked link and to retrieve all clicks filtered only by date. Offering all possible combinations would have made figuring out which method is the right one a tedious job. Therefore, these filter types are only available using the new fluent style query API. The query API also allows to specify arrays of IDs. The following snippet demonstrates how to filter the clicks by two mailings, two link types and a start date:
$oDataAccess = $oSession->getDataAccess(); $oClickData = $oDataAccess->getClickData(); $oRecipientContext = $oSession->createRecipientContext(); $oEmail = $oRecipientContext->getMetaData()->getEmailAttribute(); $aMailingIds = array( 1234, 4711 ); $aLinkTypes = array( Inx_Api_DataAccess_LinkDataRowSet::LINK_TYPE_UNIQUE_COUNT, Inx_Api_DataAccess_LinkDataRowSet::LINK_TYPE_OPENING_COUNT ); $sOneDayAgo = date( 'c', strtotime( '-1 day' ) ); ... $oClickDataQuery = $oClickData->createQuery( $oRecipientContext, array( $oEmail ) ); $oClickDataRowSet = $oClickDataQuery->mailings( $aMailingIds )->linkTypes( $aLinkTypes )->after( $sOneDayAgo )->executeQuery();For more information on the data available for clicks, see the Inx_Api_DataAccess_ClickDataRowSet documentation.
Located in /Api/DataAccess/ClickData.php (line 67)
Creates a query object which allows to retrieve clicks using a fluent interface. the clicks by the following criteria:
Creates a query object which allows to retrieve clicks using a fluent interface. Using this object you can filter the clicks by the following criteria:
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred after the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred before the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred between the specified dates.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred after the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred before the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred between the specified dates.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred after the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred after the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred before the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred between the specified dates.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred before the specified date.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred between the specified dates.
This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.
Documentation generated on Thu, 17 Sep 2015 14:27:22 +0200 by phpDocumentor 1.3.2