MS:getLinkPerformanceOverview

From Wiki

Jump to: navigation, search

Get an overview of each linking platforms performance

Parameters


Element

Type

dStartDate required

Start date of a search

Value Type: dateTime
Example: 2013-01-01T00:00:00

dEndDate required

End date of a search

Value Type: dateTime
Example: 2013-01-31T23:59:59

sDateType required

Date range type

Value Type: DateType
Example: transaction


Response


getLinkPerformanceReturn

Array of PlatformPerformance objects

Value Type: PlatformPerformance


Example Request (parameters)


$aParams3 = array(
	'dStartDate'		=>	'2014-01-01T00:00:00', 
	'dEndDate'		=>	'2014-01-14T23:59:59', 
	'sDateType'		=>	'transaction'
);

$oResponse = $oClient->call('getLinkPerformanceOverview', $aParams3);


Example Response


stdClass Object
(
    [getLinkPerformanceOverviewReturn] => Array
        (
            [0] => stdClass Object
                (
                    [sPlatform] => ShopWindow Direct
                    [iImpressions] => 0
                    [iClicks] => 0
                    [fCtr] => 0
                    [iTransactions] => 0
                    [fTransactionValue] => 0
                    [fConversion] => 0
                    [fEpc] => 0
                )

            [1] => stdClass Object
                (
                    [sPlatform] => ShopWindow Client
                    [iImpressions] => 0
                    [iClicks] => 93
                    [fCtr] => 0
                    [iTransactions] => 0
                    [fTransactionValue] => 0
                    [fConversion] => 0
                    [fEpc] => 0
                )

            [2] => stdClass Object
                (
                    [sPlatform] => Products
                    [iImpressions] => 0
                    [iClicks] => 1172
                    [fCtr] => 0
                    [iTransactions] => 27
                    [fTransactionValue] => 8476.67
                    [fConversion] => 2.3
                    [fEpc] => 7.23
                )

            [3] => stdClass Object
                (
                    [sPlatform] => Content Widgets
                    [iImpressions] => 0
                    [iClicks] => 0
                    [fCtr] => 0
                    [iTransactions] => 0
                    [fTransactionValue] => 0
                    [fConversion] => 0
                    [fEpc] => 0
                )

            [4] => stdClass Object
                (
                    [sPlatform] => Banners
                    [iImpressions] => 1859664
                    [iClicks] => 12759
                    [fCtr] => 0.69
                    [iTransactions] => 0
                    [fTransactionValue] => 0
                    [fConversion] => 0
                    [fEpc] => 0
                )

            [5] => stdClass Object
                (
                    [sPlatform] => Text Links
                    [iImpressions] => 0
                    [iClicks] => 2118
                    [fCtr] => 0
                    [iTransactions] => 37
                    [fTransactionValue] => 11835.02
                    [fConversion] => 1.75
                    [fEpc] => 5.59
                )

        )

)

Limitations/Notes

  • The maximum date range is 30 days per API request

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button