openapi: 3.2.0
info:
  title: WordPress.com REST API — wpcom/v2 namespace Dashboard API
  version: v2
  description: Derived by API Evangelist from the WordPress.com REST API route index published at https://public-api.wordpress.com/wpcom/v2/. Paths, HTTP methods, and parameter names/types/descriptions/defaults are taken verbatim from that index. Response schemas are not published in the route index, so successful responses are described but not schematised; the error envelope was observed live on public-api.wordpress.com.
  contact:
    name: Automattic
    url: https://developer.wordpress.com/docs/api/
  x-derived-from: https://public-api.wordpress.com/wpcom/v2/
  x-derived-by: API Evangelist enrichment pipeline
servers:
- url: https://public-api.wordpress.com
security:
- bearerAuth: []
tags:
- name: dashboard
paths:
  /wpcom/v2/dashboard/admin-bar:
    get:
      operationId: getWpcomV2DashboardAdminBar
      summary: GET /wpcom/v2/dashboard/admin-bar
      tags:
      - dashboard
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
  /wpcom/v2/dashboard/site-filters:
    get:
      operationId: getWpcomV2DashboardSiteFilters
      summary: GET /wpcom/v2/dashboard/site-filters
      tags:
      - dashboard
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: fields
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      - name: site_types
        in: query
        required: false
        schema:
          type: array
          default: []
          items:
            type: string
  /wpcom/v2/dashboard/site-issues:
    get:
      operationId: getWpcomV2DashboardSiteIssues
      summary: GET /wpcom/v2/dashboard/site-issues
      tags:
      - dashboard
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
  /wpcom/v2/sites/{wpcom_site}/dashboard/cards:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteDashboardCards
      summary: GET /wpcom/v2/sites/{wpcom_site}/dashboard/cards
      tags:
      - dashboard
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
  /wpcom/v2/sites/{wpcom_site}/dashboard/cards-data:
    get:
      operationId: getWpcomV2SitesbyWpcomSiteDashboardCardsData
      summary: GET /wpcom/v2/sites/{wpcom_site}/dashboard/cards-data
      tags:
      - dashboard
      responses:
        '200':
          description: OK
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WPRestError'
      parameters:
      - name: wpcom_site
        in: path
        required: true
        schema:
          type: string
      - name: cards
        in: query
        required: true
        schema:
          type: string
        description: Dashboard cards as a comma delimited string
      - name: device_id
        in: query
        required: false
        schema:
          type: string
      - name: platform
        in: query
        required: false
        schema:
          type: string
      - name: build_number
        in: query
        required: false
        schema:
          type: string
      - name: marketing_version
        in: query
        required: false
        schema:
          type: string
      - name: identifier
        in: query
        required: false
        schema:
          type: string
      - name: os_version
        in: query
        required: false
        schema:
          type: string
components:
  schemas:
    WPRestError:
      type: object
      description: WordPress REST API error envelope (observed on public-api.wordpress.com).
      properties:
        code:
          type: string
          example: rest_unauthorized
        message:
          type: string
          example: Authentication required.
        data:
          type: object
          properties:
            status:
              type: integer
              example: 401
  securitySchemes:
    oauth2:
      type: oauth2
      description: WordPress.com OAuth 2.1, per https://public-api.wordpress.com/.well-known/openid-configuration
      flows:
        authorizationCode:
          authorizationUrl: https://public-api.wordpress.com/oauth2-1/authorize
          tokenUrl: https://public-api.wordpress.com/oauth2-1/token
          refreshUrl: https://public-api.wordpress.com/oauth2-1/token
          scopes:
            global: ''
            auth: ''
            openid: ''
            profile: ''
            email: ''
            users: ''
            sites: ''
            posts: ''
            comments: ''
            taxonomy: ''
            follow: ''
            sharing: ''
            freshly-pressed: ''
            notifications: ''
            insights: ''
            read: ''
            stats: ''
            media: ''
            menus: ''
            batch: ''
            videos: ''
    bearerAuth:
      type: http
      scheme: bearer