# 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.

Endpoint: GET /reporting/api-usage-report
Version: 3.18.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `start_date` (string)
    Report start date/time. Defaults to first API request.

  - `end_date` (string)
    Report end date/time. Defaults to current time.

  - `api_metric_kind` (string)
    Restrict the list to API usage metric of the given kind

  - `group_by` (array)
    The field to group results by.

  - `client_name` (array)
    The Client names to be included in the report.

  - `user_agent` (array)
    The UserAgent names to be included in the report.

  - `dct_version` (array)
    The DCT versions to be included in the report.

## Response 200:

  - `200` (unknown)
    Returns a list of API usage metrics.

## Response 200 fields (application/json):

  - `items` (array)

  - `items.api_endpoint` (string)
    API called.
    Example: /v2/management/engines

  - `items.api_method` (string)
    HTTP method for API called.
    Example: GET

  - `items.api_count` (integer, required)
    Count of API calls over the requested timeframe.
    Example: 4200

  - `items.kind` (string)
    Whether the API calls are of kind automation or governance
    Enum: "automation", "governance"

  - `items.client_name` (string)
    Name of the api client that called the API endpoint
    Example: client-123

  - `items.user_agent` (string)
    Version of the api client that called the API endpoint
    Example: 1.0-beta

  - `items.dct_version` (string)
    DCT version at the time of api call
    Example: 2.2.0

  - `total_automation_api_count` (integer)
    Total count of automation API calls over the requested timeframe.
    Example: 4200

  - `total_governance_api_count` (integer)
    Total count of governance API calls over the requested timeframe.
    Example: 4200