# Yoobic Incentives Kpi API

**Canonical:** https://apis.io/apis/yoobic/yoobic-incentives-kpi-api/  
**Provider:** Yoobic — https://apis.io/providers/yoobic/  
**Base URL:** https://api.yoobic.com/public/api  
**Documentation:** https://docs.yoobic.com/api.html

Yoobic Incentives Kpi API is one of 41 APIs that [Yoobic](https://apis.io/providers/yoobic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Incentives Kpi. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

<a id="group-incentives-kpi"></a> Incentives-KPIs are an indicator for users’ progress within an incentive. Each incentives-kpi represents the sale of one or more items of a single product. When a user submits new progress for an incentive, the data is then broken down product by product, creating one or several new kpis. In case there are no products involved, submitting new progress will generate a single incentive kpi with an empty product ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|------------------------------------------------| |`incentive_kpi_id` | string | | x | | Unique id incentive_kpi | |`incentive_id` | string | x | | | The incentive_id | |`owner_id` | string | x | | | The user who submitted the kpi | |`username` | string | | x | | The owner username | |`first_name` | string | | x | | The owner first name | |`last_name` | string | | x | | The owner last name | |`participant_type` | string | x | | | Type of incentives-kpi ('individual' or 'team')| |`start_time` | date | x | | | The start time of the kpi | |`end_time` | date | x | | | The end time of the kpi | |`participant_user_id` | string | | | | The participant user in kpi | |`participant_group_id`| string | | | | The participant group in kpi | |`product_id` | string | | | | product_id involved in the kpi | |`price` | number | | x | | The product's price | |`count` | number | | | | Number of units in the kpi | |`weight` | number | | x | | Weight of product in total calculation | |`total` | number | | | | Total value of the kpi | |`created_date` | date | | x | | KPI submission date | |`updated_date` | date | | x | x | Last update date | Only one of these fields is required: - participant_user_id - participant_group_id **Important:** - If `participant_type` equals `teams`, `participant_group_id` must be filled with `group_id` value. - If `participant_type` equals `individual`, `participant_user_id` must be filled with `user_id` value. - `product_id` is optional and appear only if product is part of the related incentive. - `price` has a value only if a `product_id` exists.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-incentives-kpi-api-openapi.yml
- **Documentation** — https://docs.yoobic.com/api.html
- **APIReference** — https://docs.yoobic.com/api.html
- **Postman** — https://assets.yoobic.com/raw/upload/v1767016464/3c85c240-dd03-4981-9814-bc6e5e861fa0.zip
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/errors/yoobic-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conventions/yoobic-conventions.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/changelog/yoobic-changelog.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/lifecycle/yoobic-lifecycle.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conformance/yoobic-conformance.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/sandbox/yoobic-sandbox.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/asyncapi/yoobic-webhooks.yml

## Other Yoobic APIs (12)

- [Yoobic Answers API](https://apis.io/apis/yoobic/yoobic-answers-api/)
- [Yoobic Badges API](https://apis.io/apis/yoobic/yoobic-badges-api/)
- [Yoobic Bot Messages API](https://apis.io/apis/yoobic/yoobic-bot-messages-api/)
- [Yoobic Bots API](https://apis.io/apis/yoobic/yoobic-bots-api/)
- [Yoobic Business KPIs data - salesdata API](https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/)
- [Yoobic Campaigns API](https://apis.io/apis/yoobic/yoobic-campaigns-api/)
- [Yoobic Catalogs API](https://apis.io/apis/yoobic/yoobic-catalogs-api/)
- [Yoobic Chats API](https://apis.io/apis/yoobic/yoobic-chats-api/)
- [Yoobic Comments API](https://apis.io/apis/yoobic/yoobic-comments-api/)
- [Yoobic Communities API](https://apis.io/apis/yoobic/yoobic-communities-api/)
- [Yoobic Community Posts API](https://apis.io/apis/yoobic/yoobic-community-posts-api/)
- [Yoobic Competencies API](https://apis.io/apis/yoobic/yoobic-competencies-api/)

## Tags

Incentives Kpi

---

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