Help Center/ Content Delivery Network/ API Reference/ API/ Statistical Analysis/ Querying Domain Name Statistics by Region and Carrier
Updated on 2024-10-10 GMT+08:00
View PDF

Querying Domain Name Statistics by Region and Carrier

Function

  • You can query data within the past 90 days.
  • You can query up to 5 metrics each time.
  • You can query up to 20 domain names each time.
  • The start time and end time must be timestamps in milliseconds and must be exact time points that match the query interval. For example, if the query interval is 5 minutes, the start time and end time must be exact 5-minute intervals, for example, 0 minutes, 5 minutes, 10 minutes, and 15 minutes. If the time points do not match the query interval, the returned data may not be the expected data. If the start time is 2019-01-24 20:15:00 and the query interval is 5 minutes, the statistics in [20:15:00, 20:20:00) are queried.
  • Values of action include location_detail and location_summary.
  • Unit: byte for traffic-related metrics, bit/s for bandwidth-related metrics, and number of times for request quantity and status code-related metrics. You can query statistics about specific domain names by specific metrics, regions, and carriers.
  • A single tenant can call this API 15 times per second.

URI

GET /v1.0/cdn/statistics/domain-location-stats

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String
  • Action name. Possible values: location_summary and location_detail.
  • location_summary: querying summary data.
  • location_detail: querying data details.

start_time

Yes

Long
  • Start timestamp of the query. This parameter must be specified together with the end timestamp. The query interval is left-closed and right-open.
  • If the value of interval is 300, set this parameter to a multiple of 5 minutes, for example, 1631240100000 (2021-09-10 10:15:00).
  • If the value of interval is 3600, set this parameter to a multiple of 1 hour, for example, 1631239200000 (2021-09-10 10:00:00).

end_time

Yes

Long
  • End timestamp of the query. This parameter must be specified together with the start timestamp. The query interval is left-closed and right-open.
  • If the value of interval is 300, set this parameter to a multiple of 5 minutes, for example, 1631243700000 (2021-09-10 11:15:00).
  • If the value of interval is 3600, set this parameter to a multiple of 1 hour, for example, 1631325600000 (2021-09-11 10:00:00).

domain_name

Yes

String

Domain name list. Use commas (,) to separate multiple domain names, for example, www.test1.com,www.test2.com. all indicates that all domain names are queried.

stat_type

Yes

String
  • Network resource consumption statistics:
    • bw (bandwidth)
    • flux (traffic)
  • Access statistics:
    • req_num (number of requests)

interval

No

Long
  • Query interval, in seconds.
  • 300 (5 minutes): The maximum query time span is two days.
  • 3600 (1 hour): The maximum query time span is seven days.
  • If this parameter is not passed, the system uses the smallest value corresponding to the queried time span by default.

country

No

String
  • Country and region codes, which are separated by commas (,). The value all indicates all codes. For details about the values, see the appendix.
  • This parameter cannot be set when carrier statistics are queried.

isp

No

String

Carrier code. Use commas (,) to separate multiple codes. all indicates all carriers are queried. For details about the values, see the appendix.

group_by

No

String

Data grouping mode. Use commas (,) to separate multiple groups. Available data groups are domain, country, and isp. By default, data is not grouped.

enterprise_project_id

No

String

ID of the enterprise project to which the resource belongs. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

group_by

String

Data grouping mode.

result

Map<String,Object>

Data organized according to the specified grouping mode.

Status code: default

Table 3 Response body parameters

Parameter

Type

Description

error

ErrMsg object

Error code and error message.
Table 4 ErrMsg

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

  • Ungrouped domain details 
    GET https://{endpoint}/v1.0/cdn/statistics/domain-location-stats?action='location_summary'&start_time=1667030400000&end_time=1667116800000&domain_name='www.test1.com'&stat_type='flux'&interval=300&country='ch'&isp='swisscom'&enterprise_project_id='all'
  • Domain details by domain 
    GET https://{endpoint}/v1.0/cdn/statistics/domain-location-stats?action='location_summary'&start_time=1667030400000&end_time=1667116800000&domain_name='www.test1.com'&stat_type='flux'&interval=300&country='ch'&isp='swisscom'&group_by='domain'&enterprise_project_id='all'

Example Responses

Status code: 200

Success response

  • Ungrouped domain details 
    {
  "result" : {
    "flux" : [ 0, 1, 2 ]
  }
}
  • Details by domain 
    {
  "group_by" : "domain",
  "result" : {
    "www.test1.com" : {
      "flux" : [ 0, 1, 2 ]
    },
    "www.test2.com" : {
      "flux" : [ 0, 1, 2 ]
    }
  }
}
  • Domain details by country/region 
    {
  "group_by" : "country",
  "result" : {
    "ch" : {
      "flux" : [ 0, 1, 2 ]
    },
    "se" : {
      "flux" : [ 0, 1, 2 ]
    }
  }
}
  • Domain details by carrier 
    {
  "group_by" : "isp",
  "result" : {
    "swisscom" : {
      "flux" : [ 0, 1, 2 ]
    },
    "telia" : {
      "flux" : [ 0, 1, 2 ]
    }
  }
}
  • Domain details by domain and country/region 
    {
  "group_by" : "domain,country",
  "result" : {
    "www.test1.com" : {
      "ch" : {
        "flux" : [ 0, 1, 2 ]
      },
      "se" : {
        "flux" : [ 0, 1, 2 ]
      }
    },
    "www.test2.com" : {
      "ch" : {
        "flux" : [ 0, 1, 2 ]
      },
      "se" : {
        "flux" : [ 0, 1, 2 ]
      }
    }
  }
}
  • Domain details by domain and carrier 
    {
  "group_by" : "domain,isp",
  "result" : {
    "www.test1.com" : {
      "swisscom" : {
        "req_num" : [ 0, 1, 2 ]
      }
    },
    "www.test2.com" : {
      "swisscom" : {
        "req_num" : [ 0, 1, 2 ]
      }
    }
  }
}
  • Overall domain data 
    {
  "result" : {
    "flux" : 1024
  }
}
  • Overall data by domain 
    {
  "group_by" : "domain",
  "result" : {
    "www.test1.com" : {
      "flux" : 1024
    },
    "www.test2.com" : {
      "flux" : 1024
    }
  }
}
  • Overall domain data by country/region 
    {
  "group_by" : "country",
  "result" : {
    "ch" : {
      "flux" : 1024
    },
    "se" : {
      "flux" : 1024
    }
  }
}
  • Overall domain data by carrier 
    {
  "group_by" : "isp",
  "result" : {
    "swisscom" : {
      "flux" : 1024
    },
    "telia" : {
      "flux" : 1024
    }
  }
}

Status Codes

Status Code

Description

200

Success response

default

Abnormal response
Parent topic: Statistical Analysis