Skip to content
/
Gets the report of API us...

Gets the report of API usage metrics over a given time period. This API returns at the most 10000 results in the response to protect against the server running out of memory. Users might not hit this limit with the default report without any 'apiUsageReportGroupByParam' param but can hit this limit if the groupBy is by too granular like by 'client_name' or 'user_agent' only. Hence it is advisable to use startDate and endDate to 'limit' the scope of the report.

Request

Security
ApiKeyAuth
Query
start_datestring, (date-time)

Report start date/time. Defaults to first API request.

Example:start_date=2022-05-29T19:00:00.000Z
end_datestring, (date-time)

Report end date/time. Defaults to current time.

Example:end_date=2022-06-07T19:10:00.000Z
api_metric_kindstring

Restrict the list to API usage metric of the given kind

Enum:"automation""governance"
Example:api_metric_kind=automation
group_byArray of strings, non-empty

The field to group results by.

Items Enum:"api_endpoint""api_method""kind""client_name""user_agent""dct_version"
client_nameArray of strings, non-empty

The Client names to be included in the report.

user_agentArray of strings, non-empty

The UserAgent names to be included in the report.

dct_versionArray of strings, non-empty

The DCT versions to be included in the report.

Example:dct_version=name
curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2026.5.0.0/continuous-data-apis-dct-2026.5.0.0/reporting/api-usage-report?start_date=2022-05-29T19%3A00%3A00.000Z&end_date=2022-06-07T19%3A10%3A00.000Z&api_metric_kind=automation&group_by=api_endpoint&client_name=string&user_agent=string&dct_version=name' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Returns a list of API usage metrics.

Body
itemsArray of objects(ApiUsageData)
total_automation_api_countinteger, (int64)

Total count of automation API calls over the requested timeframe.

Example:4200
total_governance_api_countinteger, (int64)

Total count of governance API calls over the requested timeframe.

Example:4200
Response
{
  "items": [
    { … }
  ],
  "total_automation_api_count": 4200,
  "total_governance_api_count": 4200
}