All Products
Search
Document Center

OpenSearch:DataCollection

Last Updated:Apr 01, 2026

The DataCollection object describes a data collection task in an OpenSearch application.

Example

{
    "id": "286",
    "name": "os_function_test_v1",
    "type": "server",
    "status": 2,
    "dataCollectionType": "BEHAVIOR",
    "industryName": "GENERAL",
    "created": 1581065837,
    "updated": 1581065904,
    "sundialId": "1755"
}

Fields

FieldTypeDescription
idStringThe ID of the data collection task.
nameStringThe name of the data collection task.
typeStringThe data source type. Valid values: server, web, app. Only server is supported.
statusIntegerThe status of the data collection feature. For details, see Status values.
dataCollectionTypeStringThe type of data to collect. Valid values: behavior, item_info, industry-specific.
industryNameStringThe industry type of the application. Valid values: general, ecommerce.
sundialIdStringThe ID of the sundial.
createdIntegerThe time when the data collection task was created.
updatedIntegerThe time when the data collection task was last updated.

Status values

The status field returns one of the following integer codes:

ValueDescription
0Not enabled
1Being enabled
2Enabled
3Failed to enable