 | ÉDITEUR | ANNONCEUR | AGENCES | PROGRAMME D’AFFILIATION | APPS & API | PRESSE | A PROPOS |
API-Documentation - Publisher Statistics Web Services
1 Content
| 1 | Content |
| 2 | Introduction |
| 3 | Generating a Web Service-Password |
| 4 | Publisher Statistics Web Services |
| 4.1 | Result-Object |
| 4.2 | Functions |
| 4.2.1 | getStatisticsDaily() |
| 4.2.2 | getStatisticsMonthly() |
| 4.2.3 | getStatisticsByProgram() |
| 4.2.4 | getStatisticsByAdPlatform() |
| 4.2.5 | getStatisticsByAdMedia() |
2 Introduction
The belboon Web Services (SOAP-Protokoll) enables you to work with our network automatically without you having to login through the interface.
Web Service URL: http://api.belboon.com/?wsdl
3 Generating a Web Service-Password
To use the belboon Web Services you need not login to your belboon account.
In the Menu "Tools & Services > Web Services" you have the opportunity to generate your Web Service password. Afterwards you will be able to see this in this section. The username for the use of the Web Services is exactly the same as the username from your Affiliate account.
4 Publisher Statistics Web Services
4.1 Result-Object
When calling a function of the Web Services, the data will be returned through a single result object. This object contains some metadata, for example: an error message as well as the actual user data.
Result Object
| Index | Type | Description |
|---|---|---|
|
processor |
Object |
s.u. |
|
handler |
Object |
s.u. |
processor
Behind the property lies a processor object, which stores information about the executed transaction.
| Index | Type | Description |
|---|---|---|
|
code |
Integer |
Transactions code |
|
message |
String |
Message according to the transaction codes |
|
rid |
Integer |
SOAP Requests ID |
|
testmode |
Integer |
Provides information on whether the transaction was carried out in test mode. |
handler
The property handler contains a single property whose name, type and content results on the call up of the web services. This information must in any case be checked again in Section 4.2. The contents of this property are the actual user data.
4.2 Functions
4.2.1 getStatisticsDaily()
Delivers back the daily statistics from the actual month
Request Parameter
| Name | Type | Default | Description |
|---|---|---|---|
|
currency |
String |
EUR |
|
|
adPlatformId |
Integer |
|
|
|
groupByProgram |
Boolean |
false |
|
|
groupByAdPlatform |
Boolean |
false |
|
|
groupByEventStatus |
Boolean |
false |
|
|
groupByAdMedia |
Boolean |
false |
|
|
groupBySubId |
Boolean |
false |
|
|
orderBy |
String[] |
array('eventdate' => 'DESC') |
Sorts the return according to the passed column name with the desired orientation (ASC = ascending, DESC = descending) |
|
limit |
Integer |
null |
Limits the number of results to this max value |
|
offset |
Integer |
0 |
Lists results from this value |
Response
Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the statistics. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:
| Index | Type | Description |
|---|---|---|
|
eventdate |
Date (YYYY-MM-DD) |
Event Date |
|
programid* |
Integer |
ID of the affected Partner Program |
|
programname* |
String |
Name of the affected Partner Program |
|
adplatformid* |
Integer |
ID of the affected Advertising Material |
|
adplatformname* |
String |
Name of the affected Advertising Material |
|
eventstatus* |
String {ACCEPTED, PENDING, REJECTED} |
Events Status |
|
subid* |
String |
Sub Website ID |
|
admediaid* |
Integer |
ID of the affected Advertising Material |
|
admedianame* |
String |
Name of the affected Advertising Material |
|
eventcurrency |
String |
Currency |
|
clicks |
Integer |
Number of clicks |
|
clickcommission |
Float |
Click Commission (in selected currency) |
|
views |
Integer |
Number of Views |
|
viewscommission |
Float |
Commission through Views |
|
leads |
Integer |
Number of Leads |
|
leadcommission |
Float |
Commission generated through Leads |
|
sales |
Integer |
Number of Sales |
|
salecommission |
Float |
Sales Commission |
|
totalcommission |
Float |
Total Commission |
|
clickthroughrate |
Float |
Click-Through-Rate (CTR) |
|
leadconversionrate |
Float |
Conversion rate (CR) Leads |
|
saleconversionrate |
Float |
Conversion rate (CR) Sales |
The fields marked with * are only included in the output if the function call (request) a corresponding grouping was made. Thus, for example, the issue requires programid and programname for a group groupByProgram program using request parameter. This should also be taken into account when sorting. The fields clicks, clickcommission, views, viewcommission as well as clickthroughrate, leadconversionrate and saleconversionrate can also return NULL values.
Example:
|
<?php
define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');
// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true );
try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getStatisticsDaily( 'EUR', // currency null, // adPlatformId false, // groupByProgram false, // groupByAdPlatform true, // groupByEventStatus false, // groupByAdMedia false, // groupBySubId array('eventdate' => 'DESC') // orderBy );
echo '<pre>'; print_r($result);
} catch( Exception $e ) { // Error handling here... } |
4.2.2 getStatisticsMonthly()
Returns the Months Statistics from the selected time frame.
Request Parameter
| Name | Type | Default | Description |
|---|---|---|---|
|
startMonth |
Date (YYYY-MM) |
|
|
|
endMonth |
Date (YYYY-MM) |
|
|
|
currency |
String |
EUR |
|
|
adPlatformId |
Integer |
|
|
|
groupByProgram |
Boolean |
false |
|
|
groupByAdPlatform |
Boolean |
false |
|
|
groupByEventStatus |
Boolean |
false |
|
|
groupByAdMedia |
Boolean |
false |
|
|
groupBySubId |
Boolean |
false |
|
|
orderBy |
String[] |
array('eventdate' => 'DESC') |
Sorts the return according to the passed column name with the desired orientation (ASC = ascending, DESC = descending) |
|
limit |
Integer |
null |
Limits the number of results to this max value |
|
offset |
Integer |
0 |
Lists results from this value |
Response
Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the statistics. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:
| Index | Type | Description |
|---|---|---|
|
eventdate |
Date (YYYY-MM-DD) |
Event Date |
|
programid* |
Integer |
ID of the affected Partner Program |
|
programname* |
String |
Name of the affected Partner Program |
|
adplatformid* |
Integer |
ID of the affected Advertising Material |
|
adplatformname* |
String |
Name of the affected Advertising Material |
|
eventstatus* |
String {ACCEPTED, PENDING, REJECTED} |
Events Status |
|
subid* |
String |
Sub Website ID |
|
admediaid* |
Integer |
ID of the affected Advertising Material |
|
admedianame* |
String |
Name of the affected Advertising Material |
|
eventcurrency |
String |
Currency |
|
clicks |
Integer |
Number of clicks |
|
clickcommission |
Float |
Click Commission (in selected currency) |
|
views |
Integer |
Number of Views |
|
viewscommission |
Float |
Commission through Views |
|
leads |
Integer |
Number of Leads |
|
leadcommission |
Float |
Commission generated through Leads |
|
sales |
Integer |
Number of Sales |
|
salecommission |
Float |
Sales Commission |
|
totalcommission |
Float |
Total Commission |
|
clickthroughrate |
Float |
Click-Through-Rate (CTR) |
|
leadconversionrate |
Float |
Conversion rate (CR) Leads |
|
saleconversionrate |
Float |
Conversion rate (CR) Sales |
The fields marked with * are only included in the output if the function call (request) a corresponding grouping was made. Thus, for example, the issue requires programid and programname for a group groupByProgram program using request parameter. This should also be taken into account when sorting. The fields clicks, clickcommission, views, viewcommission as well as clickthroughrate, leadconversionrate and saleconversionrate can also return NULL values.
Example:
|
<?php
define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');
// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true );
try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getStatisticsMonthly( '2010-01', // startMonth date('Y-m'), // endMonth null, // currency true, // adPlatformId false, // groupByProgram true, // groupByAdPlatform false, // groupByEventStatus false, // groupByAdMedia false, // groupBySubId array('eventdate' => 'DESC', 'adplatformname' => 'ASC'), // orderBy 25 // limit );
echo '<pre>'; print_r($result);
} catch( Exception $e ) { // Error handling here... } |
4.2.3 getStatisticsByProgram()
Delivers the statistics of the selected time frame, grouped by partner program
Request Parameter
| Name | Type | Default | Description |
|---|---|---|---|
|
startDate |
Date (YYYY-MM-DD) |
First day of the actual month |
|
|
endDate |
Date (YYYY-MM-DD) |
Todays date |
|
|
programId |
Integer |
|
|
|
currency |
String |
EUR |
|
|
groupByMonth |
Boolean |
true |
|
|
groupByAdPlatform |
Boolean |
false |
|
|
groupByEventStatus |
Boolean |
false |
|
|
groupByAdMedia |
Boolean |
false |
|
|
groupBySubId |
Boolean |
false |
|
|
orderBy |
String[] |
array('eventdate' => 'DESC') |
Sorts the return according to the passed column name with the desired orientation (ASC = ascending, DESC = descending) |
|
limit |
Integer |
null |
Limits the number of results to this max value |
|
offset |
Integer |
0 |
Lists results from this value |
Response
Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the statistics. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:
| Index | Type | Description |
|---|---|---|
|
eventdate |
Date (YYYY-MM-DD) |
Event Date |
|
programid* |
Integer |
ID of the affected Partner Program |
|
programname* |
String |
Name of the affected Partner Program |
|
adplatformid* |
Integer |
ID of the affected Advertising Material |
|
adplatformname* |
String |
Name of the affected Advertising Material |
|
eventstatus* |
String {ACCEPTED, PENDING, REJECTED} |
Events Status |
|
subid* |
String |
Sub Website ID |
|
admediaid* |
Integer |
ID of the affected Advertising Material |
|
admedianame* |
String |
Name of the affected Advertising Material |
|
eventcurrency |
String |
Currency |
|
clicks |
Integer |
Number of clicks |
|
clickcommission |
Float |
Click Commission (in selected currency) |
|
views |
Integer |
Number of Views |
|
viewscommission |
Float |
Commission through Views |
|
leads |
Integer |
Number of Leads |
|
leadcommission |
Float |
Commission generated through Leads |
|
sales |
Integer |
Number of Sales |
|
salecommission |
Float |
Sales Commission |
|
totalcommission |
Float |
Total Commission |
|
clickthroughrate |
Float |
Click-Through-Rate (CTR) |
|
leadconversionrate |
Float |
Conversion rate (CR) Leads |
|
saleconversionrate |
Float |
Conversion rate (CR) Sales |
The fields marked with * are only included in the output if the function call (request) a corresponding grouping was made. Thus, for example, the issue requires programid and programname for a group groupByProgram program using request parameter. This should also be taken into account when sorting. The fields clicks, clickcommission, views, viewcommission as well as clickthroughrate, leadconversionrate and saleconversionrate can also return NULL values.
Example:
|
<?php
define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');
// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true );
try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getStatisticsByProgram( '2010-09-01', // startDate null, // endDate <YOUR_PROGRAM_ID>, // programId null, // currency false, // groupByMonth null, // groupByAdPlatform null, // groupByEventStatus null, // groupByAdMedia null, // groupBySubId array('programname' => 'ASC') // orderBy );
echo '<pre>'; print_r($result);
} catch( Exception $e ) { // Error handling here... } |
4.2.4 getStatisticsByAdPlatform()
Delivers statistics from the selected time frame, grouped by ad platform.
Request-Parameter
| Name | Type | Default | Description |
|---|---|---|---|
|
startDate |
Date (YYYY-MM-DD) |
First day of the actual month |
|
|
endDate |
Date (YYYY-MM-DD) |
Todays date |
|
|
programId |
Integer |
|
|
|
currency |
String |
EUR |
|
|
groupByMonth |
Boolean |
true |
|
|
groupByAdPlatform |
Boolean |
false |
|
|
groupByEventStatus |
Boolean |
false |
|
|
groupByAdMedia |
Boolean |
false |
|
|
groupBySubId |
Boolean |
false |
|
|
orderBy |
String[] |
array('eventdate' => 'DESC') |
Sorts the return according to the passed column name with the desired orientation (ASC = ascending, DESC = descending) |
|
limit |
Integer |
null |
Limits the number of results to this max value |
|
offset |
Integer |
0 |
Lists results from this value |
Response
Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the statistics. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:
| Index | Type | Description |
|---|---|---|
|
eventdate |
Date (YYYY-MM-DD) |
Event Date |
|
programid* |
Integer |
ID of the affected Partner Program |
|
programname* |
String |
Name of the affected Partner Program |
|
adplatformid* |
Integer |
ID of the affected Advertising Material |
|
adplatformname* |
String |
Name of the affected Advertising Material |
|
eventstatus* |
String {ACCEPTED, PENDING, REJECTED} |
Events Status |
|
subid* |
String |
Sub Website ID |
|
admediaid* |
Integer |
ID of the affected Advertising Material |
|
admedianame* |
String |
Name of the affected Advertising Material |
|
eventcurrency |
String |
Currency |
|
clicks |
Integer |
Number of clicks |
|
clickcommission |
Float |
Click Commission (in selected currency) |
|
views |
Integer |
Number of Views |
|
viewscommission |
Float |
Commission through Views |
|
leads |
Integer |
Number of Leads |
|
leadcommission |
Float |
Commission generated through Leads |
|
sales |
Integer |
Number of Sales |
|
salecommission |
Float |
Sales Commission |
|
totalcommission |
Float |
Total Commission |
|
clickthroughrate |
Float |
Click-Through-Rate (CTR) |
|
leadconversionrate |
Float |
Conversion rate (CR) Leads |
|
saleconversionrate |
Float |
Conversion rate (CR) Sales |
The fields marked with * are only included in the output if the function call (request) a corresponding grouping was made. Thus, for example, the issue requires programid and programname for a group groupByProgram program using request parameter. This should also be taken into account when sorting. The fields clicks, clickcommission, views, viewcommission as well as clickthroughrate, leadconversionrate and saleconversionrate can also return NULL values.
Example:
|
<?php
define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');
// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true );
try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getStatisticsByAdPlatform( '2010-09-01', // startDate null, // endDate <YOUR_AD_PLATFORM_ID>, // adPlatformId null, // currency null, // groupByMonth null, // groupByProgram null, // groupByEventStatus true, // groupByAdMedia null, // groupBySubId array('eventdate' => 'DESC', 'admedianame' => 'ASC'), // orderBy 25 // limit );
echo '<pre>'; print_r($result);
} catch( Exception $e ) { // Error handling here... } |
4.2.5 getStatisticsByAdMedia()
Delivers statistics from the selected time frame, grouped by advertising material.
Request-Parameter
| Name | Type | Default | Description |
|---|---|---|---|
|
startDate |
Date (YYYY-MM-DD) |
First day of the actual month |
|
|
endDate |
Date (YYYY-MM-DD) |
Todays date |
|
|
programId |
Integer |
|
|
|
currency |
String |
EUR |
|
|
groupByMonth |
Boolean |
true |
|
|
groupByAdPlatform |
Boolean |
false |
|
|
groupByEventStatus |
Boolean |
false |
|
|
groupByAdMedia |
Boolean |
false |
|
|
groupBySubId |
Boolean |
false |
|
|
orderBy |
String[] |
array('eventdate' => 'DESC') |
Sorts the return according to the passed column name with the desired orientation (ASC = ascending, DESC = descending) |
|
limit |
Integer |
null |
Limits the number of results to this max value |
|
offset |
Integer |
0 |
Lists results from this value |
Response
Behind the property handler lies the Result-object, an object, with a single publicly visible property that bears the name of the statistics. It contains a numerically indexed array of 0 or more rows (arrays), each of which is structured as follows:
| Index | Type | Description |
|---|---|---|
|
eventdate |
Date (YYYY-MM-DD) |
Event Date |
|
programid* |
Integer |
ID of the affected Partner Program |
|
programname* |
String |
Name of the affected Partner Program |
|
adplatformid* |
Integer |
ID of the affected Advertising Material |
|
adplatformname* |
String |
Name of the affected Advertising Material |
|
eventstatus* |
String {ACCEPTED, PENDING, REJECTED} |
Events Status |
|
subid* |
String |
Sub Website ID |
|
admediaid* |
Integer |
ID of the affected Advertising Material |
|
admedianame* |
String |
Name of the affected Advertising Material |
|
eventcurrency |
String |
Currency |
|
clicks |
Integer |
Number of clicks |
|
clickcommission |
Float |
Click Commission (in selected currency) |
|
views |
Integer |
Number of Views |
|
viewscommission |
Float |
Commission through Views |
|
leads |
Integer |
Number of Leads |
|
leadcommission |
Float |
Commission generated through Leads |
|
sales |
Integer |
Number of Sales |
|
salecommission |
Float |
Sales Commission |
|
totalcommission |
Float |
Total Commission |
|
clickthroughrate |
Float |
Click-Through-Rate (CTR) |
|
leadconversionrate |
Float |
Conversion rate (CR) Leads |
|
saleconversionrate |
Float |
Conversion rate (CR) Sales |
The fields marked with * are only included in the output if the function call (request) a corresponding grouping was made. Thus, for example, the issue requires programid and programname for a group groupByProgram program using request parameter. This should also be taken into account when sorting. The fields clicks, clickcommission, views, viewcommission as well as clickthroughrate, leadconversionrate and saleconversionrate can also return NULL values.
Example:
|
<?php
define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');
// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php) $config = array( 'login' => 'YOUR_LOGIN_NAME', 'password' => 'YOUR_WEBSERVICE_PASSWORD', 'trace' => true );
try { $client = new SoapClient(WSDL_SERVER, $config); $result = $client->getStatisticsByAdMedia( '2010-07-15', // startDate date('Y-m-d'), // endDate <YOUR_AD_MEDIA_ID>, // adMediaId false, // groupByMonth false, // groupByProgram true, // groupByAdPlatform null, // groupByEventStatus null, // groupBySubId array('adplatformname' => 'ASC'), // orderBy 25, // limit 25 // offset );
echo '<pre>'; print_r($result);
} catch( Exception $e ) { // Error handling here... } |
Piéces Jointes:
FR_Affilies_Manuel_Webservices_Statistiques_V1_0 - (Size 505kb)
S’inscrire maintenant!
Rejoignez une équipe qui gagne!
Éditeurs: Inscription
Téléphone: 0049 (0)30-72 61 62 320
Fax: 0049 (0)30-72 61 62 311
Email: info@belboon.fr
Annonceurs: plus
belboon-adbutler GmbH
Karl-Liebknecht-Str. 1
10178 Berlin
Allemagne
Téléphone: 0049-(0)30 72 61 62-320
Fax: 0049-(0)30 72 61 62-311
Email: info@belboon.fr
Registre du Commerce:
AG Berlin (Charlottenburg), HRB 125210
No TVA: DE220719614
Directeur Général (CEO): Manuel Kester
DR. JAN WORATSCHEK
Head of Operations
bigmouthmedia GmbH
"bigmouthmedia utilise la régie belboon, en particulier pour sa technologie innovante et de pointe, qui permet de réaliser un tracking sûr et exact. De plus belboon couvre diverses industries.[...]"
A YOC Group Company
