Yoobic Incentives Kpi API
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.
Yoobic Incentives Kpi API is one of 41 APIs that Yoobic publishes on the 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.
This API exposes 8 operations across 6 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Incentives Kpi API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
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…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.
This is an independent, third-party profile of Yoobic Incentives Kpi API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.