Authentication
Segment
A Segment is identified by its ID (long value) and also has name and filter (filtering type and filtering value). Supported filtering types are:
- Published url
- Source url
- Geo entity id
The Segments used with the Realtime Reporting API are different from the Custom Views / “subreports” used in the non-realtime reporting API. For more information on creating Segments, please contact your Account Manager.
Segments begin filtering data from the time they are created. Historical data cannot be included retroactively.
Granularity
The available time samples of reporting data are:
- FIVE_MINUTES
- HOUR
- DAY
Retention periods for each time sample are available by querying the Traffic Retentions Endpoint and the Storage Retentions Endpoint.
Requested Fields / Displayed Data Values
- datetime
- shortname
- policyFQDN
- requests
- bytes
Geo
- continentId
- continent
- countryId
- country
- stateId
- state
Status Codes
- outBytes
- inBytes
- outRequests
- inRequests
- datetime
- cacheCode
- statusCode
- shortname
Storage
- datetime
- shortname
- policyId
- uniqueBytes
- uniqueObjects
Traffic
- datetime
- totalBytes
- outBytes
- inBytes
- totalBitsPerSec
- outBitsPerSec
- inBitsPerSec
- totalRequests
- outRequests
- inRequests
- totalRequestsPerSec
- outRequestsPerSec
- inRequestsPerSec
- efficiencyRequests
- efficiencyBytes
Service
- HTTP
- HTTPS
- HLS
- HDS
- MSS
- DASH
Status
Segment status:
- ACTIVE
- INACTIVE
Realtime / Non Realtime Segments
A Boolean value indicating whether a Data Segment is realtime (true) or standard (false). For Standard Data Segments, only daily report granularity is supported within queries.