OpenDataFeed request message details

The OpenDataFeed web service method initializes a data feed session based on a number of user-defined criteria. A data feed session always exports a homogeneous data set based on the MonitorClassDesignator and DataDesignator specified when the session is initialized.

Request parameters

Use an OpenDataFeed request to open a session:

 http://gpn.webservice.gomez.com/DataExportService60/GPNDataExportService.asmx?op=OpenDataFeed

Use the following request parameters:

  • sUsername – The account username

  • sPassword – The account password

  • iMonitorSetId – Requested set of the Synthetic Classic Portal Monitor/Test reference Identifiers. This set will be cross-referenced with the MonitorClassDesignator and only the requested monitors meeting the specified class criteria will be returned.

  • iSiteIdSet – Requested set of the Synthetic Classic Portal site reference identifiers—Empty set denotes all sites.

  • sMonitorClassDesignator – Specifies the type of data to be exported in the data set based on the common class of tests. Supported values are as follows:

  • sDataDesignator – Specifies the levels of data in the data set returned to the client for the type of data specified with the sMonitorClassDesignator parameter. Supported values are as follows:

  • sStartTime – Specifies the starting time boundary for the data set in the format YYYY-MM-DD HH:MM:SS.

  • sEndTime – Specifies the ending time boundary for the dataset in the format YYYY-MM-DD HH:MM:SS.

  • sOrderDesignator – Specifies how the data set will be ordered. Supported values are as follows:

Note

Use the Account Management API to retrieve the Synthetic Classic Portal monitor and site identifiers available to your account (for iMonitorIDSet and iSiteIdSet).

Supported combinations

Together, the sDataDesignator and sMonitorClassDesignator values define what will be included in the retrieved data set. The supported combinations are listed in the following table.

sDataDesignator sMonitorClassDesignator DataSet Retrieved
ALL BROWSERTX Summary, page, object, host, and connection-level
ALL PRIVATE PEER Summary, page, object, host, and connection-level
ALL LASTMILE Summary, page, object, host, and connection-level
ALL MOBILE Summary, page, object, host, connection, and mobileext-level
OBJECT BROWSERTX Summary, page, and object level only
OBJECT PRIVATE PEER Summary, page, and object level only
OBJECT LASTMILE Summary, page, and object level only
OBJECT MOBILE Summary, page, object, and mobileext-level
PAGE BROWSERTX Summary and page-level only
PAGE PRIVATE PEER Summary and page-level only
PAGE LASTMILE Summary and page-level only
PAGE MOBILE Summary, page, and mobileext-level
SUMMARY BROWSERTX Summary-level only
SUMMARY PRIVATE PEER Summary-level only
SUMMARY LASTMILE Summary-level only
SUMMARY MOBILE Summary-level only
TIMEGROUP BROWSERTX Up to 24 hours of aggregated data

Validation criteria

The following are descriptions of the validation criteria for the OpenDataFeed request.

  • Username – The supplied username is valid for the account.

  • Password – The supplied password is valid for the account.

  • MonitorIdSet – The set of Monitor IDs is valid for the account.

  • SiteIdSet – The set of Site IDs is valid for the account.

  • StartTime – The time window start boundary is valid.

  • EndTime – The time window end boundary is valid.

  • MonitorClassDesignator – The sMonitorClassDesignator value is valid.

  • DataDesignator – The sDataDesignator value is valid.

  • OrderDesignator – The sOrderDesignator value is valid.

  • Data Volume – The volume of data does not exceed the account constraints.

  • Frequency – The request frequency does not exceed the account constraints.

  • Concurrency – The request concurrency does not exceed the account constraints.

Response example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <soap:Body>
   <OpenDataFeedResponse xmlns="http://gomeznetworks.com/webservices/">
    <GpnOpenUtaDataFeedResponse>
     <Status>
      <eStatus>STATUS_SUCCESS</eStatus>
      <sErrorMessage/>
     </Status>
     <GPNGlobalConstraints MaxDataRequestsPerHourPerSession="60"
      MaxTotalSessions="4096"/>
     <GPNAccountConstraints MaxDataRecordsPerRequest="100"
      MaxConcurrentSessions="100" MaxConcurrentRequests="1"
      MaxRequestIntervalBeforeExpirationInMinutes="15"/>
    <CurrentTime>2014-01-15 17:49:54</CurrentTime>
     <SessionToken>39eb9e7d-c0cb-4e62-a806-46cd112e1d8c</SessionToken>
      <AcceptedMonitors>
       <mid>331608</mid>
      </AcceptedMonitors>
      <AcceptedSites>
       <sid>5</sid>
       <sid>6</sid>
       <sid>316</sid>
       <sid>777</sid>
       <sid>834</sid>
       <sid>835</sid>
       <sid>836</sid>
       <sid>837</sid>
       <sid>843</sid>
       <sid>844</sid>
       <sid>845</sid>
       <sid>846</sid>
       <sid>847</sid>
       <sid>848</sid>
       <sid>849</sid>
       <sid>850</sid>
       <sid>851</sid>
       <sid>852</sid>
       <sid>855</sid>
       <sid>856</sid>
       <sid>857</sid>
       <sid>858</sid>
       <sid>860</sid>
       <sid>861</sid>
       <sid>862</sid>
       <sid>864</sid>
       <sid>865</sid>
       <sid>866</sid>
       <sid>867</sid>
       <sid>868</sid>
       <sid>871</sid>
       <sid>872</sid>
       <sid>873</sid>
       <sid>880</sid>
       <sid>881</sid>
       <sid>884</sid>
       <sid>885</sid>
       <sid>886</sid>
       <sid>887</sid>
       <sid>888</sid>
       <sid>889</sid>
       <sid>9100</sid>
      </AcceptedSites>
     </GpnOpenUtaDataFeedResponse>
   </OpenDataFeedResponse>
   </soap:Body>
</soap:Envelope>