Events.com Workbook Generate Dashboard API

openapi: 3.2.0
info:
  title: DataGol AI Workbook Generate Dashboard API
  version: 1.0.36
tags:
- name: Workbook Generate Dashboard
paths:
  /ai/api/v2/dashboard/generate-dashboard:
    post:
      tags:
      - Workbook Generate Dashboard
      summary: Generate Dashboard
      operationId: generate_dashboard_ai_api_v2_dashboard_generate_dashboard_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateDashboardRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ai/api/v2/dashboard/widget/summary:
    post:
      tags:
      - Workbook Generate Dashboard
      summary: Generate Summary
      operationId: generate_summary_ai_api_v2_dashboard_widget_summary_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WidgetSummaryRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetSummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ai/api/v2/dashboard/summary:
    post:
      tags:
      - Workbook Generate Dashboard
      summary: Generate Dashboard Summary
      operationId: generate_dashboard_summary_ai_api_v2_dashboard_summary_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardSummaryRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardSummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WidgetSummaryResponse:
      properties:
        data:
          type: string
          title: Data
      type: object
      required:
      - data
      title: WidgetSummaryResponse
    WidgetSummaryRequest:
      properties:
        widgetId:
          type: string
          title: Widgetid
        pageId:
          type: string
          title: Pageid
        persona:
          type: string
          title: Persona
          default: BUSINESS
        userPrompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Userprompt
      type: object
      required:
      - widgetId
      - pageId
      title: WidgetSummaryRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DashboardSummaryRequest:
      properties:
        pageId:
          type: string
          title: Pageid
        persona:
          type: string
          title: Persona
        userPrompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Userprompt
      type: object
      required:
      - pageId
      - persona
      title: DashboardSummaryRequest
    DashboardSummaryResponse:
      properties:
        data:
          type: string
          title: Data
        successfulWidgetIds:
          items:
            type: string
          type: array
          title: Successfulwidgetids
        skippedWidgetIds:
          items:
            type: string
          type: array
          title: Skippedwidgetids
        failedWidgetIds:
          items:
            type: string
          type: array
          title: Failedwidgetids
      type: object
      required:
      - data
      - successfulWidgetIds
      - skippedWidgetIds
      - failedWidgetIds
      title: DashboardSummaryResponse
    GenerateDashboardRequest:
      properties:
        workbookId:
          type: string
          title: Workbookid
          description: Workbook ID for which the dashboard is to be generated.
        persona:
          anyOf:
          - type: string
          - type: 'null'
          title: Persona
          description: Persona for which the dashboard is to be generated.
        count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Count
          description: Number of dashboards to be generated.
          default: 10
        generateChart:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Generatechart
          description: Flag to indicate whether to generate charts or just questions.
          default: false
        userPrompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Userprompt
          description: Optional user prompt to guide question generation.
        questions:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Questions
          description: List of questions. If provided, charts will be generated for these questions without
            generating new ones.
      type: object
      required:
      - workbookId
      title: GenerateDashboardRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError