Report Functions

Create and acquire reports that include statistical information such as the return status for status codes from an edge server to the end user, and the volume of data transferred. Such reports can be useful for looking up cache hit rates in order to reconsider cache TTL, for example. Users can also acquire reporting information in units of delivery and region.

Create Report Function

Create statistical information for each of the delivery settings that have been created within the range of a project. To create a report, specify the following items.

Table 1. Creating a Report (List of Items That Can Be Set)
Item Description Required
Granularity

Specify the granularity of the information from either of the following:

  • daily: A report is created every day.
  • hourly: A report is created every hour (from hh:00 to hh:59).
 Yes
Starting Date Specify the starting date (UTC). You can specify a maximum period of up to 60 days in the past. Yes
Ending Date

Specify the ending date (UTC). If omitted, the current date is set.

Note:
  • You cannot specify a date before the starting date.
  • If granularity is set to "daily," you must set a date within 31 days from the starting date.
  • If granularity is set to "hourly," you must set a date within 14 days from the starting date.
  
Protocol

Specify a protocol scheme for which data is gathered, from one of the following:

  • http: HTTP accesses only
  • ssl: HTTPS accesses only
  • all: Combined total (default)
  
Target

Specify the target of the information from either of the following:

  • Combined total for delivery setting (default)

Specific delivery setting

  
Output per Region

Specify whether to output per region:

  • true: Output per region

false: Combined total (default)

  
List of Metrics to Be Acquired

Specify the names of the metrics that you want to output from List of Metrics That Can Be Acquired with a Report, separated by commas.

 Yes
Table 2. List of Metrics That Can Be Acquired with a Report
Name Description
IncompleteDownloadCount Number of incomplete downloads
200Count Number of Status Code 200 responses
206Count Number of Status Code 206 responses
2XXCount Combined total number of Status Code 2XX responses and incomplete downloads
302Count Number of Status Code 302 responses
304Count Number of Status Code 304 responses
3XXCount Combined total number of Status Code 3XX responses
404Count Number of Status Code 404 responses
4XXCount Combined total number of Status Code 4XX responses
5XXCount Combined total number of Status Code 5XX responses
RequestCount Combined total number of requests from the end user to the edge server
TotalBytes Volume of data transferred from the edge server to the end user [MB]
IngressBytes Volume of data transferred from the origin server to the edge server [B]
IngressCount Number of requests from the edge server to the origin server
IngressRequestBytes Volume of data transferred from the edge server to the origin server [B]
OffloadHitRatio Ratio of offload from the edge server to the origin server. Cache hit ratio.

A few minutes are required to create a report. Therefore, when the command to create a report is issued, the report ID can be acquired first. You can specify a report ID and then use the "Acquire Report" function to view a report that has been created.

Note: A report ID is valid for 1 hour after the report is created. Then, it is automatically deleted.

Reports are created based on the latest information aggregated on the edge server. Normally, the acquisition of this information starts in about 4 hours. Normally it takes about 1 or 2 days to aggregate the information on all edge servers.

Tip: For example, if on January 1 at 12pm a command is implemented to create a report until 11am, it is possible that the report that is acquired in a few minutes will be based on provisional information that was aggregated from the starting time of the content delivery until about 8am on January 1. To acquire reports from all edge servers, issue a command to create a report again at around 12pm two days later on January 3.

Acquire Report Function

Specify a report ID that was created with the Create Report function to acquire a report in json format. The json data in the report will have the following format.

{ 
    "headers": [ 
        {Definition of headers (index: 0 is fixed to "Time"(UTC))} 
        {Definition of headers (index: 1 and later are according to the list of metrics you have specified)} 
        ... 
    ], 
    "rows": [ 
        [Data in 1st row based on headers], 
        ... 
        [Data in nth row based on headers], 
    ], 
    "metadata": { 
        "granularity": "daily" (or other conditions as you have specified), 
        ... 
    } 
}

Example of json data in report:

{ 
    "headers": [ 
        {"index": 0, "name": "Time",}, 
        {"index": 1, "name": "200Count"}, 
        {"index": 2, "name": "TotalBytes"} 
    ], 
    "rows": [ 
        ["2015/12/01 00:00", "47", "100.0"], 
        ["2015/12/02 00:00", "30", "67.4"] 
    ], 
    "metadata": { 
        "time_created": "2015/12/10 00:11", 
        "granularity": "daily", 
        "start_date": "20151201", 
        "end_date": "20151202", 
        "delivery_option": "all", 
        "metrics": ["200Count", "TotalBytes"], 
    } 
}