Yoobic Business KPIs data - salesdata API
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- targetIn 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 createdThe 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.
Yoobic Business KPIs data - salesdata API is one of 41 APIs that Yoobic publishes on the 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.
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 Business KPIs data - salesdata 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.
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 widg…
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 Business KPIs data - salesdata 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.