openapi: 3.2.0
info:
  title: Flagsmith Admin dashboard API
  version: v1
  description: Flagsmith's Core and SDK APIs. Check out Flagsmith documentation.
  contact:
    email: support@flagsmith.com
  license:
    name: BSD License
    identifier: BSD-3-Clause
tags:
- name: Admin dashboard
  description: Platform hub admin dashboard endpoints.
paths:
  /api/v1/admin/dashboard/organisations/:
    get:
      operationId: api_v1_admin_dashboard_organisations_retrieve
      tags:
      - Admin dashboard
      security:
      - tokenAuth: []
      - Master API Key: []
      responses:
        '200':
          description: No response body
      summary: Api v1 admin dashboard organisations retrieve
      x-summary-source: derived
  /api/v1/admin/dashboard/release-pipelines/:
    get:
      operationId: api_v1_admin_dashboard_release_pipelines_retrieve
      tags:
      - Admin dashboard
      security:
      - tokenAuth: []
      - Master API Key: []
      responses:
        '200':
          description: No response body
      summary: Api v1 admin dashboard release pipelines retrieve
      x-summary-source: derived
  /api/v1/admin/dashboard/stale-flags/:
    get:
      operationId: api_v1_admin_dashboard_stale_flags_retrieve
      tags:
      - Admin dashboard
      security:
      - tokenAuth: []
      - Master API Key: []
      responses:
        '200':
          description: No response body
      summary: Api v1 admin dashboard stale flags retrieve
      x-summary-source: derived
  /api/v1/admin/dashboard/summary/:
    get:
      operationId: api_v1_admin_dashboard_summary_retrieve
      tags:
      - Admin dashboard
      security:
      - tokenAuth: []
      - Master API Key: []
      responses:
        '200':
          description: No response body
      summary: Api v1 admin dashboard summary retrieve
      x-summary-source: derived
  /api/v1/admin/dashboard/usage-trends/:
    get:
      operationId: api_v1_admin_dashboard_usage_trends_retrieve
      tags:
      - Admin dashboard
      security:
      - tokenAuth: []
      - Master API Key: []
      responses:
        '200':
          description: No response body
      summary: Api v1 admin dashboard usage trends retrieve
      x-summary-source: derived
components:
  securitySchemes:
    Cohort_Sync_Key:
      type: http
      scheme: bearer
      description: For cohort sync endpoints called by an external cohort source, such as Amplitude.
    Cohort_Sync_Key__Basic:
      type: http
      scheme: basic
      description: For cohort sync endpoints called by an external cohort source that can only send Basic credentials, such as Mixpanel. The key is the password; the username is ignored.
    Environment_API_Key:
      type: apiKey
      in: header
      name: X-Environment-Key
      description: For SDK endpoints. <a href='https://docs.flagsmith.com/clients/rest#public-api-endpoints'>Find out more</a>.
    Master_API_Key:
      type: apiKey
      in: header
      name: Authorization
      description: For Management API endpoints. <a href='https://docs.flagsmith.com/integrating-with-flagsmith/flagsmith-api-overview/management-api'>Find out more</a>.
    basicAuth:
      type: http
      scheme: basic
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"