This API enables you to retrieve aggregated delivery metrics for event notifications sent to a specific webhook.

Example request

curl --location 'https://eu.intouch.capillarytech.com/v3/events/consumer-groups/0c3ad68c-06e3-4947-85df-4df10e898eeb/metrics?startDate=1761393961170&endDate=1763985961170' \
--header 'Authorization: Basic zM0YTE2ODkxZjg0ZTdi'

Prerequisites

Authentication - Basic or OAuth authentication details
Access group resource - Read permission on webhook resource group
Consumer Group ID - The consumerGroupId from your webhook configuration

Resource information


Pagination supported?	No
Batch support	NA

Rate limit

Demo and testing clusters: 1,000 requests per minute per API key
Other organizations: The rate limit is brand-specific.

To modify the limit, create a ticket with the Capillary Product support team.

Path parameters

Field	Type	Required	Description
consumerGroupId	String	Yes	Unique identifier for the webhook. This ID is returned in the `consumerGroupId` field when you retrieve a webhook configuration details.

Query parameters

Parameter	Type	Description
startDate	Long	Start of the date range for metrics (Unix epoch in milliseconds). If not provided, returns metrics from the earliest available data. Example: 1761393961170
endDate	Long	End of the date range for metrics (Unix epoch in milliseconds). If not provided, returns metrics up to the current time.

Example response

{
    "data": {
        "totalEvents": 5148,
        "deliveredEvents": 5100,
        "failedEvents": 29,
        "retryingEvents": 0,
        "pendingEvents": 0,
        "startDate": 1753533250945,
        "endDate": 1756125250945
    },
    "errors": null,
    "warnings": null
}

Response parameters

Parameter	Description
data	Contains the aggregated metrics for event delivery.
.totalEvents	Total number of events processed during the specified time period.
.deliveredEvents	Number of events successfully delivered to the webhook endpoint.
.failedEvents	Number of events that failed to deliver to the webhook endpoint.
.pendingEvents	Number of events currently pending delivery.
.averageDeliveryTime	Average time taken to deliver events in milliseconds.
. retryingEvents	Number of events being retried to deliver to the webhook endpoint.
startDate	Start of the date range for metrics (Unix epoch in milliseconds)
endDate	End of the date range for metrics (Unix epoch in milliseconds)
errors	Array containing error details, if any. Returns `null` if no errors.
warnings	Array containing warning messages, if any. Returns `null` if no warnings.

Error codes

Code	Description
400	Bad Request – The request is invalid, such as malformed parameters or missing required data.
401	Unauthorized – The request is missing valid authentication credentials.
403	Forbidden – The authenticated user does not have permission to access those metrics.
404	Not Found – The consumer group does not exist or is not accessible.
500	Internal Server Error – Catch-all for unhandled or backend errors, such as: Could not connect to the Event Router service, Network/connectivity issues, and Unexpected server-side fatal errors.