API summary
Reference table and example use cases for API summary based engagement rules.
The following are some example use cases for API summary based engagement rules:
- An API Provider can use Engagement to get notified:
- If the calls for a particular API decrease quarter to quarter.
- If there is an increase in the time to serve requests for the current month when compared to the previous month.
Note: The API summary data is retained for longer periods and the rules created for API summary data
can be used to perform long-term trend analysis over months or quarters.
The following table shows the list of fields available for the API summary datasource:
| Field | Type | Description |
|---|---|---|
| api_ref | string | API reference (api_name:api_version). |
| product_ref | string | Product reference (product_name:product_version). |
| app_name | string | The name of the registered application. |
| catalog_name | string | The name of the catalog. |
| space_name | string | The name of the space, if spaces are enabled. |
| gateway_service_name | string | The name of the DataPower API gateway service that is configured by the Cloud Admin user when
registering the gateway service. Only available on DataPower API Gateway v10.5.3 or higher. |
| plan_id | string | The plan identifier. |
| status_code | string | The status code set on the outbound response. |
| bytes_received | number | The number of bytes received from the consumer in the request. |
| bytes_sent | number | The number of bytes sent to the consumer in the response. |
| time_to_serve_request | number | The time elapsed (in milliseconds) between the gateway received the request and sent a response. |