All Products
Search
Document Center

OpenSearch:DescribeDataCollction

Last Updated:Mar 03, 2024

Queries the details of a data collection task of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity}

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

my_app_group_name

my_app_group_name
dataCollectionIdentitystringYes

286

286

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

72FAD77B-83F9-F393-BA8E-5834E2427BF8
resultobject

The details of the data collection task.

createdinteger

The time when the data collection task was created.

1581065837
dataCollectionTypestring

The type of the data that is collected by the task. Valid values:

  • behavior: behavioral data
  • item_info: project data
  • industry_specific: industry-specific data
BEHAVIOR
typestring

The type of the data source. Valid values:

  • server

  • web

  • app

    Note: Only server is supported.

server
industryNamestring

The industry to which the data collection task applies. Valid values:

  • general
  • ecommerce
GENERAL
statusinteger

The status of the data collection task. Valid values:

  • 0: disabled
  • 1: being enabled
  • 2: enabled
  • 3: failed to be enabled
2
updatedinteger

The time when the data collection task was updated.

1581065904
namestring

The name of the data collection task.

os_function_test_v1
sundialIdstring

The ID of the sundial.

1755
idstring

The ID of the data collection task.

286

Examples

Sample success responses

JSONformat

{
  "requestId": "72FAD77B-83F9-F393-BA8E-5834E2427BF8",
  "result": {
    "created": 1581065837,
    "dataCollectionType": "BEHAVIOR",
    "type": "server",
    "industryName": "GENERAL",
    "status": 2,
    "updated": 1581065904,
    "name": "os_function_test_v1",
    "sundialId": "1755",
    "id": "286"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history