Sensors Data Dashboard API

openapi: 3.2.0
info:
  description: 概览书签开放接口
  title: 神策分析 Dashboard API
  version: ''
servers:
- url: /api/v3/analytics/v1
tags:
- name: Dashboard
paths:
  /dashboard/navigation:
    get:
      description: 获取所有的概览分组信息
      operationId: QueryDashboardNavigation
      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: 概览类型
        example: PRIVATE
        in: query
        name: type
        schema:
          enum:
          - DASHBOARD_TYPE_UNSPECIFIED
          - PRIVATE
          - PUBLIC
          type: string
          x-sd-openapi-enum-type: com.sensorsdata.analytics.v1.DashboardType
        x-sd-openapi-enum-type: com.sensorsdata.analytics.v1.DashboardType
      - description: 本次请求 ID, 方便后续追踪问题
        example: '12345696321548954'
        in: query
        name: request_id
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  dashboard_navigation_items:
                  - edit_permission: true
                    create_time: '2022-10-08 14:53:09'
                    user_id: 205
                    project_id: 1
                    user_name: 平台管理员
                    name: 数据概览
                    is_public: true
                    id: 101
                    type: 1
                    user_canme: 平台管理员
                  groups:
                  - id: '666666'
                    title: 数据概览
                    dashboards:
                    - 101
                    - 102
                  type: PRIVATE
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DashboardNavigationResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DashboardNavigationResponse
      summary: 获取所有的概览分组信息
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DashboardNavigationResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DashboardsRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dashboard
  /dashboard/lego:
    get:
      description: 获取所有基础数据概览数据
      operationId: QueryLegoDashboard
      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:
                  lego_dashboard_items:
                  - name: '"实时统计"'
                    navigation_name: '"整体概览"'
                    source_type: '"WEB"'
                    id: 1
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.LegoDashboardResponseHttpApiResult'
          description: sensorsdata.analytics.v1.LegoDashboardResponse
      summary: 获取所有基础数据概览数据
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.LegoDashboardResponse
        isServerStreaming: false
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dashboard
  /dashboard/detail:
    get:
      description: 获取单个概览详情
      operationId: QueryDashboard
      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: id
        schema:
          format: int32
          type: integer
      - description: 本次请求 ID, 方便后续追踪问题
        example: '12345696321548954'
        in: query
        name: request_id
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  create_time: '2022-10-08 14:53:09'
                  user_id: 205
                  project_id: 1
                  contain_bookmark_items:
                  - mode: 0
                    data: '"{\"measures\":[{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"iOS 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"iOS\"],\"$$render_index\":0}]},\"editName\":\"iOS 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"Android 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"Android\"],\"$$render_index\":0}]},\"editName\":\"Android 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"python 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"python\"],\"$$render_index\":0}]},\"editName\":\"python 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"小程序显示的总次数\"}],\"from_date\":\"2022-10-01\",\"to_date\":\"2022-10-07\",\"unit\":\"day\",\"by_fields\":[],\"detail_and_rollup\":true,\"enable_detail_follow_rollup_by_values_rank\":true,\"sub_task_type\":\"SEGMENTATION\",\"time_zone_mode\":\"\",\"server_time_zone\":\"\",\"compareKey\":\"\"}"'
                    create_time: '2022-10-08 14:53:09'
                    user_id: 1
                    project_id: 1
                    name: '"事件分析"'
                    id: 1
                    type: '"/segmentation/"'
                    config: '"{\"chartsType\":\"line\",\"byFieldsCname\":[],\"byFieldsDataType\":[],\"byValuesFilter\":[],\"byFields\":null,\"measureIndexs\":[0,1,2,3],\"comment\":\"\",\"topN\":0,\"valueTypes\":\"number\"}"'
                    dashboards:
                    - 11
                    - 23
                    - 44
                    is_lego: false
                  user_name: 平台管理员
                  name: 数据概览
                  is_public: true
                  id: 101
                  type: PRIVATE
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.DashboardDetailResponseHttpApiResult'
          description: sensorsdata.analytics.v1.DashboardDetailResponse
      summary: 获取单个概览详情
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.DashboardDetailResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.DashboardRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dashboard
  /dashboard/navigation/create:
    post:
      description: 添加概览分组信息
      operationId: AddDashboardNavigation
      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.AddDashboardRequest'
        description: 添加概览分组信息接口请求参数描述
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  flag: true
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.CommonResponseHttpApiResult'
          description: sensorsdata.analytics.v1.CommonResponse
      summary: 添加概览分组信息
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.CommonResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.AddDashboardRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: AddDashboardRequest
      tags:
      - Dashboard
  /dashboard/share:
    post:
      description: 概览分享接口，可以实现分享和取消概览分享的能力
      operationId: ShareDashboard
      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.ShareDashboardRequest'
        description: 概览分享（取消分享）接口请求参数描述
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  flag: true
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.CommonResponseHttpApiResult'
          description: sensorsdata.analytics.v1.CommonResponse
      summary: 概览分享接口
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.CommonResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.ShareDashboardRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: ShareDashboardRequest
      tags:
      - Dashboard
  /dashboard/bookmarks:
    get:
      description: 获取所有的书签信息
      operationId: QueryAllBookmarks
      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: 书签类型，0 私有书签，1 公共书签
        example: 1
        in: query
        name: type
        schema:
          format: int32
          type: integer
      - description: 是否包含组件类型的书签
        example: 'true'
        in: query
        name: has_widget
        schema:
          type: string
      - description: 是否包含 lego 类型的书签
        example: 'true'
        in: query
        name: has_lego
        schema:
          type: string
      - description: 本次请求 ID, 方便后续追踪问题
        example: '12345696321548954'
        in: query
        name: request_id
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  bookmarks:
                  - id: 1
                    user_id: 2
                    type: /segmentation/
                    name: 事件分析
                    user_cname: 平台管理员
                    data: '{"measures":[{"event_name":"$MPShow","aggregator":"general","name":"iOS 小程序显示的总次数","filter":{"conditions":[{"field":"event.$Anything.$lib","function":"equal","params":["iOS"],"$$render_index":0}]},"editName":"iOS 小程序显示的总次数"},{"event_name":"$MPShow","aggregator":"general","name":"Android 小程序显示的总次数","filter":{"conditions":[{"field":"event.$Anything.$lib","function":"equal","params":["Android"],"$$render_index":0}]},"editName":"Android 小程序显示的总次数"},{"event_name":"$MPShow","aggregator":"general","name":"python 小程序显示的总次数","filter":{"conditions":[{"field":"event.$Anything.$lib","function":"equal","params":["python"],"$$render_index":0}]},"editName":"python 小程序显示的总次数"},{"event_name":"$MPShow","aggregator":"general","name":"小程序显示的总次数"}],"from_date":"2022-10-01","to_date":"2022-10-07","unit":"day","by_fields":[],"detail_and_rollup":true,"enable_detail_follow_rollup_by_values_rank":true,"sub_task_type":"SEGMENTATION","time_zone_mode":"","server_time_zone":"","compareKey":""}'
                    time: ''
                    create_time: '2022-10-08 14:53:09'
                    related_events: []
                    project_id: 2
                    config: '{"chartsType":"line","byFieldsCname":[],"byFieldsDataType":[],"byValuesFilter":[],"byFields":null,"measureIndexs":[0,1,2,3],"comment":"","topN":0,"valueTypes":"number"}'
                    lego_type: 0
                    mode: 0
                    dashboards:
                    - id: 1
                      name: 事件分析概览
                  total: 1
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.BookmarksResponseHttpApiResult'
          description: sensorsdata.analytics.v1.BookmarksResponse
      summary: 获取所有的书签信息
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.BookmarksResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.AllBookmarksRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      tags:
      - Dashboard
  /dashboard/create:
    post:
      description: 创建概览
      operationId: CreateDashboard
      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.CreateDashboardRequest'
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  group_id: 666666
                  bookmark_count: 5
                  id: 101
                  dashboard:
                    create_time: '2022-10-08 14:53:09'
                    user_id: 205
                    project_id: 1
                    contain_bookmark_items:
                    - mode: 0
                      data: '"{\"measures\":[{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"iOS 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"iOS\"],\"$$render_index\":0}]},\"editName\":\"iOS 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"Android 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"Android\"],\"$$render_index\":0}]},\"editName\":\"Android 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"python 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"python\"],\"$$render_index\":0}]},\"editName\":\"python 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"小程序显示的总次数\"}],\"from_date\":\"2022-10-01\",\"to_date\":\"2022-10-07\",\"unit\":\"day\",\"by_fields\":[],\"detail_and_rollup\":true,\"enable_detail_follow_rollup_by_values_rank\":true,\"sub_task_type\":\"SEGMENTATION\",\"time_zone_mode\":\"\",\"server_time_zone\":\"\",\"compareKey\":\"\"}"'
                      create_time: '2022-10-08 14:53:09'
                      user_id: 1
                      project_id: 1
                      name: '"事件分析"'
                      id: 1
                      type: '"/segmentation/"'
                      config: '"{\"chartsType\":\"line\",\"byFieldsCname\":[],\"byFieldsDataType\":[],\"byValuesFilter\":[],\"byFields\":null,\"measureIndexs\":[0,1,2,3],\"comment\":\"\",\"topN\":0,\"valueTypes\":\"number\"}"'
                      dashboards:
                      - 11
                      - 23
                      - 44
                      is_lego: false
                    user_name: 平台管理员
                    name: 数据概览
                    is_public: true
                    id: 101
                    type: PRIVATE
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.CreateDashboardResponseHttpApiResult'
          description: sensorsdata.analytics.v1.CreateDashboardResponse
      summary: 创建概览
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.CreateDashboardResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.CreateDashboardRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: CreateDashboardRequest
      tags:
      - Dashboard
  /dashboard/bookmarks/add:
    post:
      description: 向已有概览批量追加书签草稿
      operationId: AddBookmarksToDashboard
      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.AddBookmarksToDashboardRequest'
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  bookmark_count: 5
                  dashboard:
                    create_time: '2022-10-08 14:53:09'
                    user_id: 205
                    project_id: 1
                    contain_bookmark_items:
                    - mode: 0
                      data: '"{\"measures\":[{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"iOS 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"iOS\"],\"$$render_index\":0}]},\"editName\":\"iOS 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"Android 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"Android\"],\"$$render_index\":0}]},\"editName\":\"Android 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"python 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"python\"],\"$$render_index\":0}]},\"editName\":\"python 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"小程序显示的总次数\"}],\"from_date\":\"2022-10-01\",\"to_date\":\"2022-10-07\",\"unit\":\"day\",\"by_fields\":[],\"detail_and_rollup\":true,\"enable_detail_follow_rollup_by_values_rank\":true,\"sub_task_type\":\"SEGMENTATION\",\"time_zone_mode\":\"\",\"server_time_zone\":\"\",\"compareKey\":\"\"}"'
                      create_time: '2022-10-08 14:53:09'
                      user_id: 1
                      project_id: 1
                      name: '"事件分析"'
                      id: 1
                      type: '"/segmentation/"'
                      config: '"{\"chartsType\":\"line\",\"byFieldsCname\":[],\"byFieldsDataType\":[],\"byValuesFilter\":[],\"byFields\":null,\"measureIndexs\":[0,1,2,3],\"comment\":\"\",\"topN\":0,\"valueTypes\":\"number\"}"'
                      dashboards:
                      - 11
                      - 23
                      - 44
                      is_lego: false
                    user_name: 平台管理员
                    name: 数据概览
                    is_public: true
                    id: 101
                    type: PRIVATE
                  dashboard_id: 101
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.AddBookmarksToDashboardResponseHttpApiResult'
          description: sensorsdata.analytics.v1.AddBookmarksToDashboardResponse
      summary: 向已有概览批量追加书签草稿
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.AddBookmarksToDashboardResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.AddBookmarksToDashboardRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: AddBookmarksToDashboardRequest
      tags:
      - Dashboard
  /dashboard/update:
    post:
      description: 全量更新概览及其包含的书签
      operationId: UpdateDashboard
      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.UpdateDashboardRequest'
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data: {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.common.HttpApiResult'
          description: ''
      summary: 全量更新概览及其包含的书签
      x-sd-openapi:
        responseClass: com.google.protobuf.Empty
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.UpdateDashboardRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.DashboardServiceGrpc.DashboardServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: UpdateDashboardRequest
      tags:
      - Dashboard
components:
  schemas:
    sensorsdata.analytics.v1.DashboardGroup:
      description: ''
      properties:
        id:
          description: 概览分组ID
          example: 5
          format: int64
          type: integer
        title:
          description: 概览分组标题
          example: 数据概览
          type: string
        dashboards:
          description: 概览集合
          example: '[101,102]'
          items:
            format: int32
            type: integer
          type: array
      title: DashboardGroup
      type: object
    sensorsdata.analytics.v1.DashboardOwner:
      description: ''
      properties:
        id:
          description: 分享给的用户/角色/职位 ID
          example: 5
          format: int32
          type: integer
        type:
          description: 分享的主体类, 按账号：ACCOUNT，按角色：ROLE，按职务： DUTY
          enum:
          - DASHBOARD_SHARE_TYPE_UNSPECIFIED
          - ACCOUNT
          - ROLE
          - DUTY
          example: ACCOUNT
          type: string
      title: DashboardOwner
      type: object
    sensorsdata.analytics.v1.AddBookmarksToDashboardResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.AddBookmarksToDashboardResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.AddBookmarksToDashboardResponseHttpApiResult
      type: object
    sensorsdata.analytics.v1.AddBookmarksToDashboardResponse:
      description: ''
      properties:
        dashboard_id:
          description: 目标概览 ID
          example: 101
          format: int32
          type: integer
        dashboard:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.DashboardDetailResponse'
        bookmark_count:
          description: 当前概览书签总数
          example: 5
          format: int32
          type: integer
      title: AddBookmarksToDashboardResponse
      type: object
    sensorsdata.analytics.v1.ShareDashboardRequest:
      description: 概览分享（取消分享）接口请求参数描述
      properties:
        dashboard_ids:
          description: 概览集合
          example: '[101,102]'
          items:
            format: int32
            type: integer
          type: array
        owners:
          description: 分享人列表
          example: '[{"id":5,"type":"ROLE"},{"id":32,"type":"ROLE"}]'
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.DashboardOwner'
          type: array
        publish:
          description: 是否分享
          example: true
          type: boolean
        request_id:
          description: 本次请求 ID, 方便后续追踪问题
          example: '12345696321548954'
          type: string
      title: ShareDashboardRequest
      type: object
    sensorsdata.analytics.v1.CreateDashboardRequest:
      description: ''
      properties:
        type:
          description: 概览类型
          enum:
          - DASHBOARD_TYPE_UNSPECIFIED
          - PRIVATE
          - PUBLIC
          example: PRIVATE
          type: string
        name:
          description: 概览名称
          example: 事件分析概览
          type: string
        config:
          description: 概览配置
          type: string
        bookmarks:
          description: 书签列表，全量替换当前概览项，顺序即最终顺序
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.SaveBookmarkPayload'
          type: array
        request_id:
          description: 本次请求 ID, 方便后续追踪问题
          example: 93bcf68b74e6498aae888d794e776717
          type: string
        group_id:
          description: 目标概览分组 ID；不传时默认加入数据概览分组 666666
          example: 666666
          format: int64
          type: integer
      title: CreateDashboardRequest
      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.LegoDashboardResponse:
      description: ''
      properties:
        lego_dashboard_items:
          description: ''
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.LegoDashboardItem'
          type: array
      title: LegoDashboardResponse
      type: object
    sensorsdata.common.ErrorContext:
      description: 发生错误时，系统快照信息
      properties:
        origin_stack:
          description: 上游异常的 stack，由系统截获
          type: string
        origin_cause:
          description: 上游异常的 cause by，由系统截获
          type: string
        origin_code:
          description: 上游异常的错误简码
          type: string
        origin_complete_code:
          description: 上游异常的完整错误码
          type: string
        error_extend_desc:
          description: 本次异常的辅助说明，可传入
          type: string
      title: ErrorContext
      type: object
    sensorsdata.analytics.v1.BookmarkItem:
      description: ''
      properties:
        id:
          description: 书签 ID
          example: 1
          format: int32
          type: integer
        user_id:
          description: 创建人 ID
          example: 1
          format: int32
          type: integer
        type:
          description: 书签所属业务模型
          example: '"/segmentation/"'
          type: string
        name:
          description: 书签名称
          example: '"事件分析"'
          type: string
        user_cname:
          description: 创建人
          example: 测试人1
          type: string
        data:
          description: 书签配置
          example: '"{\"measures\":[{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"iOS 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"iOS\"],\"$$render_index\":0}]},\"editName\":\"iOS 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"Android 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"Android\"],\"$$render_index\":0}]},\"editName\":\"Android 小程序显示的总次数\"},{\"event_name\":\"$MPShow\",\"aggregator\":\"general\",\"name\":\"python 小程序显示的总次数\",\"filter\":{\"conditions\":[{\"field\":\"event.$Anything.$lib\",\"function\":\"equal\",\"params\":[\"python\"],\"$$render_index\":0}]},\"editName\":\"python 小�

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