Sensors Data

Sensors Data Dataset API

The Dataset API from Sensors Data — 7 operation(s) for dataset.

Documentation GitHub OpenAPI

Operations 7

GET /dataset/detail 查询业务模型详情信息 #

POST /dataset/detail_list 获取业务模型列表 #

GET /dataset/group/list 获取业务模型分组列表 #

POST /dataset/table/sql_query 通过 Sql 查询业务模型数据 #

POST /dataset/model/query 通过指标维度规则查询业务模型数据 #

POST /dataset/refresh 刷新指定业务模型数据 #

GET /dataset/sync_task_detail 查询业务模型调度任务执行状态 #

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/sensors-data-dataset-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:
  description: 业务集市的数据查询开放接口
  title: 神策分析 Dataset API
  version: ''
servers:
- url: /api/v3/analytics/v1
tags:
- name: Dataset
paths:
  /dataset/detail:
    get:
      description: 查询业务模型详情信息接口
      operationId: DatasetDetail
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      - description: 业务模型ID
        example: 1
        in: query
        name: dataset_id
        required: true
        schema:
          format: int32
          type: integer
      - description: 业务模型形态，默认值为，如果支持模型态则默认为模型态，否则为二维表形态
        in: query
        name: model_type
        schema:
          enum:
          - DATASET_MODEL_TYPE_UNSPECIFIED
          - DATASET_MODEL_TYPE_MODEL
          - DATASET_MODEL_TYPE_TABLE
          type: string
          x-sd-openapi-enum-type: com.sensorsdata.analytics.v1.DatasetModelType
        x-sd-openapi-enum-type: com.sensorsdata.analytics.v1.DatasetModelType
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  dataset_type: CUSTOME_SQL_QUERY
                  scheduler_status: PROCESSING_BY_HOUR
                  sync_type: FULL
                  columns:
                  - column_name: country
                    column_cname: 国家
                    data_type: STRING
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: citry
                    column_cname: 城市
                    data_type: STRING
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: measure_number
                    column_cname: 指标名称
                    data_type: NUMBER
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: calculate_measure_number
                    column_cname: 计算列1
                    data_type: NUMBER
                    column_type: CALCULATE
                    column_usage_type: MEASURE
                  dataset_id: 1
                  permission_info:
                    creator_eui_filter_snapshot:
                      event_permission_filter:
                        filters:
                        - conditions:
                          - field: event.$Anything.country
                            function: notContain
                            params:
                            - 韩国
                            - 日本
                          - field: event.$Anything.city
                            function: rlike
                            params:
                            - .*
                          relation: AND
                        conditions:
                        - field: event.$Anything.country
                          function: equal
                          params:
                          - 中国
                        - field: event.$Anything.city
                          function: contain
                          params:
                          - 北京
                        relation: OR
                  manager_permission_config:
                    owner_info: {}
                    co_manager_info:
                      roles:
                      - {}
                      duties:
                      - {}
                  dataset_storage_type: TABLE
                  time_unit: DAY
                  dataset_cname: 业务模型显示名
                  sync_status: SUCCESS
                  last_sync_success_time: '2023-01-01 00:00:00'
                  sync_crontab: '["0 0 4 * * ?"]'
                  data_range_time: {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetDetailResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetDetailResponse
      summary: 查询业务模型详情信息
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetDetailResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DatasetDetailRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dataset
  /dataset/detail_list:
    post:
      description: 获取业务模型列表
      operationId: DatasetDataList
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetListRequest'
        description: 请求业务模型详情接口的参数描述
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  page_info:
                    current_page: 1
                    page_count: 1
                    total: 2
                  datasets:
                  - dataset_type: CUSTOME_SQL_QUERY
                    dataset_id: 1
                    dataset_cname: 业务模型显示名
                    is_scheduler_pause: false
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetListResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetListResponse
      summary: 获取业务模型列表
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetListResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DatasetListRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: DatasetListRequest
      tags:
      - Dataset
  /dataset/group/list:
    get:
      description: 获取业务模型分组列表接口
      operationId: DatasetGroupList
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  dataset_groups:
                  - group_name: 分组名称
                    id: 1
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetGroupListResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetGroupListResponse
      summary: 获取业务模型分组列表
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetGroupListResponse
        isServerStreaming: false
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dataset
  /dataset/table/sql_query:
    post:
      description: Sql 查询二维表模式下的业务模型数据接口,包含实时 sql, 不支持拼表业务模型查询
      operationId: DatasetTableSqlQuery
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetTableSqlRequest'
        description: sql查询业务模型数据接口请求参数描述
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  data:
                  - - 中国
                    - 北京市
                    - 100
                  - - 中国
                    - 天津市
                    - 200.0
                  columns:
                  - column_name: country
                    column_cname: 国家
                    data_type: STRING
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: citry
                    column_cname: 城市
                    data_type: STRING
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: measure_number
                    column_cname: 指标名称
                    data_type: NUMBER
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: calculate_measure_number
                    column_cname: 计算列1
                    data_type: NUMBER
                    column_type: CALCULATE
                    column_usage_type: MEASURE
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetTableSqlResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetTableSqlResponse
      summary: 通过 Sql 查询业务模型数据
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetTableSqlResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DatasetTableSqlRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: DatasetTableSqlRequest
      tags:
      - Dataset
  /dataset/model/query:
    post:
      description: 查询二维表，预聚合，明细模式等的业务模型数据接口，其中二维表中不支持拼表查询
      operationId: DatasetModelQuery
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetModelRequest'
        description: 业务模型数据接口请求描述
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  data:
                  - - 中国
                    - 北京市
                    - 100
                  - - 中国
                    - 天津市
                    - 200.0
                  columns:
                  - column_name: country
                    column_cname: 国家
                    data_type: STRING
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: citry
                    column_cname: 城市
                    data_type: STRING
                    column_type: BASIC
                    column_usage_type: ALL
                  - column_name: measure_number
                    column_cname: 指标名称
                    data_type: NUMBER
                    column_type: BASIC
                    column_usage_type: ALL
                  page_info:
                    current_page: 1
                    page_count: 1
                    total: 2
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetModelResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetModelResponse
      summary: 通过指标维度规则查询业务模型数据
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetModelResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DatasetModelRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: DatasetModelRequest
      tags:
      - Dataset
  /dataset/refresh:
    post:
      description: 刷新业务模型接口, 其中不支持拼表，外部数据表和实时的业务模型刷新
      operationId: DatasetRefresh
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetRefreshRequest'
        description: 刷新业务模型接口请求参数描述 , 不支持拼表，外部数据表和实时业务模型刷新
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  sync_task_id: 1
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetRefreshResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetRefreshResponse
      summary: 刷新指定业务模型数据
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetRefreshResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DatasetRefreshRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: DatasetRefreshRequest
      tags:
      - Dataset
  /dataset/sync_task_detail:
    get:
      description: 查询业务模型调度任务执行状态
      operationId: DatasetSyncTaskDetail
      parameters:
      - description: 全局唯一的密钥，用于验证和授权访问 API 接口
        in: header
        name: api-key
        required: true
        schema:
          type: string
      - description: 项目名, 指定请求所属项目
        in: header
        name: sensorsdata-project
        required: true
        schema:
          type: string
      - description: 同步任务ID
        example: 1
        in: query
        name: sync_task_id
        required: true
        schema:
          format: int32
          type: integer
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  duration_seconds: 10
                  start_time: '2023-01-01 12:00:00'
                  end_time: '2023-01-01 12:00:10'
                  sync_status: SUCCESS
                  sync_task_id: 1
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetSyncTaskDetailResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DatasetSyncTaskDetailResponse
      summary: 查询业务模型调度任务执行状态
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DatasetSyncTaskDetailResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DatasetSyncTaskDetailRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DatasetServiceGrpc.DatasetServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dataset
components:
  schemas:
    sensorsdata.analytics.v1.ApiRequestFilter:
      description: ''
      properties:
        relation:
          description: ''
          enum:
          - FILTER_RELATION_UNSPECIFIED
          - AND
          - OR
          example: OR
          type: string
        conditions:
          description: ''
          example: '[{"field":"event.$Anything.country","function":"equal","params":["中国"]},{"field":"event.$Anything.city","function":"contain","params":["北京"]}]'
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.ApiRequestElementCondition'
          type: array
        filters:
          description: ''
          example: '[{"conditions":[{"field":"event.$Anything.country","function":"notContain","params":["韩国","日本"]},{"field":"event.$Anything.city","function":"rlike","params":[".*"]}],"relation":"AND"}]'
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.ApiRequestFilter'
          type: array
      title: ApiRequestFilter
      type: object
    sensorsdata.analytics.v1.DatasetGroupListResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetGroupListResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.DatasetGroupListResponseHttpApiResult
      type: object
    sensorsdata.analytics.v1.ApiRequestElementCondition:
      description: ''
      properties:
        field:
          description: ''
          type: string
        function:
          description: ''
          type: string
        params:
          description: ''
          items:
            description: google.protobuf.Value 支持各种 JSON 值
            properties: {}
            type: object
          type: array
      title: ApiRequestElementCondition
      type: object
    sensorsdata.analytics.v1.ApiRequestPermissionFilter:
      description: ''
      properties:
        event_permission_filter:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.ApiRequestFilter'
        user_permission_filter:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.ApiRequestFilter'
      title: ApiRequestPermissionFilter
      type: object
    sensorsdata.analytics.v1.ColumnMeta:
      description: 字段元数据信息
      properties:
        column_name:
          description: 字段名
          type: string
        column_cname:
          description: 字段显示名
          type: string
        data_type:
          description: 字段数据类型
          enum:
          - DATA_TYPE_UNSPECIFIED
          - STRING
          - DATETIME
          - BOOL
          - NUMBER
          type: string
        column_type:
          description: "字段分类\n - COLUMN_TYPE_UNSPECIFIED 未知\n - CALCULATE 计算列\n - BASIC 普通列"
          enum:
          - COLUMN_TYPE_UNSPECIFIED
          - CALCULATE
          - BASIC
          type: string
        column_usage_type:
          description: "字段业务使用类型\n - COLUMN_USAGE_TYPE_UNSPECIFIED\n - MEASURE 指标\n - DIMENSION 维度\n - ALL 全部，可以是维度也可以是指标"
          enum:
          - COLUMN_USAGE_TYPE_UNSPECIFIED
          - MEASURE
          - DIMENSION
          - ALL
          type: string
        origin_column_name:
          description: 分析模型的原始字段名称
          type: string
        sort_num:
          description: 分析模型里指标/维度的顺序值
          format: int32
          type: integer
        origin_data_type:
          description: 分析模型里原始数据类型
          enum:
          - DATA_TYPE_UNSPECIFIED
          - STRING
          - DATETIME
          - BOOL
          - NUMBER
          type: string
        is_system_time:
          description: 是否是预置时间字段
          type: boolean
      title: ColumnMeta
      type: object
    sensorsdata.analytics.v1.Measure:
      description: 指标对象信息
      properties:
        column_name:
          description: 指标名称
          type: string
        aggregation:
          description: "聚合方式，非必传，计算列或者明细和预聚合模式的指标都不需要指定聚合方式\n - AGGREGATION_UNSPECIFIED 未知\n - AVG 平均数\n - COUNT 计数\n - MAX 最大值\n - MIN 最小值\n - UNIQ_COUNT 去重计数\n - APPX_MEDIAN 中位数\n - STDDEV_POP 标准差\n - VAR_POP 方差\n - SUM 求和"
          enum:
          - AGGREGATION_UNSPECIFIED
          - AVG
          - COUNT
          - MAX
          - MIN
          - UNIQ_COUNT
          - APPX_MEDIAN
          - STDDEV_POP
          - VAR_POP
          - SUM
          type: string
        measure_filter:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.MeasureFilter'
      title: Measure
      type: object
    sensorsdata.analytics.v1.DatasetDetailResponse:
      description: 请求业务模型详情接口的返回结构描述
      properties:
        dataset_id:
          description: 业务模型ID
          example: 1
          format: int32
          type: integer
        dataset_type:
          description: "业务模型类型\n - DATASET_TYPE_UNSPECIFIED 未知\n - CUSTOME_SQL_QUERY 自定义查询\n - ANALYSIS_MODEL_SEGMENTATION 事件分析;\n - ANALYSIS_MODEL_RETENTION 留存分析\n - ANALYSIS_MODEL_FUNNEL 漏斗分析\n - ANALYSIS_MODEL_SESSION session分析\n - ANALYSIS_MODEL_FANCY_METRIC 自定义业务分析\n - ANALYSIS_MODEL_SEGMENTATION_TABLE 事件分析结果表\n - ANALYSIS_MODEL_RETENTION_TABLE 留存分析结果表\n - ANALYSIS_MODEL_FUNNEL_TABLE 漏斗分析结果表\n - ANALYSIS_MODEL_SESSION_TABLE session分析结果表\n - EXTERNAL_TABLE 数据外部表\n - ALYSIS_MODEL_ADDICTION 分布分析\n - ANALYSIS_MODEL_INTERVAL 间隔分析\n - ANALYSIS_MODEL_LTV ltv分析\n - ANALYSIS_MODEL_ATTRIBUTE 属性分析\n - JOIN_TABLE 拼表类型"
          enum:
          - DATASET_TYPE_UNSPECIFIED
          - CUSTOME_SQL_QUERY
          - ANALYSIS_MODEL_SEGMENTATION
          - ANALYSIS_MODEL_RETENTION
          - ANALYSIS_MODEL_FUNNEL
          - ANALYSIS_MODEL_FANCY_METRIC
          - ANALYSIS_MODEL_SEGMENTATION_TABLE
          - ANALYSIS_MODEL_RETENTION_TABLE
          - ANALYSIS_MODEL_FUNNEL_TABLE
          - ANALYSIS_MODEL_SESSION_TABLE
          - EXTERNAL_TABLE
          - ALYSIS_MODEL_ADDICTION
          - ANALYSIS_MODEL_INTERVAL
          - ANALYSIS_MODEL_LTV
          - ANALYSIS_MODEL_ATTRIBUTE
          - JOIN_TABLE
          - ANALYSIS_MODEL_SESSION
          - ANALYSIS_PERSONAS_GROUP
          - ANALYSIS_MODEL_ATTRIBUTION
          - UNION_TABLE
          - DIMENSION_JOIN_MODEL
          example: CUSTOME_SQL_QUERY
          type: string
        dataset_storage_type:
          description: "业务模型存储类型\n - DATASET_STORAGE_TYPE_UNSPECIFIED 未知\n - ANALYSIS_DETAIL 明细模式\n - ANALYSIS_ROLLUP 合计模式\n - PRE_AGG 预聚合模式\n - TABLE 二维表模式"
          enum:
          - DATASET_STORAGE_TYPE_UNSPECIFIED
          - ANALYSIS_DETAIL
          - ANALYSIS_ROLLUP
          - PRE_AGG
          - TABLE
          example: TABLE
          type: string
        dataset_cname:
          description: 业务模型显示名
          example: 业务模型显示名
          type: string
        columns:
          description: 业务模型维度和指标字段列表
          example: '[{"column_name":"country","column_cname":"国家","data_type":"STRING","column_type":"BASIC","column_usage_type":"ALL"},{"column_name":"citry","column_cname":"城市","data_type":"STRING","column_type":"BASIC","column_usage_type":"ALL"},{"column_name":"measure_number","column_cname":"指标名称","data_type":"NUMBER","column_type":"BASIC","column_usage_type":"ALL"},{"column_name":"calculate_measure_number","column_cname":"计算列1","data_type":"NUMBER","column_type":"CALCULATE","column_usage_type":"MEASURE"}]'
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.ColumnMeta'
          type: array
        last_sync_success_time:
          description: 最近一次成功更新时间
          example: '2023-01-01 00:00:00'
          type: string
        sync_status:
          description: "更新状态\n - WAITING 待更新\n - SUCCESS 成功\n - FAILED 失败\n - DOING 更新中\n - DATA_EXCEPTION 数据异常\n - REFRESH_WAITING 回刷等待中\n - RETRY 失败重试"
          enum:
          - SYNC_STATUS_UNSPECIFIED
          - WAITING
          - SUCCESS
          - FAILED
          - DOING
          - DATA_EXCEPTION
          - REFRESH_WAITING
          - RETRY
          example: SUCCESS
          type: string
        scheduler_status:
          description: "业务模型调度类型\n - MANUALLY 手动\n - NOT_START 未开始（调度时间在未来时间）\n - PROCESSING_BY_HOUR  按小时\n - PROCESSING_BY_DAY  按天\n - PROCESSING_BY_WEEK 按周\n - PROCESSING_BY_MONTH  按月\n - FINISH 正常结束\n - ABNORMAL_FINISH  异常结束\n - SCHEDULER_REALTIME 实时\n - NONE 无需调度\n - SCHEDULER_LIVE_AGGREGATION 实时聚合更新"
          enum:
          - SCHEDULER_STATUS_UNSPECIFIED
          - MANUALLY
          - NOT_START
          - PROCESSING_BY_HOUR
          - PROCESSING_BY_DAY
          - PROCESSING_BY_WEEK
          - PROCESSING_BY_MONTH
          - FINISH
          - ABNORMAL_FINISH
          - REALTIME
          - NONE
          - LIVE_AGGREGATION
          example: PROCESSING_BY_HOUR
          type: string
        sync_crontab:
          description: 同步表达式
          example: '["0 0 4 * * ?"]'
          type: string
        sync_type:
          description: "同步方式\n - SYNC_TYPE_UNSPECIFIED 未知\n - FULL 全量\n - INCREMENTAL 增量"
          enum:
          - SYNC_TYPE_UNSPECIFIED
          - FULL
          - INCREMENTAL
          example: FULL
          type: string
        permission_info:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.PermissionInfo'
        manager_permission_config:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.ManagerPermissionConfig'
        update_time:
          description: 最后编辑时间
          type: string
        description:
          description: 备注信息
          type: string
        analysis_request_json:
          description: 分析模型的请求条件
          type: string
        time_unit:
          description: 查看的时间粒度，可以是，MINUTE 分钟，HOUR：按小时，DAY：按天，WEEK：按周，MONTH：按月，YEAR：按年
          enum:
          - UNIT_TYPE_UNSPECIFIED
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - YEAR
          - QUARTER
          - MINUTE
          - SECOND
          example: DAY
          type: string
        data_range_time:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetTimeRange'
        real_data_range_times:
          description: 实际数据范围，是调度过且成功的时间范围，不代表一定有数据
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetTimeRange'
          type: array
      title: DatasetDetailResponse
      type: object
    sensorsdata.analytics.v1.DatasetResponse:
      description: 列表里单个业务模型信息
      properties:
        dataset_id:
          description: 业务模型ID
          example: 1
          format: int32
          type: integer
        dataset_type:
          description: "业务模型来源类型\n - DATASET_TYPE_UNSPECIFIED 未知\n - CUSTOME_SQL_QUERY 自定义查询\n - ANALYSIS_MODEL_SEGMENTATION 事件分析;\n - ANALYSIS_MODEL_RETENTION 留存分析\n - ANALYSIS_MODEL_FUNNEL 漏斗分析\n - ANALYSIS_MODEL_FANCY_METRIC 自定义业务分析\n - ANALYSIS_MODEL_SEGMENTATION_TABLE 事件分析结果表\n - ANALYSIS_MODEL_RETENTION_TABLE 留存分析结果表\n - ANALYSIS_MODEL_FUNNEL_TABLE 漏斗分析结果表\n - ANALYSIS_MODEL_SESSION_TABLE session分析结果表\n - EXTERNAL_TABLE 数据外部表"
          enum:
          - DATASET_TYPE_UNSPECIFIED
          - CUSTOME_SQL_QUERY
          - ANALYSIS_MODEL_SEGMENTATION
          - ANALYSIS_MODEL_RETENTION
          - ANALYSIS_MODEL_FUNNEL
          - ANALYSIS_MODEL_FANCY_METRIC
          - ANALYSIS_MODEL_SEGMENTATION_TABLE
          - ANALYSIS_MODEL_RETENTION_TABLE
          - ANALYSIS_MODEL_FUNNEL_TABLE
          - ANALYSIS_MODEL_SESSION_TABLE
          - EXTERNAL_TABLE
          - ALYSIS_MODEL_ADDICTION
          - ANALYSIS_MODEL_INTERVAL
          - ANALYSIS_MODEL_LTV
          - ANALYSIS_MODEL_ATTRIBUTE
          - JOIN_TABLE
          - ANALYSIS_MODEL_SESSION
          - ANALYSIS_PERSONAS_GROUP
          - ANALYSIS_MODEL_ATTRIBUTION
          - UNION_TABLE
          - DIMENSION_JOIN_MODEL
          example: CUSTOME_SQL_QUERY
          type: string
        dataset_cname:
          description: 业务模型显示名
          example: 业务模型显示名
          type: string
        is_scheduler_pause:
          description: 是否为调度暂停状态
          example: false
          type: boolean
      title: DatasetResponse
      type: object
    sensorsdata.analytics.v1.QueryParameter:
      description: "参数对象\n 特定参数：\n - ${limit} （业务模型数据量超过1000w的情况下必须设置）分页\n 用户可以自定义设置动态参数"
      properties:
        param_key:
          description: 参数
          type: string
        param_value:
          description: 参数值
          type: string
      title: QueryParameter
      type: object
    sensorsdata.analytics.v1.AccountInfo:
      description: ''
      properties:
        id:
          description: 账户ID
          format: int32
          type: integer
        cname:
          description: 用户名称
          type: string
      title: AccountInfo
      type: object
    sensorsdata.common.ErrorInfo:
      properties:
        code:
          description: 具体的错误码
          example: XX-D-F-2-1
          type: string
        description:
          description: 错误描述
          example: 前端参数校验异常,PARAMETER_FORMAT_ERROR(quantiles=[10, -90] is not include [0, 100])
          type: string
        system_response:
          description: 致错的可能原因列表
          example: 系统终止了查询处理
          type: string
        error_causes:
          items:
            $ref: '#/components/schemas/sensorsdata.common.ErrorCause'
          type: array
        context:
          $ref: '#/components/schemas/sensorsdata.common.ErrorContext'
      title: ErrorInfo
      type: object
    sensorsdata.analytics.v1.DatasetRefreshResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.DatasetRefreshResponse'
        error_inf

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sensors-data/refs/heads/main/openapi/sensors-data-dataset-api-openapi.yml