# IBM API Connect Engagement API

**Canonical:** https://apis.io/apis/ibm-api-connect/ibm-api-connect-engagement-api/  
**Provider:** IBM API Connect — https://apis.io/providers/ibm-api-connect/  
**Documentation:** https://apic-api.apiconnect.ibmcloud.com/v12/

IBM API Connect Engagement API is one of 43 APIs that [IBM API Connect](https://apis.io/providers/ibm-api-connect/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Analytics, Alerting, and REST API. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

Manages engagement configuration and rules evaluated against API Connect Analytics data for a provider organization. OpenAPI 3.0, version 2.0.0.

## Operations (60 of 62)

| Method | Path | Summary |
|---|---|---|
| GET | `/{analytics-service}/orgs/{org}/engagement-config` | Engagement configuration supported at provider organization scope |
| GET | `/{analytics-service}/orgs/{org}/anomaly-detectors` | List anomaly detectors at provider organization scope |
| POST | `/{analytics-service}/orgs/{org}/anomaly-detectors` | Create an anomaly detector at provider organization scope |
| POST | `/{analytics-service}/orgs/{org}/anomaly-detectors/templates/{detector-type}` | Create an anomaly detector from a template |
| POST | `/{analytics-service}/orgs/{org}/anomaly-detectors/validate/model` | Validate anomaly detector configuration |
| GET | `/{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}` | Get an anomaly detector |
| PUT | `/{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}` | Update an anomaly detector |
| DELETE | `/{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}` | Delete an anomaly detector |
| POST | `/{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}/start` | Start an anomaly detector |
| POST | `/{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}/stop` | Stop an anomaly detector |
| GET | `/{analytics-service}/orgs/{org}/rules` | List rules at provider organization scope |
| POST | `/{analytics-service}/orgs/{org}/rules` | Create a rule at provider organization scope |
| GET | `/{analytics-service}/orgs/{org}/rules/{rule-id}` | Get an engagement rule |
| PUT | `/{analytics-service}/orgs/{org}/rules/{rule-id}` | Update an engagement rule |
| DELETE | `/{analytics-service}/orgs/{org}/rules/{rule-id}` | Delete an engagement rule |
| GET | `/{analytics-service}/orgs/{org}/tasks` | List tasks for an engagement rule at provider organization scope |
| GET | `/{analytics-service}/orgs/{org}/rules/total-count` | Returns the total count of all engagement rules within a specific organization |
| GET | `/{analytics-service}/orgs/{org}/tasks/{task-id}` | Get an engagement task |
| GET | `/{analytics-service}/orgs/{org}/destinations` | List destinations at provider organization scope |
| POST | `/{analytics-service}/orgs/{org}/destinations` | Create a destination at provider organization scope |
| GET | `/{analytics-service}/orgs/{org}/destinations/{destination-id}` | Get an engagement destination |
| PUT | `/{analytics-service}/orgs/{org}/destinations/{destination-id}` | Update an engagement destination |
| DELETE | `/{analytics-service}/orgs/{org}/destinations/{destination-id}` | Delete an engagement destination |
| GET | `/{analytics-service}/orgs/{org}/destinations/{destination-id}/test` | Test an engagement destination |
| POST | `/{analytics-service}/orgs/{org}/notifications` | Create a Jira ticket notification at provider organization scope |
| GET | `/{analytics-service}/orgs/{org}/scheduled-reports` | List scheduled reports at provider organization scope |
| POST | `/{analytics-service}/orgs/{org}/scheduled-reports` | Create a scheduled report at provider organization scope |
| GET | `/{analytics-service}/orgs/{org}/scheduled-reports/{scheduledreport-id}` | Get a scheduled report |
| PUT | `/{analytics-service}/orgs/{org}/scheduled-reports/{scheduledreport-id}` | Update a scheduled report |
| DELETE | `/{analytics-service}/orgs/{org}/scheduled-reports/{scheduledreport-id}` | Delete a scheduled report |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/engagement-config` | Engagement configuration supported at catalog scope |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/rules` | List rules at catalog scope |
| POST | `/{analytics-service}/catalogs/{org}/{catalog}/rules` | Create a rule at catalog scope |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/rules/total-count` | Returns the total count of all engagement rules within a specific catalog |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/rules/{rule-id}` | Get an engagement rule |
| PUT | `/{analytics-service}/catalogs/{org}/{catalog}/rules/{rule-id}` | Update an engagement rule |
| DELETE | `/{analytics-service}/catalogs/{org}/{catalog}/rules/{rule-id}` | Delete an engagement rule |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/tasks` | List tasks for an engagement rule at catalog scope |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/tasks/{task-id}` | Get an engagement task |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/destinations` | List destinations at catalog scope |
| POST | `/{analytics-service}/catalogs/{org}/{catalog}/destinations` | Create a destination at catalog scope |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id}` | Get an engagement destination |
| PUT | `/{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id}` | Update an engagement destination |
| DELETE | `/{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id}` | Delete an engagement destination |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id}/test` | Test an engagement destination |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports` | List scheduled reports at catalog scope |
| POST | `/{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports` | Create a scheduled report at catalog scope |
| GET | `/{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports/{scheduledreport-id}` | Get a scheduled report |
| PUT | `/{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports/{scheduledreport-id}` | Update a scheduled report |
| DELETE | `/{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports/{scheduledreport-id}` | Delete a scheduled report |
| GET | `/{analytics-service}/cloud/engagement-config` | Engagement configuration supported at cloud scope |
| GET | `/{analytics-service}/cloud/scheduled-reports` | List scheduled reports at cloud scope |
| POST | `/{analytics-service}/cloud/scheduled-reports` | Create a scheduled report at cloud scope |
| GET | `/{analytics-service}/cloud/scheduled-reports/{scheduledreport-id}` | Get a scheduled report |
| PUT | `/{analytics-service}/cloud/scheduled-reports/{scheduledreport-id}` | Update a scheduled report |
| DELETE | `/{analytics-service}/cloud/scheduled-reports/{scheduledreport-id}` | Delete a scheduled report |
| GET | `/{analytics-service}/cloud/destinations` | List destinations at cloud scope |
| POST | `/{analytics-service}/cloud/destinations` | Create a destination at cloud scope |
| GET | `/{analytics-service}/cloud/destinations/{destination-id}` | Get an engagement destination |
| PUT | `/{analytics-service}/cloud/destinations/{destination-id}` | Update an engagement destination |

…and 2 more operations. They are listed in full on the page.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-engagement-api-openapi.yml
- **Reference** — https://apic-api.apiconnect.ibmcloud.com/v12/
- **Documentation** — https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
- **GettingStarted** — https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
- **Authentication** — https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys

## Other IBM API Connect APIs (12)

- [IBM API Connect Platform - Cloud Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-cloud-management-api/)
- [IBM API Connect Analytics API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-analytics-api/)
- [IBM API Connect Consumer Analytics API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-consumer-analytics-api/)
- [IBM API Connect Discovery API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-discovery-api/)
- [IBM API Connect AI Assets API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-ai-assets-api/)
- [IBM API Connect Application Strategy management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-application-strategy-management-api/)
- [IBM API Connect Billing Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-billing-management-api/)
- [IBM API Connect Catalog Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-management-api/)
- [IBM API Connect Catalog Resource API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-resource-api/)
- [IBM API Connect Catalog Resources API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-resources-api/)
- [IBM API Connect Catalog Settings API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-settings-api/)
- [IBM API Connect Cloud Settings API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-cloud-settings-api/)

## Tags

Analytics, Alerting, REST API

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ibm-api-connect/ibm-api-connect-engagement-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ibm-api-connect/.