api_usage_v2

GoDaddy Domains v2 API (account-level, not customer-scoped). Accepts a Personal Access Token (Bearer) or a classic sso-key credential.

Overview

Name	api_usage_v2
Type	Resource
Id	godaddy.domains.api_usage_v2

Fields

The following fields are returned by SELECT queries:

get

Request was successful

Name	Datatype	Description
details	array	List of total request counts per endpoint.
quota	integer	The total number of allowed requests in the month. See https://developer.godaddy.com/getstarted for more information on api quotas and access limits.
total	integer	The total number of requests in the month.
yyyymm	string	The year/month timeframe for the request counts (in the format yyyy-mm)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	yyyymm	x_request_id, includes	Returns monthly API request counts for the account. Data is retained for three months.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
yyyymm	string	The year/month timeframe for the request counts (in the format yyyy-mm)
includes	array	Determines if the detail records (grouped by request path) are included in the response
x_request_id	string	A client provided identifier for tracking this request. (wire: X-Request-Id)

SELECT examples

get

Returns monthly API request counts for the account. Data is retained for three months.

SELECT
details,
quota,
total,
yyyymm
FROM godaddy.domains.api_usage_v2
WHERE yyyymm = '{{ yyyymm }}' -- required
AND x_request_id = '{{ x_request_id }}'
AND includes = '{{ includes }}'
;