Genesys CloudInstall

Summary

Retrieve usage statistics for a specified OAuth client within a defined date range, optionally grouping and filtering the usage metrics by provided dimensions and granularity.

Inputs

• Authentication — Select OAuth2 as the OAuth authorization flow.
• OAuth Client ID (required) — ID of the OAuth client to retrieve usage statistics for.
• Start Date (required) — ISO 8601 formatted start date for the usage query (e.g., 2024-01-01T00:00:00Z). Must be before End Date.
• End Date (required) — ISO 8601 formatted end date for the usage query (e.g., 2024-01-31T23:59:59Z). Must be after Start Date.
• Options — Optional parameters to customize the usage query:
• Granularity: Time grouping ('Day', 'Week', or 'Month').
• Metrics: One or more of Requests, Status 200, Status 300, Status 400, Status 429, Status 500 to include in data.
• Group By: Dimensions to group data by, such as OAuth Client ID, Organization ID, Template URI, HTTP Method.

Output shape

a single item containing usage statistics json

The operation submits a usage query to the Genesys Cloud API and polls for completion up to 10 times with a 3-second interval. Upon completion, it returns aggregated usage data including total requests and breakdown of requests per endpoint. Throws errors if the query fails or if no executionId is returned. The returned data includes fields: startDate, endDate, totalRequests, and requestsPerEndpoint (array of endpoint/request count objects).

Links

• n8n community nodes installation guide