Dnsimple.DnsAnalytics (dnsimple v10.2.0)

View Source

Provides functions to interact with the DNS Analytics endpoints.

The DNS Analytics API is in Public Beta.

Summary

Functions

Queries the DNS Analytics data of the account.

Functions

query(client, account_id, options \\ [])

@spec query(Dnsimple.Client.t(), String.t() | integer(), Keyword.t()) ::
  {:ok | :error, Dnsimple.Response.t()}

Queries the DNS Analytics data of the account.

The response data is a list of Dnsimple.DnsAnalyticsRow. The response query contains the parameters that produced the result.

See:

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.DnsAnalytics.query(client, account_id = 1010)
{:ok, response} = Dnsimple.DnsAnalytics.query(client, account_id = 1010, filter: [start_date: "2023-12-01", end_date: "2023-12-31"])
{:ok, response} = Dnsimple.DnsAnalytics.query(client, account_id = 1010, groupings: "zone_name,date")
{:ok, response} = Dnsimple.DnsAnalytics.query(client, account_id = 1010, sort: "volume:desc,zone_name:asc")
{:ok, response} = Dnsimple.DnsAnalytics.query(client, account_id = 1010, page: 2, per_page: 10)