PHP Class Cloudflare\Zone\Analytics

Analytics CloudFlare Analytics
Author: James Bell ([email protected])
Inheritance: extends CloudFlare\Zone
Show file Open project: jamesryanbell/cloudflare

Public Methods

Method Description
colos ( string $zone_identifier, string | integer | null $since = null, string | integer | null $until = null, boolean $continuous = null ) Analytics by Co-locations (permission needed: #analytics:read) This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.
dashboard ( string $zone_identifier, string | integer | null $since = null, string | integer | null $until = null, boolean $continuous = null ) Dashboard (permission needed: #analytics:read) The dashboard view provides both totals and timeseries data for the given zone and time period across the entire CloudFlare network.

Method Details

colos() public method

Analytics by Co-locations (permission needed: #analytics:read) This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.
public colos ( string $zone_identifier, string | integer | null $since = null, string | integer | null $until = null, boolean $continuous = null )
$zone_identifier string
$since string | integer | null The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.
$until string | integer | null The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.
$continuous boolean When set to true, the range returned by the response acts like a sliding window to provide a contiguous time-window. Analytics data is processed and aggregated asynchronously and can sometimes lead to recent data points being incomplete if this value is set to false. If a start date provided is earlier than a date for which data is available, the API will return 0's for those dates until the first available date with data

dashboard() public method

Dashboard (permission needed: #analytics:read) The dashboard view provides both totals and timeseries data for the given zone and time period across the entire CloudFlare network.
public dashboard ( string $zone_identifier, string | integer | null $since = null, string | integer | null $until = null, boolean $continuous = null )
$zone_identifier string
$since string | integer | null The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.
$until string | integer | null The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.
$continuous boolean When set to true, the range returned by the response acts like a sliding window to provide a contiguous time-window. Analytics data is processed and aggregated asynchronously and can sometimes lead to recent data points being incomplete if this value is set to false. If a start date provided is earlier than a date for which data is available, the API will return 0's for those dates until the first available date with data