reporting

Lists top domains.

This endpoint lists the top domains based on activity or performance metrics for a specified period, helping users identify the most active or highest-performing domains.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive data retrieval: Returns a comprehensive list of the top domains, providing a complete and accurate overview for seamless management and analysis.</br>- Comprehensive error handling: Returns a 401 error code with a clear description when requests fail. specified means the current month to date.</br>- Flexible domain limiting: Uses the limit parameter to specify the number of top domains to return, optimizing data retrieval and ensuring focused, relevant results.</br>- Periodic filtering: Uses the month and year parameters to filter results, enabling in-depth trend analysis, performance monitoring, and tailored reporting.

get/reporting/topdomains

Request

Query parameters

yearinteger
Example:2024

Filters reports by the specified year.

monthinteger

Valid values are 1 to 12

Example:1

Filters reports by the specified month. Note that 1 corresponds to January and 12 to December.

limitinteger

Valid values are 1 to 12

Example:1

Specifies the number of top domains to return.

Response

Top domains listed successfully.

idinteger
namestring
typestring
monthstring

Example response

[
  {
    "id": 1,
    "name": "example.com",
    "type": "primary",
    "month": "2024-05",
    "queries": {
      "total": 200,
      "refused": 50,
      "servfail": 5,
      "notimpl": 5,
      "responsecount": 60,
      "noerror": 50,
      "nxdomain": 20,
      "formerr": 10
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.