# Yoobic Business KPIs data - salesdata API **Canonical:** https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/ **Provider:** Yoobic — https://apis.io/providers/yoobic/ **Base URL:** https://api.yoobic.com/public/api **Documentation:** https://docs.yoobic.com/api.html Yoobic Business KPIs data - salesdata 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 Business KPIs data - salesdata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog. Business KPIs data allows integration of external business data per location. This is the data that will be used to display Business KPIs in the Activity Hub or Today's focus widget of the application. Periods can be: yearly, monthly, weekly, or daily. Salesdata uniqueness is determined by: - store_id - reporting_date - title - category - value_frequency - target In case a new salesdata is created with values for the latter five which already exist in a salesdata, then the salesdata will be updated. Otherwise, a new salesdata entry will be created The category parameter refers to which KPI will use this data point to calculate the value in the app. For example, the 5 predefined KPIs are based on the following categories: - `sales` for the Sales KPI, calculated as the Sum of all sales data in the KPI's frequency - `sales` and `transactions` for the Average Basket KPI, calculated as SUM(sales) / SUM(transactions) in the KPI's frequency - `items` and `transactions` for the UPT KPI, calculated as SUM(items) / SUM(transactions) in the KPI's frequency - `transactions` and `traffic` for the Conversion rate KPI, calculated as SUM(transactions) / SUM(traffic) in the KPI's frequency - `reviews` for the Reviews, calculated as AVG(reviews) in the KPI's frequency - **For Custom KPIs**, the category must match the category defined in the **Business KPI configuration menu**. **Reporting Date** - The `reporting_date` must correspond to the expected calculation period of the KPI. - Example: For daily sales data, push one entry per store each day (e.g., timestamp at store closing time). **Targets** - Define a target with the parameter `target: true`. - The `reporting_date` should correspond to the target's period. - For weekly targets, use the timestamp for the start of the week. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`salesdata_id` | string | | x | | Unique id of the salesdata| |`store_id` | string | | | x | Unique id of the store | |`store_client_id` | string | | | | client_id of the store. Can be used instead of the store_id | |`reporting_date` | date | x | | | Reporting date | |`title` | string | x | | x | The salesdata report title| |`category` | string | x | | x | Salesdata name | |`value` | number | x | | | Salesdata value | |`value_currency` | string | | | | Salesdata currency | |`value_frequency` | string | x | | | The product measuring frequency : yearly / monthly / weekly / daily / hourly | |`target` | boolean | | | | Indicates if the associated value is a target | |`created_date` | date | | x | | Creation date | |`updated_date` | date | | x | x | Last update date | Either store_id or store_client_id can be used. ## Machine-readable artifacts (11) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-business-kpis-data-salesdata-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 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/) - [Yoobic Course Categories API](https://apis.io/apis/yoobic/yoobic-course-categories-api/) ## Tags Business KPIs data - salesdata --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yoobic/.