> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roark.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Regenerate a run group report

> Generates the group report again over the latest state of its runs. Returns the report generation; if one is already in flight it is returned instead of starting another. Poll GET /v1/simulation/run-group/{groupId} until `latestReport.status` is READY.



## OpenAPI

````yaml /api-reference/openapi.documented.json post /v1/simulation/run-group/{groupId}/report
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Agent
  - name: Agent Endpoint
  - name: Call
  - name: Chat
  - name: Metric
  - name: Metric Policy
  - name: Metric Collection Job
  - name: Customer Flow
  - name: Customer Flow Edge Case
  - name: Simulation
  - name: Simulation Persona
  - name: Simulation Environment
  - name: Simulation Scenario
  - name: Simulation Run Plan
  - name: Simulation Template
  - name: Simulation Run Plan Job
  - name: Simulation Job
  - name: HTTP Request Definition
  - name: Webhook
  - name: Issue
  - name: Autoimprove
  - name: Agent Config
  - name: Knowledge Base
  - name: Config
  - name: Organization Project
  - name: Organization Project Member
  - name: Organization Project API Key
  - name: Organization Config
  - name: CLI Auth
  - name: Me
  - name: Project
  - name: Usage
  - name: Benchmark
  - name: Health
  - name: Prospect Simulation
paths:
  /v1/simulation/run-group/{groupId}/report:
    post:
      tags:
        - Simulation
      summary: Regenerate a run group report
      description: >-
        Generates the group report again over the latest state of its runs.
        Returns the report generation; if one is already in flight it is
        returned instead of starting another. Poll GET
        /v1/simulation/run-group/{groupId} until `latestReport.status` is READY.
      operationId: postV1SimulationRun-groupByGroupIdReport
      parameters:
        - name: groupId
          in: path
          required: true
          description: The run group ID
          schema:
            type: string
            format: uuid
          example: 5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e
      responses:
        '202':
          description: The report generation, in flight
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SimulationRunGroupReport'
                required:
                  - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Run group not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const response = await client.simulationRunGroup.regenerateReport(
              '5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e',
            );

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.simulation_run_group.regenerate_report(
                "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
            )
            print(response.data)
components:
  schemas:
    SimulationRunGroupReport:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - PENDING
            - GENERATING
            - READY
            - FAILED
          description: >-
            PENDING and GENERATING are in flight; READY carries the document;
            FAILED carries errorMessage.
        errorMessage:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          description: ISO 8601
        completedAt:
          type:
            - string
            - 'null'
          description: ISO 8601. Null until the report settles.
        document:
          oneOf:
            - $ref: '#/components/schemas/SimulationRunGroupReportDocument'
            - type: 'null'
          description: Null until the report is READY.
      required:
        - id
        - status
        - errorMessage
        - createdAt
        - completedAt
        - document
      description: One generation of the group report.
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    SimulationRunGroupReportDocument:
      type: object
      properties:
        version:
          type: number
          const: 1
        generatedAtIso:
          type: string
        model:
          type: string
        simulationRunGroupId:
          type: string
        headline:
          type: object
          properties:
            groupName:
              type: string
            runCount:
              type: integer
            reportedRunCount:
              type: integer
            passedRunCount:
              type: integer
            callCount:
              type: integer
            verdict:
              type: string
              enum:
                - PASSED
                - THRESHOLD_FAILED
            completedAtIso:
              type:
                - string
                - 'null'
            verdictProse:
              type: string
            statTiles:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  value:
                    type: string
                  sub:
                    type:
                      - string
                      - 'null'
                  deltaDirection:
                    type:
                      - string
                      - 'null'
                    enum:
                      - POSITIVE
                      - NEGATIVE
                      - NEUTRAL
                required:
                  - label
                  - value
                  - sub
                  - deltaDirection
          required:
            - groupName
            - runCount
            - reportedRunCount
            - passedRunCount
            - callCount
            - verdict
            - completedAtIso
            - verdictProse
            - statTiles
        runs:
          type: array
          items:
            type: object
            properties:
              simulationRunPlanJobId:
                type: string
              runLabel:
                type: string
              runNumber:
                type:
                  - integer
                  - 'null'
              status:
                type: string
                enum:
                  - PENDING
                  - QUEUED
                  - CREATING_SNAPSHOTS
                  - CREATING_SIMULATIONS
                  - PREPARING_CAPACITY
                  - RUNNING_SIMULATIONS
                  - COMPLETED
                  - FAILED
                  - TIMED_OUT
                  - CANCELLED
                  - CANCELLING
                  - ENDING_SIMULATIONS
              verdict:
                type:
                  - string
                  - 'null'
                enum:
                  - PASSED
                  - THRESHOLD_FAILED
              callCount:
                type: integer
              checksPassed:
                type: integer
              checksTotal:
                type: integer
              themeCount:
                type: integer
              completedAtIso:
                type:
                  - string
                  - 'null'
              summary:
                type:
                  - string
                  - 'null'
            required:
              - simulationRunPlanJobId
              - runLabel
              - runNumber
              - status
              - verdict
              - callCount
              - checksPassed
              - checksTotal
              - themeCount
              - completedAtIso
              - summary
        executiveSummary:
          type: array
          items:
            type: object
            properties:
              heading:
                type: string
              body:
                type: string
            required:
              - heading
              - body
        scorecard:
          type: array
          items:
            type: object
            properties:
              checkName:
                type: string
              runCount:
                type: integer
              failedRunCount:
                type: integer
              failedCount:
                type: integer
              evaluatedCount:
                type: integer
              passRatePct:
                type:
                  - number
                  - 'null'
            required:
              - checkName
              - runCount
              - failedRunCount
              - failedCount
              - evaluatedCount
              - passRatePct
        wentWell:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              body:
                type: string
              evidence:
                type: array
                items:
                  type: object
                  properties:
                    text:
                      type: string
                    simulationRunPlanJobId:
                      type: string
                    conversationId:
                      type: string
                    callId:
                      type:
                        - string
                        - 'null'
                    personaName:
                      type:
                        - string
                        - 'null'
                    cueMs:
                      type:
                        - integer
                        - 'null'
                  required:
                    - text
                    - simulationRunPlanJobId
                    - conversationId
                    - callId
                    - personaName
                    - cueMs
            required:
              - title
              - body
              - evidence
        issues:
          type: array
          items:
            type: object
            properties:
              order:
                type: integer
              title:
                type: string
              body:
                type: string
              severity:
                type: string
                enum:
                  - HIGH
                  - MEDIUM
                  - LOW
              rootCauseChannel:
                type:
                  - string
                  - 'null'
                enum:
                  - PROMPT
                  - VOICE_CONFIG
                  - STT
                  - SPEECH_MODEL
                  - LLM_MODEL
                  - INFRA
                  - EXTERNAL
              affectedCallCount:
                type: integer
              runLabels:
                type: array
                items:
                  type: string
              checkNames:
                type: array
                items:
                  type: string
              sourceThemes:
                type: array
                items:
                  type: object
                  properties:
                    simulationRunPlanJobId:
                      type: string
                    slug:
                      type: string
                  required:
                    - simulationRunPlanJobId
                    - slug
              evidence:
                type: array
                items:
                  type: object
                  properties:
                    text:
                      type: string
                    simulationRunPlanJobId:
                      type: string
                    conversationId:
                      type: string
                    callId:
                      type:
                        - string
                        - 'null'
                    personaName:
                      type:
                        - string
                        - 'null'
                    cueMs:
                      type:
                        - integer
                        - 'null'
                  required:
                    - text
                    - simulationRunPlanJobId
                    - conversationId
                    - callId
                    - personaName
                    - cueMs
              calls:
                type: array
                items:
                  type: object
                  properties:
                    simulationRunPlanJobId:
                      type: string
                    conversationId:
                      type: string
                    callId:
                      type:
                        - string
                        - 'null'
                    personaName:
                      type:
                        - string
                        - 'null'
                    cueMs:
                      type:
                        - integer
                        - 'null'
                  required:
                    - simulationRunPlanJobId
                    - conversationId
                    - callId
                    - personaName
                    - cueMs
            required:
              - order
              - title
              - body
              - severity
              - rootCauseChannel
              - affectedCallCount
              - runLabels
              - checkNames
              - sourceThemes
              - evidence
              - calls
        smallerItems:
          type: array
          items:
            type: object
            properties:
              order:
                type: integer
              title:
                type: string
              body:
                type: string
              severity:
                type: string
                enum:
                  - HIGH
                  - MEDIUM
                  - LOW
              rootCauseChannel:
                type:
                  - string
                  - 'null'
                enum:
                  - PROMPT
                  - VOICE_CONFIG
                  - STT
                  - SPEECH_MODEL
                  - LLM_MODEL
                  - INFRA
                  - EXTERNAL
              affectedCallCount:
                type: integer
              runLabels:
                type: array
                items:
                  type: string
              checkNames:
                type: array
                items:
                  type: string
              sourceThemes:
                type: array
                items:
                  type: object
                  properties:
                    simulationRunPlanJobId:
                      type: string
                    slug:
                      type: string
                  required:
                    - simulationRunPlanJobId
                    - slug
              evidence:
                type: array
                items:
                  type: object
                  properties:
                    text:
                      type: string
                    simulationRunPlanJobId:
                      type: string
                    conversationId:
                      type: string
                    callId:
                      type:
                        - string
                        - 'null'
                    personaName:
                      type:
                        - string
                        - 'null'
                    cueMs:
                      type:
                        - integer
                        - 'null'
                  required:
                    - text
                    - simulationRunPlanJobId
                    - conversationId
                    - callId
                    - personaName
                    - cueMs
              calls:
                type: array
                items:
                  type: object
                  properties:
                    simulationRunPlanJobId:
                      type: string
                    conversationId:
                      type: string
                    callId:
                      type:
                        - string
                        - 'null'
                    personaName:
                      type:
                        - string
                        - 'null'
                    cueMs:
                      type:
                        - integer
                        - 'null'
                  required:
                    - simulationRunPlanJobId
                    - conversationId
                    - callId
                    - personaName
                    - cueMs
            required:
              - order
              - title
              - body
              - severity
              - rootCauseChannel
              - affectedCallCount
              - runLabels
              - checkNames
              - sourceThemes
              - evidence
              - calls
        recommendations:
          type: array
          items:
            type: object
            properties:
              order:
                type: integer
              title:
                type: string
              body:
                type: string
              channel:
                type:
                  - string
                  - 'null'
                enum:
                  - PROMPT
                  - VOICE_CONFIG
                  - STT
                  - SPEECH_MODEL
                  - LLM_MODEL
                  - INFRA
                  - EXTERNAL
              issueOrders:
                type: array
                items:
                  type: integer
            required:
              - order
              - title
              - body
              - channel
              - issueOrders
        aggregates:
          type: array
          items:
            type: object
            properties:
              metricName:
                type: string
              averageLabel:
                type:
                  - string
                  - 'null'
              medianLabel:
                type:
                  - string
                  - 'null'
              p95Label:
                type:
                  - string
                  - 'null'
              evaluatedCount:
                type: integer
            required:
              - metricName
              - averageLabel
              - medianLabel
              - p95Label
              - evaluatedCount
        methodology:
          type: string
      required:
        - version
        - generatedAtIso
        - model
        - simulationRunGroupId
        - headline
        - runs
        - executiveSummary
        - scorecard
        - wentWell
        - issues
        - smallerItems
        - recommendations
        - aggregates
        - methodology
      description: >-
        The group report: the runs it covers, a scorecard summed across them,
        what went well, and the issues found, each merged from the per-run
        debriefs with call-level evidence. Every figure is computed from the
        runs; the prose is AI-written around those facts.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.