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

# Get workflow report

> Developer API operation for GET /dev/v1/workflows/report.



## OpenAPI

````yaml /openapi.json get /dev/v1/workflows/report
openapi: 3.0.3
info:
  title: Shoppex Developer API
  description: Mintlify-compatible Developer API reference for Shoppex.
  version: 1.0.0
  contact:
    name: Shoppex Support
    email: support@shoppex.io
    url: https://shoppex.io
servers:
  - url: https://api.shoppex.io
security:
  - bearerAuth: []
paths:
  /dev/v1/workflows/report:
    get:
      tags:
        - Workflows
      summary: Get workflow report
      description: Developer API operation for GET /dev/v1/workflows/report.
      operationId: getDevV1WorkflowsReport
      parameters:
        - name: days
          in: query
          required: false
          schema:
            description: >-
              Report window in days (1–90, default 7). Older history is not
              retained.
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - days
                      - since
                      - until
                      - workflows
                      - totals
                    properties:
                      days:
                        type: number
                      since:
                        type: string
                      until:
                        type: string
                      workflows:
                        type: array
                        items:
                          type: object
                          required:
                            - workflow_id
                            - name
                            - runs
                            - succeeded
                            - check_stopped
                            - failed
                            - skipped
                            - skipped_by_reason
                            - success_rate
                            - last_run_at
                            - top_failures
                            - running
                            - waiting
                          properties:
                            workflow_id:
                              type: string
                            name:
                              type: string
                            runs:
                              type: number
                            succeeded:
                              type: number
                            check_stopped:
                              type: number
                            failed:
                              type: number
                            skipped:
                              type: number
                            skipped_by_reason:
                              type: array
                              items:
                                type: object
                                required:
                                  - reason
                                  - count
                                properties:
                                  reason:
                                    type: string
                                    nullable: true
                                  count:
                                    type: number
                                additionalProperties: true
                            success_rate:
                              type: number
                              nullable: true
                            last_run_at:
                              type: string
                              nullable: true
                            top_failures:
                              type: array
                              items:
                                type: object
                                required:
                                  - message
                                  - count
                                properties:
                                  message:
                                    type: string
                                  count:
                                    type: number
                                additionalProperties: true
                            running:
                              type: number
                            waiting:
                              type: number
                          additionalProperties: true
                      totals:
                        type: object
                        required:
                          - runs
                          - succeeded
                          - check_stopped
                          - failed
                          - skipped
                          - skipped_by_reason
                          - success_rate
                          - last_run_at
                          - top_failures
                          - running
                          - waiting
                        properties:
                          runs:
                            type: number
                          succeeded:
                            type: number
                          check_stopped:
                            type: number
                          failed:
                            type: number
                          skipped:
                            type: number
                          skipped_by_reason:
                            type: array
                            items:
                              type: object
                              required:
                                - reason
                                - count
                              properties:
                                reason:
                                  type: string
                                  nullable: true
                                count:
                                  type: number
                              additionalProperties: true
                          success_rate:
                            type: number
                            nullable: true
                          last_run_at:
                            type: string
                            nullable: true
                          top_failures:
                            type: array
                            items:
                              type: object
                              required:
                                - message
                                - count
                              properties:
                                message:
                                  type: string
                                count:
                                  type: number
                              additionalProperties: true
                          running:
                            type: number
                          waiting:
                            type: number
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                  - error
                  - message
                  - log
                  - env
                properties:
                  status:
                    type: integer
                  data:
                    nullable: true
                  error:
                    type: string
                  message:
                    type: string
                    nullable: true
                  log:
                    nullable: true
                  env:
                    type: string
                additionalProperties: true
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '403':
          description: Response for status 403
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '409':
          description: Response for status 409
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '422':
          description: Response for status 422
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        required:
                          - code
                          - message
                          - doc_url
                        properties:
                          code:
                            type: string
                          message:
                            type: string
                          doc_url:
                            type: string
                          details:
                            type: array
                            items:
                              type: object
                              required:
                                - field
                                - message
                              properties:
                                field:
                                  type: string
                                message:
                                  type: string
                              additionalProperties: true
                          subcode:
                            type: string
                        additionalProperties: true
                    additionalProperties: true
                  - type: object
                    required:
                      - status
                      - data
                      - error
                      - message
                      - log
                      - env
                    properties:
                      status:
                        type: integer
                      data:
                        nullable: true
                      error:
                        type: string
                      message:
                        type: string
                        nullable: true
                      log:
                        nullable: true
                      env:
                        type: string
                    additionalProperties: true
      deprecated: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Use your Shoppex API key in the Authorization header.

````

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