usage

Returns monthly usage statistics of a specific secondary domain.

This endpoint returns monthly usage statistics of a specific secondary domain, allowing users to track and analyze long-term resource consumption patterns.</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 error handling: Returns 401 and 404 error codes with clear descriptions when requests fail.</br>- Periodic filtering: Uses the month and year parameters to filter results, enabling in-depth trend analysis, performance monitoring, and tailored reporting.</br>- Targeted data retrieval: Employs the domainId parameter to return the specified domain's statistics, ensuring accuracy and relevance in the response.

get/usage/stats/secondary/{domainId}/monthly

Request

Path parameters

domainIdinteger required

Filters data by the domain's unique identifier.

Query parameters

monthstring
Example:1

Filters usage statistics by the specified month of the year. Note that 1 corresponds to January and 12 to December.

yearstring
Example:2024

Filters usage statistics by the specified year.

Response

Usage statistics returned successfully.

idinteger
namestring
typestring
monthstring
yearstring

Example response

[
  {
    "id": 1,
    "name": "example.com",
    "type": "secondary",
    "month": "05",
    "year": "2024",
    "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.