Yoobic

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 - 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.

Documentation GitHub OpenAPI

Operations 8

GET /public/api/salesdata/{id} Get #

DELETE /public/api/salesdata/{id} Delete #

PATCH /public/api/salesdata/{id} Partial Update #

GET /public/api/salesdata?filter={filter} Get All #

GET /public/api/salesdata/count?where={where} Count #

POST /public/api/salesdata Create #

GET /public/api/salesdata/export?{filter}&type={type} Export #

POST /public/api/salesdata/import?type={type} Import #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yoobic-business-kpis-data-salesdata-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: YOOBIC Public Business KPIs data - salesdata API
  version: ''
  description: Welcome to the **YOOBIC Public API** documentation.
servers:
- url: https://<base_url>/
tags:
- name: Business KPIs data - salesdata
  description: Business KPIs data allows integration of external business data per location.
paths:
  /public/api/salesdata/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  salesdata_id:
                    type: string
                  store_id:
                    type: string
                  reporting_date:
                    type: string
                  title:
                    type: string
                  category:
                    type: string
                  value:
                    type: number
                  value_currency:
                    type: string
                  value_frequency:
                    type: string
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  salesdata_id: 54ab03c6546847ee0d30086b
                  store_id: 54ab03c6546847ee0d30086c
                  reporting_date: '2018-05-23T04:51:40.862Z'
                  title: Rockets salesdata 1
                  category: Electronics
                  value: 2
                  value_currency: $
                  value_frequency: weekly
                  created_date: '2018-05-23T04:51:40.862Z'
                  updated_date: '2018-05-23T04:51:40.862Z'
              examples:
                response:
                  value:
                    salesdata_id: 54ab03c6546847ee0d30086b
                    store_id: 54ab03c6546847ee0d30086c
                    reporting_date: '2018-05-23T04:51:40.862Z'
                    title: Rockets salesdata 1
                    category: Electronics
                    value: 2
                    value_currency: $
                    value_frequency: weekly
                    created_date: '2018-05-23T04:51:40.862Z'
                    updated_date: '2018-05-23T04:51:40.862Z'
      summary: Get
      operationId: Get
      description: Get a salesdata for the given id.
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: id
        in: path
        description: The id of the salesdata
        required: true
        example: 54ab03c6546847ee0d30086b
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      security:
      - oauth2: []
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
      summary: Delete
      operationId: Delete
      description: Delete a salesdata by id.
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: id
        in: path
        description: The id of the salesdata
        required: true
        example: 54ab03c6546847ee0d30086b
        schema:
          type: string
      security:
      - oauth2: []
    patch:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  salesdata_id:
                    type: string
                  store_id:
                    type: string
                  reporting_date:
                    type: string
                  title:
                    type: string
                  category:
                    type: string
                  value:
                    type: number
                  value_currency:
                    type: string
                  value_frequency:
                    type: string
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  salesdata_id: 54ab03c6546847ee0d30086b
                  store_id: 54ab03c6546847ee0d30086c
                  reporting_date: '2018-05-23T04:51:40.862Z'
                  title: Rockets salesdata 1
                  category: Electronics
                  value: 10
                  value_currency: $
                  value_frequency: yearly
                  created_date: '2018-05-23T04:51:40.862Z'
                  updated_date: '2018-05-23T04:51:40.862Z'
              examples:
                response:
                  value:
                    salesdata_id: 54ab03c6546847ee0d30086b
                    store_id: 54ab03c6546847ee0d30086c
                    reporting_date: '2018-05-23T04:51:40.862Z'
                    title: Rockets salesdata 1
                    category: Electronics
                    value: 10
                    value_currency: $
                    value_frequency: yearly
                    created_date: '2018-05-23T04:51:40.862Z'
                    updated_date: '2018-05-23T04:51:40.862Z'
      summary: Partial Update
      operationId: Partial Update
      description: Update a subset of properties of a salesdata
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: id
        in: path
        description: The id of the salesdata
        required: true
        example: 54ab03c6546847ee0d30086b
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: number
                value_frequency:
                  type: string
              example:
                value: 10
                value_frequency: yearly
      security:
      - oauth2: []
  /public/api/salesdata?filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  paging:
                    type: object
                    properties:
                      total:
                        type: number
                      skip:
                        type: number
                      limit:
                        type: number
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        salesdata_id:
                          type: string
                        store_id:
                          type: string
                        reporting_date:
                          type: string
                        title:
                          type: string
                        category:
                          type: string
                        value:
                          type: number
                        value_currency:
                          type: string
                        value_frequency:
                          type: string
                        created_date:
                          type: string
                        updated_date:
                          type: string
                      required:
                      - salesdata_id
                      - store_id
                      - reporting_date
                      - title
                      - category
                      - value
                      - value_currency
                      - value_frequency
                      - created_date
                      - updated_date
                example:
                  paging:
                    total: 2
                    skip: 0
                    limit: 1000
                  data:
                  - salesdata_id: 54ab03c6546847ee0d30086b
                    store_id: 54ab03c6546847ee0d30086c
                    reporting_date: '2018-05-23T04:51:40.862Z'
                    title: Rockets salesdata 1
                    category: Electronics
                    value: 2
                    value_currency: $
                    value_frequency: weekly
                    created_date: '2018-05-23T04:51:40.862Z'
                    updated_date: '2018-05-23T04:51:40.862Z'
                  - salesdata_id: 54ab03c6546847ee0d30082b
                    store_id: 54ab03c6546847ee0d30086c
                    reporting_date: '2018-05-21T04:51:40.862Z'
                    title: Rockets salesdata 2
                    category: Drinks
                    value: 5.4
                    value_currency: $
                    value_frequency: monthly
                    created_date: '2018-05-21T04:51:40.862Z'
                    updated_date: '2018-05-21T04:51:40.862Z'
              examples:
                response:
                  value:
                    paging:
                      total: 2
                      skip: 0
                      limit: 1000
                    data:
                    - salesdata_id: 54ab03c6546847ee0d30086b
                      store_id: 54ab03c6546847ee0d30086c
                      reporting_date: '2018-05-23T04:51:40.862Z'
                      title: Rockets salesdata 1
                      category: Electronics
                      value: 2
                      value_currency: $
                      value_frequency: weekly
                      created_date: '2018-05-23T04:51:40.862Z'
                      updated_date: '2018-05-23T04:51:40.862Z'
                    - salesdata_id: 54ab03c6546847ee0d30082b
                      store_id: 54ab03c6546847ee0d30086c
                      reporting_date: '2018-05-21T04:51:40.862Z'
                      title: Rockets salesdata 2
                      category: Drinks
                      value: 5.4
                      value_currency: $
                      value_frequency: monthly
                      created_date: '2018-05-21T04:51:40.862Z'
                      updated_date: '2018-05-21T04:51:40.862Z'
      summary: Get All
      operationId: Get All
      description: Get all the salesdata.
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: filter
        in: query
        description: A valid JSON filter object
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/salesdata/count?where={where}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                example:
                  count: 10
              examples:
                response:
                  value:
                    count: 10
      summary: Count
      operationId: Count
      description: Count all the existing entities based on the where filter
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: where
        in: query
        description: A valid JSON [Where filter](#section-api-requests-filter-where)
        required: false
        example: '{ "property": "value" }'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/salesdata:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  salesdata_id:
                    type: string
                  store_id:
                    type: string
                  reporting_date:
                    type: string
                  title:
                    type: string
                  category:
                    type: string
                  value:
                    type: number
                  value_currency:
                    type: string
                  value_frequency:
                    type: string
                  target:
                    type: boolean
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  salesdata_id: 52cb02c6546847ee0d30082b
                  store_id: 54ab03c6546847ee0d30086c
                  reporting_date: '2018-05-21T04:51:40.862Z'
                  title: Weekly Sales Target
                  category: sales
                  value: 100000
                  value_currency: USD
                  value_frequency: weekly
                  target: true
                  created_date: '2018-05-21T04:51:40.862Z'
                  updated_date: '2018-05-21T04:51:40.862Z'
              examples:
                response:
                  value:
                    salesdata_id: 52cb02c6546847ee0d30082b
                    store_id: 54ab03c6546847ee0d30086c
                    reporting_date: '2018-05-21T04:51:40.862Z'
                    title: Weekly Sales Target
                    category: sales
                    value: 100000
                    value_currency: USD
                    value_frequency: weekly
                    target: true
                    created_date: '2018-05-21T04:51:40.862Z'
                    updated_date: '2018-05-21T04:51:40.862Z'
      summary: Create
      operationId: Create
      description: 'You may create a new single salesdata or multiple salesdatas using this action.

        When creating a single salesdata the body contains a json object, when creating multiple salesdata the body contains an array of objects.

        **Warning: a maximum of 1000 items can be sent in a single request.**'
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                store_id:
                  type: string
                reporting_date:
                  type: string
                title:
                  type: string
                category:
                  type: string
                value:
                  type: number
                value_currency:
                  type: string
                value_frequency:
                  type: string
              example:
                store_id: 54ab03c6546847ee0d30086d
                reporting_date: '2018-05-21T04:51:40.862Z'
                title: Milk salesdata 1
                category: Food
                value: 5
                value_currency: $
                value_frequency: hourly
      security:
      - oauth2: []
  /public/api/salesdata/export?{filter}&type={type}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                  priority:
                    type: number
                  nextRunAt:
                    type: string
                  _id:
                    type: string
                example:
                  name: Export file
                  type: normal
                  priority: 0
                  nextRunAt: '2018-09-11T15:56:05.387Z'
                  _id: 5b97e5954b99568b4b9101af
              examples:
                response:
                  value:
                    name: Export file
                    type: normal
                    priority: 0
                    nextRunAt: '2018-09-11T15:56:05.387Z'
                    _id: 5b97e5954b99568b4b9101af
      summary: Export
      operationId: Export
      description: 'Export all results as a file.

        This action is asynchronous and returns the id of a job. See `jobs` endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.'
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: type
        in: path
        description: The type of file, either `csv` (default value) or `excel`
        required: true
        example: csv
        schema:
          type: string
      - name: filter
        in: query
        description: A valid JSON filter object (does not accept a `fields` filter)
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/salesdata/import?type={type}:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                  priority:
                    type: number
                  nextRunAt:
                    type: string
                  _id:
                    type: string
                example:
                  name: Import file
                  type: normal
                  priority: 0
                  nextRunAt: '2018-09-11T15:56:05.387Z'
                  _id: 5b97e5954b99568b4b9101af
              examples:
                response:
                  value:
                    name: Import file
                    type: normal
                    priority: 0
                    nextRunAt: '2018-09-11T15:56:05.387Z'
                    _id: 5b97e5954b99568b4b9101af
      summary: Import
      operationId: Import
      description: 'See the Import file section for more information.


        ### Fields


        | Field | Format | Required | Description |

        |--------------------------|---------|:--------:|-----------------|

        |`salesdata_id` | string | | Unique id of the salesdata |

        |`store_id` | string | | 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 | The salesdata title|

        |`category` | string | x | Salesdata name |

        |`value` | float | x | Salesdata value |

        |`value_currency` | string | | Salesdata currency |

        |`value_frequency` | string | x | The salesdata measuring frequency : yearly / monthly / weekly / daily / hourly |

        |`target` | boolean | | Indicates if the associated value is a target |

        |`created_date` | string | | Creation date |

        |`updated_date` | string | | Last update date |


        Either `store_id` or `store_client_id` can be used.


        The following fields are required:


        - reporting_date


        - title


        - category


        - value_frequency'
      tags:
      - Business KPIs data - salesdata
      parameters:
      - name: type
        in: path
        description: The type of file, either `csv` (default value) or `excel`
        required: true
        example: csv
        schema:
          type: string
      - name: Content-Disposition
        in: header
        description: e.g. form-data; name="file"; filename="file.csv"
        required: false
        example: form-data; name="file"; filename="file.csv"
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/ImportBody'
components:
  requestBodies:
    ImportBody:
      content:
        multipart/form-data, boundary=AaB03x:
          schema:
            type: object
            properties:
              Authorization:
                $ref: '#/components/schemas/Default_Header'
    Get_AllBody:
      content:
        application/json:
          schema:
            type: object
            properties:
              Authorization:
                $ref: '#/components/schemas/Default_Header'
  schemas:
    Default_Header:
      type: object
      required:
      - Authorization
      properties:
        Authorization:
          type: string
          example: Bearer JWT
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /
          tokenUrl: /
          scopes: {}