# Yoobic Custom Model Instances - Datasets API **Canonical:** https://apis.io/apis/yoobic/yoobic-custom-model-instances-datasets-api/ **Provider:** Yoobic — https://apis.io/providers/yoobic/ **Base URL:** https://api.yoobic.com/public/api **Documentation:** https://docs.yoobic.com/api.html Yoobic Custom Model Instances - Datasets 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 Custom Model Instances - Datasets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog. Datasets are where all your data is stored. They have some similarities to spreadsheets, for example they look similar and support some of the same functions and formulas. But, in terms of power, efficiency, and elasticity, datasets tend to behave more like a database. Datasets in Yoobic can used all the different data types available in a Yoobic Campaign. Datasets can be used to: - Display your data dynamically in Yoobic’s missions - Update dynamically your data based on Yoobic’s missions - Filter, sort, summarise, and link data - Preserve data integrity - Trigger automations and run calculation ### Endpoint: Inventory YOOBIC’s dataset collection is stored in the inventory collection therefore we refer to the inventory endpoint to create or update a dataset. ### Custom Model definition A dataset is identified in YOOBIC’s public API by a custom_model_id . We refer to datasets as a Custom Model because each dataset object is customizable (different field type available for each of the fields). Consequently, each row of a dataset (aka Custom_model) is referred to as a custom_model_instances. ### How to create new instances in a dataset Import a csv/excel file containing in the header the name of the field and in the cells the value you want to import. If you are not sure of the format of the csv/excel file, we recommend you to first export your dataset to a csv/excel file and then to use this file as a template for the import. ### How to update existing instances in a dataset Import a csv/excel file containing in the header the name of the field and in the cells the value you want to import. If you wish to update the value, you have to provide in the custom_model_instances_id column the value of the instance you wish to update. It’s a unique identifier generated by YOOBIC. The easiest way to do it is to export the existing dataset, then to modify the value directly in the file and finally to import it into YOOBIC. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |-----------------------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`custom_model_instances_id` | string | | x | | Unique identifier | **Important** The columns of the export/import depend on the inventory's questions. Each `question_id` is a column header. See [`inventory`](#group-inventory) for more details. ## Machine-readable artifacts (11) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-custom-model-instances-datasets-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 Custom Model Instances - Datasets --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yoobic/yoobic-custom-model-instances-datasets-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yoobic/.