NAME

WebService::Edgecast::auto::Reporting::Interface::EdgeCastWebServices::EdgeCastWebServicesSoap - SOAP Interface for the EdgeCastWebServices Web Service

VERSION

version 0.01.00

SYNOPSIS

 use WebService::Edgecast::auto::Reporting::Interface::EdgeCastWebServices::EdgeCastWebServicesSoap;
 my $interface = WebService::Edgecast::auto::Reporting::Interface::EdgeCastWebServices::EdgeCastWebServicesSoap->new();

 my $response;
 $response = $interface->CustomerBytesTransferredGet();
 $response = $interface->CustomerBytesTransferredByMediaTypeGet();
 $response = $interface->FileStatsGet();
 $response = $interface->DirStatsGet();
 $response = $interface->CompleteDownloadsGet();
 $response = $interface->CnameStatsGet();
 $response = $interface->CacheStatusStatsGet();
 $response = $interface->TrafficUsageGet();
 $response = $interface->StorageUsageGetMax();
 $response = $interface->StorageUsageGetLatest();

DESCRIPTION

SOAP Interface for the EdgeCastWebServices web service located at https://api.edgecast.com/v1/Reporting.asmx.

SERVICE EdgeCastWebServices

API for integrating with the EdgeCast CDN Reporting

Port EdgeCastWebServicesSoap

METHODS

General methods

new

Constructor.

All arguments are forwarded to SOAP::WSDL::Client.

SOAP Service methods

Method synopsis is displayed with hash refs as parameters.

The commented class names in the method's parameters denote that objects of the corresponding class can be passed instead of the marked hash ref.

You may pass any combination of objects, hash and list refs to these methods, as long as you meet the structure.

List items (i.e. multiple occurences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref - this may result in invalid XML if used improperly, though. Note that SOAP::WSDL always expects list references at maximum depth position.

XML attributes are not displayed in this synopsis and cannot be set using hash refs. See the respective class' documentation for additional information.

CustomerBytesTransferredGet

This method will get the data transferred (bytes) between begin and end dates for a customer. Begin and end dates are inclusive and data is granular to the 5-minute interval. Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::CustomerBytesTransferredGetResponse object.

 $response = $interface->CustomerBytesTransferredGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
  },,
 );

CustomerBytesTransferredByMediaTypeGet

This method will get the data transferred (bytes) between begin and end dates for a customer, for a specific media type. Begin and end dates are inclusive and data is granular to the 5-minute interval. Media Type: 1=Windows, 2=Flash, 3=HTTP Large Object (includes SSL traffic), 8=HTTP Small Object (includes SSL traffic), 14 = ADN (includes SSL traffic) . Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::CustomerBytesTransferredByMediaTypeGetResponse object.

 $response = $interface->CustomerBytesTransferredByMediaTypeGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
  },,
 );

FileStatsGet

FOR CUSTOMERS WITH ADVANCED REPORTS. This method will get data transferred (bytes), hits, daily uniques, and average duration information for the top 250 files. For HTTP, files included in this report are those greater than 1 MB. For streaming, all files are included. Begin and end dates (inclusive) must be in UTC/GMT and data is granular to the day. So if you want to retrieve data for 2009-01-01, begin date would be '2009-01-01T00:00:00-00:00' and end date would be '2009-01-01T23:59:00-00:00'. Media Type: 1=Windows, 2=Flash, 3=HTTP Large Object. Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::FileStatsGetResponse object.

 $response = $interface->FileStatsGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
  },,
 );

DirStatsGet

FOR CUSTOMERS WITH ADVANCED REPORTS. This method will get data transferred (bytes), hits, and average duration information for the top 250 directories. The data is for files, of the media type specified, that sit in the directory at the first level. For HTTP, files included in this report are those greater than 1 MB. For streaming, all files are included. Begin and end dates (inclusive) must be in UTC/GMT and data is granular to the day. So if you want to retrieve data for 2009-01-01, begin date would be '2009-01-01T00:00:00-00:00' and end date would be '2009-01-01T23:59:00-00:00'. Media Type: 1=Windows, 2=Flash, 3=HTTP Large Object. Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::DirStatsGetResponse object.

 $response = $interface->DirStatsGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
  },,
 );

CompleteDownloadsGet

FOR CUSTOMERS WITH ADVANCED REPORTS. This method will get complete downloads and download attempts for files. Files included in this report are those greater than 50 kb. Begin and end dates (inclusive) must be in UTC/GMT and data is granular to the day. So if you want to retrieve data for 2009-01-01, begin date would be '2009-01-01T00:00:00-00:00' and end date would be '2009-01-01T23:59:00-00:00'. Media Type: 3=HTTP Large Object. HTTP Small Object, Windows and Flash are not available at this time. Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves. NOTES: * In calculating whether a hit is a "complete download," we consider status 200 hits and take into account byte-range requests where multiple hits can be part of one download.We also verify whether or not the data transferred is equal to or greater than the filesize in order to count the hit as a "complete download." * This report is very interpretive by nature, and we have identified a few points that may alter the consistency and accuracy of this report. (1) Different user-agents exhibit different behaviors. Files may show greater than 100% because traffic pattern cannot be well-captured based on user-agent behavior. (2) Customer hits using FLV seek to jump around the contents of a file may not be represented correctly in this report. (3) The downloads data for compressed files may be inaccurate because the recorded filesize is larger than the total bytes transferred. This would apply to customers that have compression enabled.

Returns a WebService::Edgecast::auto::Reporting::Element::CompleteDownloadsGetResponse object.

 $response = $interface->CompleteDownloadsGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
  },,
 );

CnameStatsGet

This method will get bytes and hits by CNAME. Begin and end dates are inclusive and data is granular to the hour. So if you want to retrieve data for 2009-01-01, begin date would be '2009-01-01T00:00:00-00:00' and end date would be '2009-01-01T23:59:00-00:00'. Media Type: 3=HTTP Large Object, 8=HTTP Small Object Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::CnameStatsGetResponse object.

 $response = $interface->CnameStatsGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
  },,
 );

CacheStatusStatsGet

This method will get hits by Cache Status. Begin and end dates are inclusive and data is granular to the hour. So if you want to retrieve data for 2009-01-01, begin date would be '2009-01-01T00:00:00-00:00' and end date would be '2009-01-01T23:59:00-00:00'. Media Type: 3=HTTP Large Object, 8=HTTP Small Object Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::CacheStatusStatsGetResponse object.

 $response = $interface->CacheStatusStatsGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
  },,
 );

TrafficUsageGet

This method will get billing statistics for the month for a customer. Billing closes on the 3rd day of each month at midnight GMT time. BeginDate: Must be the first of a month. All billing stats are in UTC/GMT. MediaType: 1=WMS, 2=FMS, 3=HTTP Large, 4=HTTPS Large, 8=HTTP Small, 9=HTTPS Small, 14=ADN, 15=ADN SSL Region: 1=Global Standard, 2=North America & Europe, 3=Asia Pacific UsageUnits: 1=Mbps, 2=GB Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::TrafficUsageGetResponse object.

 $response = $interface->TrafficUsageGet( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    intMediaType =>  $some_value, # int
    intRegion =>  $some_value, # int
    intUsageUnits =>  $some_value, # int
  },,
 );

StorageUsageGetMax

This method will get the maximum storage usage for a customer during the time frame. Units are in GB. Usage samples are taken throughout the day, so the number reflected is the maximum out of the samples. Begin and end dates are inclusive. Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::StorageUsageGetMaxResponse object.

 $response = $interface->StorageUsageGetMax( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
    datBeginDate =>  $some_value, # dateTime
    datEndDate =>  $some_value, # dateTime
  },,
 );

StorageUsageGetLatest

This method will get the latest sampled storage usage for a customer. Units are in GB. Usage samples are taken throughout the day, so the number reflected is the latest sample. Partners may retrieve the information for any of their own customers. Customers may retrieve the information for themselves.

Returns a WebService::Edgecast::auto::Reporting::Element::StorageUsageGetLatestResponse object.

 $response = $interface->StorageUsageGetLatest( {
    strCredential =>  $some_value, # string
    strCustomerId =>  $some_value, # string
  },,
 );

AUTHOR

Generated by SOAP::WSDL on Wed Dec 22 13:08:26 2010

To install WebService::Edgecast, copy and paste the appropriate command in to your terminal.

cpanm

cpanm WebService::Edgecast

CPAN shell

perl -MCPAN -e shell
install WebService::Edgecast

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)