GetSubIdStatistics

This method is used to generate a detailed SubID statistics for a specified publisher.

To access live data, please use this WSDL file:
https://api.affili.net/V2.0/PublisherStatistics.svc?wsdl
To access demo data, please use this WSDL file:
https://developer-api.affili.net/V2.0/PublisherStatistics.svc?wsdl

Web service description

Test data document

Operation test

With this form, you can try out this web service. We already filled it out with a sample request which will return data. Feel free to fill in different parameter values - our test data reference gives you an overview of our sample data.

Field

Type

Values

PublisherId *

int

StartDate

datetime

Open the calendar popup.

EndDate

datetime

Open the calendar popup.

ProgramIds

int array

ProgramTypes *

enum

SubId

string

TransactionStatus *

enum

ValuationType

enum

MaximumRecords *

int

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
StartDate (datetime):: This parameter defines the start date for which the statistics ought to be generated. It is included in the evaluation.
EndDate (datetime):: This parameter defines the end date for which the statistics ought to be generated. It is included in the evaluation.
SubId (string):: This parameter specifies the SubId for which the statistics ought to be generated. Possible values are: “”: if no value is assigned, the SubId parameter is ignored, SubId: records in which the SubId is exactly the assigned value are returned, %SubId%: records which contain the assigned value in its SubId are returned, %SubId: records in which the SubId ends with the assigned value are returned, SubId%: records in which the SubId begins with the assigned value are returned.
ValuationType (enum):: This parameter defines the event on which the valuation should be based on. Possible values are: DateOfRegistration, DateOfConfirmation
ProgramIds(array of int):: This parameter defines the program Ids for which the daily statistcs ought to be generated.
ProgramTypes (enum):: This parameter defines the commission type of the requested statistics. Possible values are: None, PayPerClick, PayPerSaleLead, CombinedProgram
TransactionStatus (enum):: Depicts the status of the sale or lead. Possible values are: Open, Confirmed, Cancelled, All
MaximumRecords (int):: The maximum amount of results you want to receive.

Complete code examples

<?php

/* <LIVE DATA>
define ("WSDL_LOGON", "https://api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_STATS",  "https://api.affili.net/V2.0/PublisherStatistics.svc?wsdl");

$Username   = ''; // the publisher ID
$Password   = ''; // the publisher web services password

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
             'Username'  => $Username,
             'Password'  => $Password,
             'WebServiceType' => 'Publisher'
             ));
</LIVE DATA> */

/* <DEMO DATA> */
define ("WSDL_LOGON", "https://developer-api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_STATS",  "https://developer-api.affili.net/V2.0/PublisherStatistics.svc?wsdl");

$Username   = '';     // your developer ID
$Password   = '';     // your developer portal password
$DemoPublisherId   = 403233;  // one of the publisher IDs of our demo database
$DeveloperSettings = array('SandboxPublisherID' => $DemoPublisherId);

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
                     'Username'  => $Username,
                     'Password'  => $Password,
                     'WebServiceType' => 'Publisher',
                     'DeveloperSettings' => $DeveloperSettings
                     ));
/* </DEMO DATA> */

$StartDate  = strtotime("-4 weeks");
$EndDate    = strtotime("-2 weeks");
$ProgramIds = array('0');

$params = array(
          'StartDate' => $StartDate,
          'EndDate' => $EndDate,
          'ProgramIds' => $ProgramIds,
          'ProgramTypes' => 'All',
          'SubId' => '',
          'MaximumRecords' => '100',
          'TransactionStatus' => 'All',
          'ValuationType' => 'DateOfRegistration'
          );

$SOAP_REQUEST = new SoapClient(WSDL_STATS);
$req = $SOAP_REQUEST->GetSubIdStatistics(array(
            'CredentialToken' => $Token,
            'GetSubIdStatisticsRequestMessage' => $params
            ));

print_r($req);

?>

protected void LoadWebService()
{            
    // first create the Web References
    // LIVE DATA
    // using Affilinet.LogonWebservice; ("https://api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.PublisherStatisticsWebservice; ("https://api.affili.net/V2.0/PublisherStatistics.svc?wsdl")    

    // or DEMO DATA
    // using Affilinet.LogonWebservice; ("https://developer-api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.PublisherStatisticsWebservice; ("https://developer-api.affili.net/V2.0/PublisherStatistics.svc?wsdl")


    #region Parameters for the authentification token
    // Insert the publisher ID for access the live data or insert your DeveloperId for access the demo data 
    string Username   = "";
    // Insert the publisher web services password for access the live data or insert your developer portal password for access the demo data 
    string Password   = "";
    // only required for access the demo data. Insert one of the publisher IDs of our demo database. e.g.: 403233
    int SandboxPublisherID = 0;
    #endregion

    string myToken = GetAuthentificationToken(Username, Password, SandboxPublisherID, WebServiceTypes.Publisher);
    
    // insert the parameters to get the result    
    DateTime startDate = DateTime.Now.AddMonths(-2);
    DateTime endDate = DateTime.Now;
    int[] programIds = { 2897 };
    string subId = "";
    SubIdStatisticsRecords myResult = GetSubIdStatistics(myToken, startDate, endDate, 999, programIds, ProgramTypes.All, subId, TransactionStatus.All, ValuationType.DateOfRegistration);
}

public static string GetAuthentificationToken(string username, string password, int sandboxPublisherID, WebServiceTypes WSType)
{
    Logon logonRequest = new Logon();
    logonRequest.Username = username;
    logonRequest.Password = password;
    logonRequest.WebServiceType = WSType;
    
    // *** only required for sandbox requests *** 
    // logonRequest.DeveloperSettings = new TokenDeveloperDetails();
    // logonRequest.DeveloperSettings.SandboxPublisherID = sandboxPublisherID;
    // logonRequest.DeveloperSettings.SandboxPublisherIDSpecified = true;             

    Authentication logonService = new Authentication();
    return logonService.Logon(logonRequest);
}
	
public static SubIdStatisticsRecords GetSubIdStatistics(string token, DateTime startdate, DateTime enddate, int maximumrecords, int[] programids, ProgramTypes programtypes, string subid, TransactionStatus transactionstatus,ValuationType valuationtype)
        {
           PublisherStatistics pubstatistic = new PublisherStatistics();
           GetSubIdStatisticsRequestMessage gsisreqmess = new GetSubIdStatisticsRequestMessage();
            gsisreqmess.StartDate = startdate;
            gsisreqmess.EndDate = enddate;
            gsisreqmess.MaximumRecords = maximumrecords;
            gsisreqmess.ProgramIds = programids;
            gsisreqmess.ProgramTypes = programtypes;
            gsisreqmess.SubId = subid;
            gsisreqmess.TransactionStatus = transactionstatus;
            gsisreqmess.ValuationType = valuationtype;
            return pubstatistic.GetSubIDStatistics(token, gsisreqmess);           
        }

GetSubIdStatistics

GetSubIdStatistics

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

PHP

.NET