Overview

Namespaces

  • Cloudflare
    • Organizations
      • Firewall
        • AccessRules
    • User
      • Billing
        • Subscriptions
      • Firewall
    • Zone
      • Firewall
      • SSL
      • WAF
        • Packages

Classes

  • Analytics
  • Cache
  • CustomPages
  • CustomSSL
  • Dns
  • KeylessSSL
  • Pagerules
  • Plan
  • Railgun
  • Settings
  • SSL
  • Overview
  • Namespace
  • Class

Class Analytics

CloudFlare API wrapper

Analytics CloudFlare Analytics

Cloudflare\Api
Extended by Cloudflare\Zone\Analytics
Namespace: Cloudflare\Zone
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Zone/Analytics.php
Methods summary
public
# 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.

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.

Parameters

$zone_identifier
$since

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

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

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

public
# 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.

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.

Parameters

$zone_identifier
$since

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

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

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

Methods inherited from Cloudflare\Api
__construct(), delete(), get(), patch(), permissions(), post(), put(), request(), setAuthKey(), setCurlOption(), setEmail()
Properties summary
protected array $permission_level

Default permissions level

Default permissions level

# ['read' => '#analytics:read', 'edit' => '#analytics:edit']
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen