CapacityReport WSDL
This service is stateful.
clearObjectDatatop
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
doComplexCalltop
Description
Execute a complex call.
For further information read the API-User documentation.
string doComplexCall(string $xmlstr)
Parameters
| string | $xmlstr | XML of Complex Statements |
Return Values
| string | The output produced by the statements |
generatetop
Description
Generates a report based on the given report definition.
int generate(CapacityReport $capacity_reporting)
Parameters
| CapacityReport | $capacity_reporting | The report definition to generate |
Return Values
| int | Created report |
getAsZippedCsvtop
Description
Gets a report as csv, packed into a zip archive, base64 encoded
string getAsZippedCsv()
Return Values
| string | base64 encoded binary data of a report zip file |
getLastValidationErrorstop
Description
Gets the last validation errors
string getLastValidationErrors()
Return Values
| string |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Description
Returns the current network id. Alias for getNetwork()
int getNetworkId()
Return Values
| int | Network ID |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getWaitTimetop
Description
Checks if the report is ready
Returns the time to wait in milliseconds
return value = 0 - report is ready
return value > 0 - Wait the returned number of milliseconds before polling again
int getWaitTime()
Return Values
| int | time to wait in milliseconds |
logintop
Description
Initializes a new session with given information
boolean login(string $user, string $pass, int $network)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
Return Values
| boolean | true on success, false on fail |
loginSmartPhonetop
Deprecated 2014-12-22
This method will be removed in upcoming releases.
Was only useful for the mobile app, which is not supported anymore.
Description
Login method
boolean loginSmartPhone(string $user, string $pass, int $network, string $client)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
| string | $client | Client token e.g. "apn" token of iPhone |
Return Values
| boolean | TRUE on success, FALSE on fail |
logouttop
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
BrowserFiltertop
Definition
- - Array <int> $browsers
-
required
CapacityReporttop
Definition
- - string $startdate
-
required
- - string $enddate
-
required
- - ContentunitFilter $contentunit_filter
-
optional
- - BrowserFilter $browser_filter
-
optional
- - CappingFilter $capping_filter
-
optional
- - GeoCityFilter $geo_city_filter
-
optional
- - GeoCountryFilter $geo_country_filter
-
optional
- - GeoStateFilter $geo_state_filter
-
optional
- - OperatingSystemFilter $operating_system_filter
-
optional
- - ProfileFilter $profile_filter
-
optional
- - ResolutionFilter $resolution_filter
-
optional
- - ChannelFilter $channel_filter
-
optional
CappingFiltertop
Definition
- - int $requests
-
required
- - int $time
-
required
ChannelFiltertop
Definition
- - Array <int> $channels
-
required
ContentunitFiltertop
Definition
- - Array <int> $contentunits
-
required
GeoCityFiltertop
Definition
- - Array <int> $cities
-
required
GeoCountryFiltertop
Definition
- - Array <int> $countries
-
required
GeoStateFiltertop
Definition
- - Array <int> $states
-
required
OperatingSystemFiltertop
ProfileFiltertop
Definition
- - string $profile
-
required
ResolutionFiltertop
Definition
- - Array <int> $resolutions
-
required