openapi: 3.0.1
info:
  description: 属性相关基础元数据
  title: 神策分析
  version: ''
servers:
- url: /api/v3/analytics/v1
paths:
  /property-meta/event-properties/all:
    get:
      description: 获取所有事件属性列表
      operationId: ListAllEventProperties
      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:
                  properties:
                  - {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.EventPropertyAllResponseHttpApiResult'
          description: sensorsdata.analytics.v1.EventPropertyAllResponse
      summary: 获取所有事件属性
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.EventPropertyAllResponse
        isServerStreaming: false
        grpcServiceBase: com.sensorsdata.analytics.v1.PropertyMetaServiceGrpc.PropertyMetaServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
  /property-meta/event-properties:
    post:
      description: 查询指定事件和属性列表
      operationId: ListEventProperties
      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.EventPropertyRequest'
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data:
                  event_properties:
                  - event_define: {}
                    properties:
                    - {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.EventPropertyResponseHttpApiResult'
          description: sensorsdata.analytics.v1.EventPropertyResponse
      summary: 获取指定的事件和相关属性
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.EventPropertyResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.EventPropertyRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.PropertyMetaServiceGrpc.PropertyMetaServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: EventPropertyRequest
  /property-meta/user-properties/all:
    get:
      description: 获取所有用户属性列表
      operationId: ListAllUserProperties
      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:
                  user_properties:
                  - {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.UserPropertyAllResponseHttpApiResult'
          description: sensorsdata.analytics.v1.UserPropertyAllResponse
      summary: 获取所有用户属性列表
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.UserPropertyAllResponse
        isServerStreaming: false
        grpcServiceBase: com.sensorsdata.analytics.v1.PropertyMetaServiceGrpc.PropertyMetaServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
  /property-meta/user-groups/all:
    get:
      description: 获取所有用户分群列表
      operationId: ListUserGroups
      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:
                  user_groups:
                  - {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.UserGroupAllResponseHttpApiResult'
          description: sensorsdata.analytics.v1.UserGroupAllResponse
      summary: 获取所有用户分群列表
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.UserGroupAllResponse
        isServerStreaming: false
        grpcServiceBase: com.sensorsdata.analytics.v1.PropertyMetaServiceGrpc.PropertyMetaServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
  /property-meta/user-tags/dir:
    get:
      description: 获取带有目录结构的用户标签信息
      operationId: ListUserTagsWithDir
      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:
                  user_tags:
                  - {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.UserTagDirResponseHttpApiResult'
          description: sensorsdata.analytics.v1.UserTagDirResponse
      summary: 获取带有目录结构的用户标签列表
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.UserTagDirResponse
        isServerStreaming: false
        grpcServiceBase: com.sensorsdata.analytics.v1.PropertyMetaServiceGrpc.PropertyMetaServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
  /property-meta/property/values:
    post:
      description: 获取属性候选值
      operationId: GetPropertyValues
      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.GetPropertyValueRequest'
        required: false
      responses:
        default:
          content:
            application/json:
              example:
                code: SUCCESS
                data: {}
                request_id: '1'
              schema:
                $ref: '#/components/schemas/sensorsdata.analytics.v1.GetPropertyValueResponseHttpApiResult'
          description: sensorsdata.analytics.v1.GetPropertyValueResponse
      summary: 获取属性候选值
      x-sd-openapi:
        responseClass: com.sensorsdata.analytics.v1.GetPropertyValueResponse
        isServerStreaming: false
        requestClass: com.sensorsdata.analytics.v1.GetPropertyValueRequest
        grpcServiceBase: com.sensorsdata.analytics.v1.PropertyMetaServiceGrpc.PropertyMetaServiceImplBase
        internalDesc: classes in template for grpc service dynamic invoking
        isClientStreaming: false
      x-codegen-request-body-name: GetPropertyValueRequest
components:
  schemas:
    sensorsdata.analytics.v1.EventWithProperty:
      description: ''
      properties:
        event_define:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.EventDefine'
        properties:
          description: 事件下的属性信息
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.PropertyDefine'
          type: array
      title: EventWithProperty
      type: object
    sensorsdata.analytics.v1.UserTagDirResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.UserTagDirResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.UserTagDirResponseHttpApiResult
      type: object
    sensorsdata.analytics.v1.EventPropertyAllResponse:
      description: ''
      properties:
        properties:
          description: 事件属性列表
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.PropertyDefine'
          type: array
      title: EventPropertyAllResponse
      type: object
    sensorsdata.analytics.v1.UserTagDirDefine:
      description: ''
      properties:
        name:
          description: ''
          type: string
        cname:
          description: ''
          type: string
        data_type:
          description: ''
          type: string
        type:
          description: ''
          enum:
          - USER_TAG_TYPE_UNSPECIFIED
          - DIR
          - TAG
          type: string
        sub_nodes:
          description: ''
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.UserTagDirDefine'
          type: array
      title: UserTagDirDefine
      type: object
    sensorsdata.common.HttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          properties: {}
          type: object
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: HttpApiResult
      type: object
    sensorsdata.analytics.v1.UserPropertyAllResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.UserPropertyAllResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.UserPropertyAllResponseHttpApiResult
      type: object
    sensorsdata.analytics.v1.UserTagDirResponse:
      description: ''
      properties:
        user_tags:
          description: 用户标签列表
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.UserTagDirDefine'
          type: array
      title: UserTagDirResponse
      type: object
    sensorsdata.analytics.v1.PropertyDefine:
      description: ''
      properties:
        id:
          description: ''
          format: int32
          type: integer
        name:
          description: ''
          type: string
        cname:
          description: ''
          type: string
        data_type:
          description: ''
          type: string
        is_virtual:
          description: ''
          type: boolean
        has_dict:
          description: ''
          type: boolean
        unit:
          description: ''
          type: string
        platforms:
          description: ''
          items:
            type: string
          type: array
        trigger_opportunity:
          description: ''
          type: string
        create_time:
          description: ''
          format: date-time
          type: string
        update_time:
          description: ''
          format: date-time
          type: string
      title: PropertyDefine
      type: object
    sensorsdata.analytics.v1.EventPropertyRequest:
      description: ''
      properties:
        events:
          description: 指定事件列表
          items:
            type: string
          type: array
      title: EventPropertyRequest
      type: object
    sensorsdata.analytics.v1.UserGroupAllResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.UserGroupAllResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.UserGroupAllResponseHttpApiResult
      type: object
    sensorsdata.analytics.v1.GetPropertyValueRequest:
      description: ''
      properties:
        table_type:
          description: 属性类型
          enum:
          - TABLE_TYPE_UNSPECIFIED
          - EVENT
          - USER
          type: string
        property_name:
          description: 属性名称
          type: string
        limit:
          description: 限制返回值个数
          format: int32
          type: integer
      title: GetPropertyValueRequest
      type: object
    sensorsdata.analytics.v1.GetPropertyValueResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.GetPropertyValueResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.GetPropertyValueResponseHttpApiResult
      type: object
    sensorsdata.common.ErrorCause:
      properties:
        error_cause:
          description: 致错原因1
          example: 参数异常1
          type: string
        action_suggestion:
          description: 操作建议，针对该原因，建议的解决方式
          example: 检测入参的数据类型1
          type: string
      title: ErrorCause
      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.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.UserGroupDefine:
      description: ''
      properties:
        id:
          description: ''
          format: int32
          type: integer
        name:
          description: ''
          type: string
        cname:
          description: ''
          type: string
        data_type:
          description: ''
          type: string
        create_time:
          description: ''
          format: date-time
          type: string
        update_time:
          description: ''
          format: date-time
          type: string
      title: UserGroupDefine
      type: object
    sensorsdata.analytics.v1.EventDefine:
      description: ''
      properties:
        id:
          description: ''
          format: int32
          type: integer
        name:
          description: ''
          type: string
        cname:
          description: ''
          type: string
        is_virtual:
          description: ''
          type: boolean
        tags:
          description: ''
          items:
            format: int32
            type: integer
          type: array
        comment:
          description: ''
          type: string
        total_count:
          description: ''
          format: int64
          type: integer
        platforms:
          description: ''
          items:
            type: string
          type: array
        trigger_opportunity:
          description: ''
          type: string
        create_time:
          description: ''
          format: date-time
          type: string
        update_time:
          description: ''
          format: date-time
          type: string
      title: EventDefine
      type: object
    sensorsdata.analytics.v1.UserGroupAllResponse:
      description: ''
      properties:
        user_groups:
          description: 用户分群列表
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.UserGroupDefine'
          type: array
      title: UserGroupAllResponse
      type: object
    sensorsdata.analytics.v1.EventPropertyResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.EventPropertyResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.EventPropertyResponseHttpApiResult
      type: object
    sensorsdata.analytics.v1.UserPropertyAllResponse:
      description: ''
      properties:
        user_properties:
          description: 用户属性列表
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.PropertyDefine'
          type: array
      title: UserPropertyAllResponse
      type: object
    sensorsdata.analytics.v1.EventPropertyResponse:
      description: ''
      properties:
        event_properties:
          description: 事件的属性列表
          items:
            $ref: '#/components/schemas/sensorsdata.analytics.v1.EventWithProperty'
          type: array
      title: EventPropertyResponse
      type: object
    sensorsdata.analytics.v1.GetPropertyValueResponse:
      description: ''
      properties:
        values:
          description: 候选值
          items:
            type: string
          type: array
      title: GetPropertyValueResponse
      type: object
    sensorsdata.analytics.v1.EventPropertyAllResponseHttpApiResult:
      properties:
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        data:
          $ref: '#/components/schemas/sensorsdata.analytics.v1.EventPropertyAllResponse'
        error_info:
          $ref: '#/components/schemas/sensorsdata.common.ErrorInfo'
      title: sensorsdata.analytics.v1.EventPropertyAllResponseHttpApiResult
      type: object
x-sd-openapi-service-name: PropertyMeta
x-sd-openapi-service-name-hyphen: property-meta
x-sd-openapi-app-name: analytics
x-sd-openapi-service-name-zh_cn: 属性元数据
x-original-swagger-version: '2.0'