Understanding How The API Works »
Retrieving Query statistics using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
REST Syntax
| Click to view all REST Resources |
| /REST/QPSReport/ POST — Retrieve information to create a Queries Per Second (QPS) report.
QPS data is available with the following breakdowns based on type and granularity.
| Breakdown |
24-Hours |
30-Days |
45-Days |
Year |
| Host* |
1-Hour |
1-Hour |
— |
— |
| Record |
5-minute |
1-Hour |
1-Hour |
4-Hour |
| Zone |
5-minute |
1-Hour |
1-Hour |
4-Hour |
| Account** |
5-minute |
1-Hour |
1-Hour |
4-Hour |
* Only returns the top 100 queried hostnames
** Account does not require a breakdown argument
HTTP Action — POST
URIs — https://api.dynect.net/REST/QPSReport/ |
Arguments — Click for More Info
- integer
start_ts — Required. The timestamp at the beginning of the report range.
- integer
end_ts — Required. The timestamp at the end of the report range.
- array
breakdown — By default, most data is aggregated together. The fields listed in this argument are those that should be separated out.
Valid values:
hosts – Separate data by hostname. Not available for all accounts.
rrecs – Separate data by record type.
zones – Separate data by zone.
The following is the acceptable grouping for breakdown in combination with zones argument:
Zones : Account wide query (no zones provided):
Breakdown : ['zones']
or
Breakdown : ['rrecs']
Zones : a single zone provided:
Breakdown : ['hosts']
or
Breakdown : ['rrecs']
Zones : multiple zones provided:
Breakdown : ['zones']
or
Breakdown : ['zones', 'hosts']"
- array
hosts — Hostnames to include in the report. An individual item can begin with a ‘!’ to indicate a value to exclude. Defaults to all hosts. Not available for all accounts.
- array
rrecs — Record types to include in the report. An individual item can begin with a ‘!’ to indicate a value to exclude. Defaults to all record types.
- array
zones — Zones to include in the report. Defaults to all zones.
|
Response:
string csv — The report data in csv format. |
SOAP Syntax
| Click to view all SOAP Commands |
| GetQueryStats — Retrieve information to create a Queries Per Second (QPS) report. |
Arguments — Click for More Info
- integer
start_ts — Required. The timestamp at the beginning of the report range.
- integer
end_ts — Required. The timestamp at the end of the report range.
- array
breakdown — By default, most data is aggregated together. The fields listed in this argument are those that should be separated out.
Valid values:
hosts – Separate data by hostname. Not available for all accounts.
rrecs – Separate data by record type
zones – Separate data by zone
- array
hosts — Hostnames to include in the report. An individual item can begin with a ‘!’ to indicate a value to exclude. Defaults to all hosts. Not available for all accounts.
- array
rrecs — Record types to include in the report. An individual item can begin with a ‘!’ to indicate a value to exclude. Defaults to all record types.
- string
token — Required. The session identifier.
- array
zones — Zones to include in the report. Defaults to all zones.
|
Response:
string csv — The report data in csv format. |
Example Request — Click for More Info
{
'breakdown' => 'zones',
'end_ts' => '1270064603',
'rrecs' => [
'A',
'!AAAA'
],
'start_ts' => '1270151003',
'token' => 'asdlkfjasl23j4879afa',
'zones' => [
'example.com',
'example.org'
],
}
|
<< DNS API Knowledge Base
