nodeapi-spec.yaml

openapi: 3.0.0
info:
  title: backend
  version: 1.0.0
  description: An OpenAPI Specification that describes the ABsmartly API for working with your experiments programmatically.
  contact: {}
  license:
    name: Proprietary
servers:
  - url: https://sandbox.absmartly.com
security:
  - UserApiKey: []
tags: []
paths:
  /experiments:
    get:
      summary: Experiments LIST
      description: '**Required Permissions**: `Experiment List` or `Experiment Admin`'
      parameters:
        - name: search
          in: query
          schema:
            type: string
            example: call_to_action
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
        - name: iterations_of
          in: query
          required: false
          description: The `id` of the experiment that you want to get the iterations of.
          schema:
            type: integer
        - name: owners
          in: query
          required: false
          description: An array of `user` ids to sort results by.
          schema:
            type: array
            items:
              type: integer
        - name: teams
          in: query
          required: false
          description: Array of `team` ids to sort results by.
          schema:
            type: array
            items:
              type: integer
        - name: tags
          in: query
          required: false
          description: An array of `tag` ids to sort results by.
          schema:
            type: array
            items:
              type: integer
        - name: applications
          in: query
          required: false
          description: An array of `application` ids to sort results by.
          schema:
            type: array
            items:
              type: integer
        - name: unit_types
          in: query
          required: false
          description: An array of `unit_type` ids to sort results by.
          schema:
            type: array
            items:
              type: integer
        - name: previews
          in: query
          required: false
          description: A boolean value which deliminates whether you want all experiment data or just a few specific statistics
          schema:
            enum:
              - 0
              - 1
        - name: impact
          in: query
          required: false
          description: A tuple value which allows you to specify a `from` and a `to` range of impacts to filter by. **This must be used with a preview query of `1`**
          schema:
            type: array
            minItems: 2
            maxItems: 2
            items:
              type: number
        - name: confidence
          in: query
          required: false
          description: A tuple value which allows you to specify a `from` and a `to` range of confidences to filter by. **This must be used with a preview query of `1`**
          schema:
            type: array
            minItems: 2
            maxItems: 2
            items:
              type: number
        - name: significance
          in: query
          required: false
          description: An array of significances allowing you to filter by positive, negative or unsignificant experiments. **This must be used with a preview query of `1`**
          schema:
            type: array
            items:
              enum:
                - insignificant
                - positive
                - negative
        - name: sample_ratio_mismatch
          in: query
          required: false
          description: A boolean value which allows you to filter for experiments with a `Sample Ratio Mismatch` alert. **This must be used with a preview query of `1`**
          schema:
            type: boolean
        - name: cleanup_needed
          in: query
          required: false
          description: A boolean value which allows you to filter for experiments with a `Code Cleanup Needed` alert. **This must be used with a preview query of `1`**
          schema:
            type: boolean
        - name: audience_mismatch
          in: query
          required: false
          description: A boolean value which allows you to filter for experiments with a `Target Audience Mismatch` alert. **This must be used with a preview query of `1`**
          schema:
            type: boolean
        - name: sample_size_reached
          in: query
          required: false
          description: A boolean value which allows you to filter for experiments with a `Sample Size Reached` alert. **This must be used with a preview query of `1`**
          schema:
            type: boolean
        - name: iterations
          in: query
          required: false
          description: null
          schema:
            enum:
              - 0
              - 1
        - name: sort_asc
          in: query
          required: false
          description: A boolean value which allows you to reverse the order of the experiment list
          schema:
            type: boolean
        - name: items
          in: query
          required: false
          description: An integer value which allows you to limit the number of experiments that are returned per page.
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: An integer value which represents what page of the experiments list to return
          schema:
            type: integer
      responses:
        '200':
          description: An array of all experiment objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Experiment'
  /experiments/{experimentId}:
    get:
      summary: Experiment GET
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment which you want data from.
          schema:
            type: integer
            format: int64
            minimum: 1
      responses:
        '200':
          description: A JSON Object with experiment data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment:
                    $ref: '#/components/schemas/Experiment'
  /experiments/{experimentId}/start:
    put:
      summary: Experiment START
      description: '**Required Permissions**: `Experiment Start` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment which you want to start.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The action to take on the experiment and a comment to go along with it.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  format: start
                  example: start
                note:
                  type: string
                  example: Starting experiment to test new call to action
      responses:
        '200':
          description: A JSON Object with experiment data, the experiment note and an array of errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                  experiment:
                    $ref: '#/components/schemas/Experiment'
                  experiment_note:
                    $ref: '#/components/schemas/ExperimentNote'
                  ok:
                    type: boolean
  /experiments/{experimentId}/stop:
    put:
      summary: Experiment STOP
      description: '**Required Permissions**: `Experiment Stop` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment which you want to stop.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The action to take on the experiment and a comment to go along with it.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  format: stop
                  example: stop
                note:
                  type: string
                  example: Stopping experiment as no significant results were found
      responses:
        '200':
          description: A JSON Object with experiment data, the experiment note and an array of errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                  experiment:
                    $ref: '#/components/schemas/Experiment'
                  experiment_note:
                    $ref: '#/components/schemas/ExperimentNote'
                  ok:
                    type: boolean
  /experiments/{experimentId}/full_on:
    put:
      summary: Experiment FULL ON
      description: '**Required Permissions**: `Experiment Full On` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment which you want to put full on.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The full on variant and a report of why this experiment is being put full on.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                full_on_variant:
                  type: integer
                  format: 1 | 2 | 3
                  example: 1
                note:
                  type: string
                  example: Putting variant 1 full on as we saw significant increase in conversions
      responses:
        '200':
          description: A JSON Object with experiment data, the experiment note and an array of errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                  experiment:
                    $ref: '#/components/schemas/Experiment'
                  experiment_note:
                    $ref: '#/components/schemas/ExperimentNote'
                  ok:
                    type: boolean
  /experiments/{experimentId}/archive:
    put:
      summary: Experiment ARCHIVE
      description: '**Required Permissions**: `Experiment Archive` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment which you want to archive.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The action to take on the experiment, the experiment id and a comment to go along with the action.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                archive:
                  type: boolean
                  example: true
                id:
                  description: The `id` of the experiment which you want to archive.
                  type: integer
                  format: int64
                  minimum: 1
                  example: 13
                note:
                  description: The reason why you are archiving this experiment.
                  type: string
                  example: Archiving experiment as it is no longer needed
      responses:
        '200':
          description: A JSON Object with experiment data, the experiment note and an array of errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                  experiment:
                    $ref: '#/components/schemas/Experiment'
                  experiment_note:
                    $ref: '#/components/schemas/ExperimentNote'
                  ok:
                    type: boolean
  /experiments/{experimentId}/participants/history:
    post:
      summary: Experiment Participants History DATA
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment that you want the history of.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The parameters to filter the history by.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  properties:
                    segments:
                      type: array
                      items:
                        type: object
                        properties:
                          segment_id:
                            type: integer
                            format: int64
                            minimum: 1
                            example: 1
                          operator:
                            type: string
                            enum:
                              - in
                              - not_in
                            example: not_in
                          values:
                            type: array
                            items:
                              type: string
                              example: absmartly-javascript-sdk
                period:
                  type: string
                  enum:
                    - 1h
                    - 1d
                    - 1w
                    - 1M
                  example: 1d
                tz_offset:
                  type: integer
                  example: 0
      responses:
        '200':
          description: |
            A JSON Object with participants history. The object has three properties, `columnNames`, `columnTypes` and `rows`. 
            `columnNames` is an array of strings which identifies which columns are which in the `rows[][]`. 
            `columnTypes` is an array of strings which identifies the types of data in the `rows[][]`. 
            `rows` is an array of arrays which contain the data of the experiment variants over your selected period. 
            The column names are defined as the following:
            - `date` - The date of the row's data in seconds since epoch.
            - `variant` - The variant that this row describes. (0, 1, 2 or 3).
            - `first_exposure_at` - The date of the first exposure of this variant in the current time period in milliseconds since epoch.
            - `last_exposure_at` - The date of the last exposure of this variant in the current time period in milliseconds since epoch.
            - `unit_count` - The number of units that were exposed to this variant in the current time period.
            - `cum_unit_count` - The cumulative number of units that were exposed to this variant at the end of the current time period.

            :::caution
            The columns may come in a different order than the one listed above. It's important to use the `columnNames` array to identify the index of the column you want to use.
            :::
          content:
            application/json:
              schema:
                type: object
                properties:
                  columnNames:
                    type: array
                    items:
                      type: string
                  columnTypes:
                    type: array
                    items:
                      type: string
                  rows:
                    type: array
                    items:
                      type: array
                      items:
                        type: number
  /experiments/{experimentId}/metrics/main/history:
    post:
      summary: Experiment Main Metrics History DATA
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment that you want the history of.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The parameters to filter the history by.
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  properties:
                    segments:
                      type: array
                      items:
                        type: object
                        properties:
                          segment_id:
                            type: integer
                            format: int64
                            minimum: 1
                            example: 1
                          operator:
                            type: string
                            enum:
                              - in
                              - not_in
                            example: not_in
                          values:
                            type: array
                            items:
                              type: string
                              example: absmartly-javascript-sdk
                period:
                  type: string
                  enum:
                    - 1h
                    - 1d
                    - 1w
                    - 1M
                  example: 1d
                tz_offset:
                  type: integer
                  example: 0
      responses:
        '200':
          description: |
            A JSON Object with main metrics history per period. The object has three properties, `columnNames`, `columnTypes` and `rows`. 
            `columnNames` is an array of strings which identifies which columns are which in the `rows[][]`. 
            `columnTypes` is an array of strings which identifies the types of data in the `rows[][]`. 
            `rows` is an array of arrays which contain the data of the experiment variants over your selected period. 
            The column names are defined as the following:

            ### **Regular Columns:**

            - `date` - The date of the row's data in seconds since epoch.
            - `variant` - The variant that this row describes. (0, 1, 2 or 3).
            - `first_exposure_at` - The date of the first exposure of this variant in the current time period in milliseconds since epoch.
            - `last_exposure_at` - The date of the last exposure of this variant in the current time period in milliseconds since epoch.
            - `unit_count` - The number of units that were exposed to this variant in the current time period.
            - `cum_unit_count` - The cumulative number of units that were exposed to this variant at the end of the current time period.

            ### **Dynamic Columns:**

            - `metric_${metric_id}` - The value of the metric with the id of `${metric_id}` in the current time period.
            - `metric_${metric_id}_mean` - The mean value of the metric with the id of `${metric_id}` in the current time period.
            - `metric_${metric_id}_var` - The variance of the metric with the id of `${metric_id}` in the current time period.
            - `metric_${metric_id}_pvalue` - The p-value of the metric with the id of `${metric_id}` in the current time period.
            - `metric_${metric_id}_impact` - The impact of the metric with the id of `${metric_id}` in the current time period.
            - `metric_${metric_id}_impact_ci_lower` - The lower bound of the confidence interval of the impact of the metric with the id of `${metric_id}` in the current time period.
            - `metric_${metric_id}_impact_ci_upper` - The upper bound of the confidence interval of the impact of the metric with the id of `${metric_id}` in the current time period.

            :::caution
            The columns may come in a different order than the one listed above. It's important to use the `columnNames` array to identify the index of the column you want to use.
            :::
          content:
            application/json:
              schema:
                type: object
                properties:
                  columnNames:
                    type: array
                    items:
                      type: string
                  columnTypes:
                    type: array
                    items:
                      type: string
                  rows:
                    type: array
                    items:
                      type: array
                      items:
                        type: number
  /experiments/{experimentId}/metrics/main:
    post:
      summary: Experiment Main Metrics DATA
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          description: The `id` of the experiment that you want the main metrics of.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The parameters to filter the main metrics by. If no filtering is required then `filters` can be an empty object
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  properties:
                    segments:
                      type: array
                      items:
                        type: object
                        properties:
                          segment_id:
                            type: integer
                            format: int64
                            minimum: 1
                            example: 1
                          operator:
                            type: string
                            enum:
                              - in
                              - not_in
                            example: not_in
                          values:
                            type: array
                            items:
                              type: string
                              example: absmartly-javascript-sdk
      responses:
        '200':
          description: |
            A JSON Object with the current values of the experiment's main metrics. The object has three properties, 
            `columnNames`, `columnTypes` and `rows`. `columnNames` is an array of strings which identifies which 
            columns are which in the `rows[][]`. `columnTypes` is an array of strings which identifies the types of 
            data in the `rows[][]`. `rows` is an array of arrays which contain the current main metric data for each of 
            the experiment's variants. The column names are defined as the following:

            ### **Regular Columns:**

            - `variant` - The variant that this row describes. (0, 1, 2 or 3).
            - `first_exposure_at` - The date of the first exposure of this variant in milliseconds since epoch.
            - `last_exposure_at` - The date of the last exposure of this variant in milliseconds since epoch.
            - `unit_count` - The number of units that have been exposed to this variant.

            ### **Dynamic Columns:**

            - `metric_${metric_id}` - The current value of the metric with the id of `${metric_id}`.
            - `metric_${metric_id}_mean` - The mean value of the metric with the id of `${metric_id}`.
            - `metric_${metric_id}_var` - The variance of the metric with the id of `${metric_id}`.
            - `metric_${metric_id}_pvalue` - The p-value of the metric with the id of `${metric_id}`.
            - `metric_${metric_id}_impact` - The current impact of the metric with the id of `${metric_id}`.
            - `metric_${metric_id}_impact_ci_lower` - The lower bound of the confidence interval of the impact of the metric with the id of `${metric_id}`.
            - `metric_${metric_id}_impact_ci_upper` - The upper bound of the confidence interval of the impact of the metric with the id of `${metric_id}`.

            :::caution
            The columns may come in a different order than the one listed above. It's important to use the `columnNames` array to identify the index of the column you want to use.
            :::
          content:
            application/json:
              schema:
                type: object
                properties:
                  columnNames:
                    type: array
                    items:
                      type: string
                  columnTypes:
                    type: array
                    items:
                      type: string
                  rows:
                    type: array
                    items:
                      type: array
                      items:
                        type: number
  /experiments/{experimentId}/activity:
    get:
      summary: Experiment Activity GET
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          schema:
            type: integer
        - name: offset
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: A JSON Object containing a particular experiment's activity.
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment_notes:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExperimentNote'
                  offset:
                    type: integer
    post:
      summary: Experiment Comment CREATE
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The comment to be inserted in the experiment activity tab.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: The `id` of the experiment where the comment will be created.
                  type: integer
                  format: int64
                  minimum: 1
                  example: 13
                note:
                  description: The comment text.
                  type: string
                  example: Text to be inserted
      responses:
        '200':
          description: A JSON Object containing a particular experiment's activity.
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment_note:
                    $ref: '#/components/schemas/ExperimentNote'
                  ok:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: string
  /experiments/{experimentId}/activity/{commentId}/reply:
    post:
      summary: Experiment Comment Reply CREATE
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentId
          in: path
          required: true
          schema:
            type: integer
            format: int64
            minimum: 1
        - name: commentId
          in: path
          required: true
          description: The `id` of the comment where the reply will be created.
          schema:
            type: integer
            format: int64
            minimum: 1
      requestBody:
        description: The reply to be inserted in the comment.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: The `id` of the comment where the reply will be created.
                  type: integer
                  format: int64
                  minimum: 1
                  example: 13
                note:
                  description: The reply text.
                  type: string
                  example: Text to be replied
      responses:
        '200':
          description: A JSON Object containing a particular experiment's activity.
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment_note:
                    $ref: '#/components/schemas/ExperimentNote'
                  ok:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: string
  /api_keys:
    get:
      summary: API Keys LIST
      description: '**Required Permissions**: `ApiKey List` or `ApiKey Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object with an array of all created API keys.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  api_keys:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApiKey'
  /api_keys/{apiKeyId}:
    get:
      summary: API Key GET
      description: '**Required Permissions**: `ApiKey Get` or `ApiKey Admin`'
      parameters:
        - name: apiKeyId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the API Key that you wish to get data from.
      responses:
        '200':
          description: A JSON Object a particular API key's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  api_key:
                    $ref: '#/components/schemas/ApiKey'
  /applications:
    get:
      summary: Applications LIST
      description: '**Required Permissions**: `Application List` or `Application Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object with an array of all applications that have been created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  applications:
                    type: array
                    items:
                      $ref: '#/components/schemas/Application'
  /applications/{applicationId}:
    get:
      summary: Application GET
      description: '**Required Permissions**: `Application Get` or `Application Admin`'
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Application that you wish to get data from.
      responses:
        '200':
          description: A JSON Object an application's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  application:
                    $ref: '#/components/schemas/Application'
  /cors:
    get:
      summary: CORS Allowed Origins LIST
      description: '**Required Permissions**: `CorsAllowedOrigin List` or `CorsAllowedOrigin Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all CORS Allowed Origins.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  cors_allowed_origins:
                    type: array
                    items:
                      $ref: '#/components/schemas/CORS'
  /cors/{corsId}:
    get:
      summary: CORS Allowed Origin GET
      description: '**Required Permissions**: `CorsAllowedOrigin Get` or `CorsAllowedOrigin Admin`'
      parameters:
        - name: applicationId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the CORS Allowed Origin that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a single CORS Allowed Origin's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cors_allowed_origin:
                    $ref: '#/components/schemas/CORS'
  /environments:
    get:
      description: '**Required Permissions**: `Environment List` or `Environment Admin`'
      summary: Environments LIST
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all created environments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  environments:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
  /environments/{environmentId}:
    get:
      summary: Environment GET
      description: '**Required Permissions**: `Environment Get` or `Environment Admin`'
      parameters:
        - name: environmentId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Environment that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a single environment's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  environment:
                    $ref: '#/components/schemas/Environment'
  /experiment_annotations:
    get:
      summary: Experiment Annotations LIST
      description: '**Required Permissions**: `Annotation List` or `Annotation Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
        - name: experiment_id
          in: query
          required: false
          schema:
            type: integer
          description: Filter experiment annotations by `experiment_id`
      responses:
        '200':
          description: A JSON Object containing an array of all experiment annotations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  experiment_annotations:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExperimentAnnotation'
  /experiment_annotations/{experimentAnnotationId}:
    get:
      summary: Experiment Annotation GET
      description: '**Required Permissions**: `Annotation Get` or `Annotation Admin`'
      parameters:
        - name: experimentAnnotationId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Experiment Annotation that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing an experiment annotation's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment_annotation:
                    $ref: '#/components/schemas/ExperimentAnnotation'
  /experiment_tags:
    get:
      summary: Experiment Tags LIST
      description: '**Required Permissions**: `Experiment List` or `Experiment Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all experiment tags.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  experiment_tags:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExperimentTag'
  /experiment_tags/{experimentTagId}:
    get:
      summary: Experiment Tag GET
      description: '**Required Permissions**: `Experiment Get` or `Experiment Admin`'
      parameters:
        - name: experimentTagId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Experiment Tag that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing an experiment tag's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment_tag:
                    $ref: '#/components/schemas/ExperimentTag'
  /goal_tags:
    get:
      summary: Goal Tags LIST
      description: '**Required Permissions**: `Goal List` or `Goal Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all goal tags.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  goal_tags:
                    type: array
                    items:
                      $ref: '#/components/schemas/GoalTag'
  /goal_tags/{goalTagId}:
    get:
      summary: Goal Tag GET
      description: '**Required Permissions**: `Goal Get` or `Goal Admin`'
      parameters:
        - name: goalTagId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Goal Tag that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a goal tag's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  goal_tag:
                    $ref: '#/components/schemas/GoalTag'
  /goals:
    get:
      summary: Goals LIST
      description: '**Required Permissions**: `Goal List` or `Goal Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all goals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  goals:
                    type: array
                    items:
                      $ref: '#/components/schemas/Goal'
  /goals/{goalId}:
    get:
      summary: Goal GET
      description: '**Required Permissions**: `Goal Get` or `Goal Admin`'
      parameters:
        - name: goalId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Goal that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a goal's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  goal:
                    $ref: '#/components/schemas/Goal'
  /metric_tags:
    get:
      summary: Metric Tags LIST
      description: '**Required Permissions**: `Metric List` or `Metric Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all metrics tags.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  metric_tags:
                    type: array
                    items:
                      $ref: '#/components/schemas/MetricTag'
  /metric_tags/{metricTagId}:
    get:
      summary: Metric Tag GET
      description: '**Required Permissions**: `Metric Get` or `Metric Admin`'
      parameters:
        - name: metricTagId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Metric Tag that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a metric tag's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  metric_tag:
                    $ref: '#/components/schemas/MetricTag'
  /metrics:
    get:
      summary: Metrics LIST
      description: '**Required Permissions**: `Metric List` or `Metric Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
        - name: owners
          in: query
          schema:
            type: string
            pattern: ^,+
          required: false
          description: A list of owner_ids for filtering, separated by commas.
          example: 1,2,3
        - name: teams
          in: query
          schema:
            type: string
            pattern: ^,+
          required: false
          description: A list of team_ids for filtering, separated by commas.
          example: 1,2,3
      responses:
        '200':
          description: A JSON Object containing an array of all metrics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                    example: 1
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                    example: 1
                  metrics:
                    type: array
                    items:
                      $ref: '#/components/schemas/Metric'
  /metrics/{metricId}:
    get:
      summary: Metric GET
      description: '**Required Permissions**: `Metric Get` or `Metric Admin`'
      parameters:
        - name: metricId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the metric that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a metric's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  metric:
                    $ref: '#/components/schemas/Metric'
  /permission_categories:
    get:
      summary: Permission Categories LIST
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all permission categories.
          content:
            application/json:
              schema:
                type: object
                properties:
                  permission_categories:
                    type: array
                    items:
                      $ref: '#/components/schemas/PermissionCategories'
  /permissions:
    get:
      summary: Permissions LIST
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all permissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  permissions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Permission'
  /roles:
    get:
      summary: Roles LIST
      description: '**Required Permissions**: `Role List` or `Role Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all roles.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  roles:
                    type: array
                    items:
                      $ref: '#/components/schemas/Role'
  /roles/{roleId}:
    get:
      summary: Role GET
      description: '**Required Permissions**: `Role Get` or `Role Admin`'
      parameters:
        - name: roleId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Role that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a role's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  role:
                    $ref: '#/components/schemas/Role'
  /segments:
    get:
      summary: Segments LIST
      description: '**Required Permissions**: `Segment List` or `Segment Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all segments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  segments:
                    type: array
                    items:
                      $ref: '#/components/schemas/Segment'
  /segments/{segmentId}:
    get:
      summary: Segment GET
      description: '**Required Permissions**: `Segment Get` or `Segment Admin`'
      parameters:
        - name: segmentId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Segment that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a segment's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  segment:
                    $ref: '#/components/schemas/Segment'
  /teams:
    get:
      summary: Teams LIST
      description: '**Required Permissions**: `Team List` or `Team Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all teams.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  teams:
                    type: array
                    items:
                      $ref: '#/components/schemas/Team'
  /teams/{teamId}:
    get:
      summary: Team GET
      description: '**Required Permissions**: `Team Get` or `Team Admin`'
      parameters:
        - name: teamId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Team that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a team's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  team:
                    $ref: '#/components/schemas/Team'
  /unit_types:
    get:
      summary: Units LIST
      description: '**Required Permissions**: `UnitType List` or `UnitType Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all units.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  unit_types:
                    type: array
                    items:
                      $ref: '#/components/schemas/UnitType'
  /unit_types/{unitTypeId}:
    get:
      summary: Unit GET
      description: '**Required Permissions**: `UnitType Get` or `UnitType Admin`'
      parameters:
        - name: unitTypeId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Unit that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a unit's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unit_type:
                    $ref: '#/components/schemas/UnitType'
  /users:
    get:
      summary: Users LIST
      description: '**Required Permissions**: `User List` or `User Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all users.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
  /users/{userId}:
    get:
      summary: User GET
      description: '**Required Permissions**: `User Get` or `User Admin`'
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the User that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a user's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
  /users/{userId}/api_keys:
    get:
      summary: User API keys GET
      description: '**Required Permissions**: `User Get` or `User Admin`'
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the User that you wish to get the API Keys of.
      responses:
        '200':
          description: A JSON Object containing an array of all API keys that are linked to a user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  user_api_keys:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApiKey'
  /webhook_events:
    get:
      summary: Webhook Events LIST
      description: '**Required Permissions**: `Webhook List` or `Webhook Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all webhook events.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  webhook_events:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookEvent'
  /webhooks:
    get:
      summary: Webhooks LIST
      description: '**Required Permissions**: `Webhook List` or `Webhook Admin`'
      parameters:
        - name: sort
          in: query
          description: The object key to sort the results by.
          schema:
            type: string
            example: name
        - name: sort_asc
          in: query
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          schema:
            type: integer
            example: 1
        - name: items
          in: query
          schema:
            type: integer
            example: 5
      responses:
        '200':
          description: A JSON Object containing an array of all webhooks.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: integer
                  page:
                    type: integer
                    minimum: 1
                  total:
                    type: integer
                  webhooks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook'
  /webhooks/{webhookId}:
    get:
      summary: Webhook GET
      description: '**Required Permissions**: `Webhook Get` or `Webhook Admin`'
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            type: integer
          description: The id of the Webhook that you wish to get data from.
      responses:
        '200':
          description: A JSON Object containing a webhook's data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    $ref: '#/components/schemas/Webhook'
  /v1/segments:
    get:
      operationId: SegmentsList
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  segments:
                    items:
                      properties:
                        updated_by_user_id:
                          type: number
                          format: double
                        updated_at:
                          type: string
                          format: date-time
                        created_by_user_id:
                          type: number
                          format: double
                        created_at:
                          type: string
                          format: date-time
                        value_source_attribute:
                          type: string
                        description:
                          type: string
                        name:
                          type: string
                        id:
                          type: number
                          format: double
                      required:
                        - updated_by_user_id
                        - updated_at
                        - created_by_user_id
                        - created_at
                        - value_source_attribute
                        - description
                        - name
                        - id
                      type: object
                    type: array
                  total:
                    type: number
                    format: double
                  page:
                    type: number
                    format: double
                  items:
                    type: number
                    format: double
                required:
                  - segments
                  - total
                  - page
                  - items
                type: object
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      description: Retrieve a paginated list of segments with optional filtering, searching, and sorting.
      summary: Segments LIST
      tags:
        - Segments
      security: []
      parameters:
        - description: Comma-separated segment IDs to filter by
          in: query
          name: ids
          required: false
          schema:
            type: string
        - description: Case-insensitive search across name and description fields
          in: query
          name: search
          required: false
          schema:
            type: string
        - description: Field name to sort by (e.g. "name", "created_at")
          in: query
          name: sort
          required: false
          schema:
            type: string
        - description: Set to "true" for ascending sort order. Defaults to descending.
          in: query
          name: sort_asc
          required: false
          schema:
            type: string
        - description: Page number for pagination (starts at 1)
          in: query
          name: page
          required: false
          schema:
            format: int32
            type: integer
        - description: Number of items per page. Defaults to 10 when pagination is active.
          in: query
          name: items
          required: false
          schema:
            format: int32
            type: integer
        - description: Comma-separated list of fields to return (e.g. "id,name,created_at")
          in: query
          name: select
          required: false
          schema:
            type: string
    post:
      operationId: SegmentCreate
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items: {}
                    type: array
                  segment:
                    allOf:
                      - properties:
                          created_by:
                            allOf:
                              - properties:
                                  avatar:
                                    properties:
                                      crop_height:
                                        type: number
                                        format: double
                                      crop_width:
                                        type: number
                                        format: double
                                      crop_top:
                                        type: number
                                        format: double
                                      crop_left:
                                        type: number
                                        format: double
                                      base_url:
                                        type: string
                                      content_type:
                                        type: string
                                      file_name:
                                        type: string
                                      file_size:
                                        type: number
                                        format: double
                                      height:
                                        type: number
                                        format: double
                                      width:
                                        type: number
                                        format: double
                                      file_usage_id:
                                        type: number
                                        format: double
                                      created_by_user_id:
                                        type: number
                                        format: double
                                      created_at:
                                        type: string
                                        format: date-time
                                      id:
                                        type: number
                                        format: double
                                    required:
                                      - crop_height
                                      - crop_width
                                      - crop_top
                                      - crop_left
                                      - base_url
                                      - content_type
                                      - file_name
                                      - file_size
                                      - height
                                      - width
                                      - file_usage_id
                                      - created_by_user_id
                                      - created_at
                                      - id
                                    type: object
                                required:
                                  - avatar
                                type: object
                              - properties:
                                  date_format_locale:
                                    type: string
                                  demo_user:
                                    type: boolean
                                  last_login_failure_at:
                                    type: string
                                    format: date-time
                                  last_login_at:
                                    type: string
                                    format: date-time
                                  consecutive_login_failures:
                                    type: number
                                    format: double
                                  archived:
                                    type: boolean
                                  avatar_file_upload_id:
                                    type: number
                                    format: double
                                  job_title:
                                    type: string
                                  department:
                                    type: string
                                  last_name:
                                    type: string
                                  first_name:
                                    type: string
                                  email:
                                    type: string
                                  external_id:
                                    type: number
                                    format: double
                                  updated_by_user_id:
                                    type: number
                                    format: double
                                  updated_at:
                                    type: string
                                    format: date-time
                                  created_by_user_id:
                                    type: number
                                    format: double
                                  created_at:
                                    type: string
                                    format: date-time
                                  id:
                                    type: number
                                    format: double
                                required:
                                  - date_format_locale
                                  - demo_user
                                  - last_login_failure_at
                                  - last_login_at
                                  - consecutive_login_failures
                                  - archived
                                  - avatar_file_upload_id
                                  - job_title
                                  - department
                                  - last_name
                                  - first_name
                                  - email
                                  - external_id
                                  - updated_by_user_id
                                  - updated_at
                                  - created_by_user_id
                                  - created_at
                                  - id
                                type: object
                        required:
                          - created_by
                        type: object
                      - properties:
                          updated_by_user_id:
                            type: number
                            format: double
                          updated_at:
                            type: string
                            format: date-time
                          created_by_user_id:
                            type: number
                            format: double
                          created_at:
                            type: string
                            format: date-time
                          value_source_attribute:
                            type: string
                          description:
                            type: string
                          name:
                            type: string
                          id:
                            type: number
                            format: double
                        required:
                          - updated_by_user_id
                          - updated_at
                          - created_by_user_id
                          - created_at
                          - value_source_attribute
                          - description
                          - name
                          - id
                        type: object
                  ok:
                    type: boolean
                required:
                  - errors
                  - segment
                  - ok
                type: object
        '400':
          description: Unique constraint violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      description: Create a new segment. The name must be unique across all segments.
      summary: Segment CREATE
      tags:
        - Segments
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSegmentBody'
  /v1/segments/{id}:
    get:
      operationId: SegmentGet
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  segment:
                    allOf:
                      - properties:
                          created_by:
                            allOf:
                              - properties:
                                  avatar:
                                    properties:
                                      crop_height:
                                        type: number
                                        format: double
                                      crop_width:
                                        type: number
                                        format: double
                                      crop_top:
                                        type: number
                                        format: double
                                      crop_left:
                                        type: number
                                        format: double
                                      base_url:
                                        type: string
                                      content_type:
                                        type: string
                                      file_name:
                                        type: string
                                      file_size:
                                        type: number
                                        format: double
                                      height:
                                        type: number
                                        format: double
                                      width:
                                        type: number
                                        format: double
                                      file_usage_id:
                                        type: number
                                        format: double
                                      created_by_user_id:
                                        type: number
                                        format: double
                                      created_at:
                                        type: string
                                        format: date-time
                                      id:
                                        type: number
                                        format: double
                                    required:
                                      - crop_height
                                      - crop_width
                                      - crop_top
                                      - crop_left
                                      - base_url
                                      - content_type
                                      - file_name
                                      - file_size
                                      - height
                                      - width
                                      - file_usage_id
                                      - created_by_user_id
                                      - created_at
                                      - id
                                    type: object
                                required:
                                  - avatar
                                type: object
                              - properties:
                                  date_format_locale:
                                    type: string
                                  demo_user:
                                    type: boolean
                                  last_login_failure_at:
                                    type: string
                                    format: date-time
                                  last_login_at:
                                    type: string
                                    format: date-time
                                  consecutive_login_failures:
                                    type: number
                                    format: double
                                  archived:
                                    type: boolean
                                  avatar_file_upload_id:
                                    type: number
                                    format: double
                                  job_title:
                                    type: string
                                  department:
                                    type: string
                                  last_name:
                                    type: string
                                  first_name:
                                    type: string
                                  email:
                                    type: string
                                  external_id:
                                    type: number
                                    format: double
                                  updated_by_user_id:
                                    type: number
                                    format: double
                                  updated_at:
                                    type: string
                                    format: date-time
                                  created_by_user_id:
                                    type: number
                                    format: double
                                  created_at:
                                    type: string
                                    format: date-time
                                  id:
                                    type: number
                                    format: double
                                required:
                                  - date_format_locale
                                  - demo_user
                                  - last_login_failure_at
                                  - last_login_at
                                  - consecutive_login_failures
                                  - archived
                                  - avatar_file_upload_id
                                  - job_title
                                  - department
                                  - last_name
                                  - first_name
                                  - email
                                  - external_id
                                  - updated_by_user_id
                                  - updated_at
                                  - created_by_user_id
                                  - created_at
                                  - id
                                type: object
                        required:
                          - created_by
                        type: object
                      - properties:
                          updated_by_user_id:
                            type: number
                            format: double
                          updated_at:
                            type: string
                            format: date-time
                          created_by_user_id:
                            type: number
                            format: double
                          created_at:
                            type: string
                            format: date-time
                          value_source_attribute:
                            type: string
                          description:
                            type: string
                          name:
                            type: string
                          id:
                            type: number
                            format: double
                        required:
                          - updated_by_user_id
                          - updated_at
                          - created_by_user_id
                          - created_at
                          - value_source_attribute
                          - description
                          - name
                          - id
                        type: object
                required:
                  - segment
                type: object
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      description: Retrieve a single segment by its ID, including the user who created it.
      summary: Segment GET
      tags:
        - Segments
      security: []
      parameters:
        - description: The segment's numeric ID
          in: path
          name: id
          required: true
          schema:
            format: int32
            type: integer
    put:
      operationId: SegmentUpdate
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items: {}
                    type: array
                  segment:
                    allOf:
                      - properties:
                          created_by:
                            allOf:
                              - properties:
                                  avatar:
                                    properties:
                                      crop_height:
                                        type: number
                                        format: double
                                      crop_width:
                                        type: number
                                        format: double
                                      crop_top:
                                        type: number
                                        format: double
                                      crop_left:
                                        type: number
                                        format: double
                                      base_url:
                                        type: string
                                      content_type:
                                        type: string
                                      file_name:
                                        type: string
                                      file_size:
                                        type: number
                                        format: double
                                      height:
                                        type: number
                                        format: double
                                      width:
                                        type: number
                                        format: double
                                      file_usage_id:
                                        type: number
                                        format: double
                                      created_by_user_id:
                                        type: number
                                        format: double
                                      created_at:
                                        type: string
                                        format: date-time
                                      id:
                                        type: number
                                        format: double
                                    required:
                                      - crop_height
                                      - crop_width
                                      - crop_top
                                      - crop_left
                                      - base_url
                                      - content_type
                                      - file_name
                                      - file_size
                                      - height
                                      - width
                                      - file_usage_id
                                      - created_by_user_id
                                      - created_at
                                      - id
                                    type: object
                                required:
                                  - avatar
                                type: object
                              - properties:
                                  date_format_locale:
                                    type: string
                                  demo_user:
                                    type: boolean
                                  last_login_failure_at:
                                    type: string
                                    format: date-time
                                  last_login_at:
                                    type: string
                                    format: date-time
                                  consecutive_login_failures:
                                    type: number
                                    format: double
                                  archived:
                                    type: boolean
                                  avatar_file_upload_id:
                                    type: number
                                    format: double
                                  job_title:
                                    type: string
                                  department:
                                    type: string
                                  last_name:
                                    type: string
                                  first_name:
                                    type: string
                                  email:
                                    type: string
                                  external_id:
                                    type: number
                                    format: double
                                  updated_by_user_id:
                                    type: number
                                    format: double
                                  updated_at:
                                    type: string
                                    format: date-time
                                  created_by_user_id:
                                    type: number
                                    format: double
                                  created_at:
                                    type: string
                                    format: date-time
                                  id:
                                    type: number
                                    format: double
                                required:
                                  - date_format_locale
                                  - demo_user
                                  - last_login_failure_at
                                  - last_login_at
                                  - consecutive_login_failures
                                  - archived
                                  - avatar_file_upload_id
                                  - job_title
                                  - department
                                  - last_name
                                  - first_name
                                  - email
                                  - external_id
                                  - updated_by_user_id
                                  - updated_at
                                  - created_by_user_id
                                  - created_at
                                  - id
                                type: object
                        required:
                          - created_by
                        type: object
                      - properties:
                          updated_by_user_id:
                            type: number
                            format: double
                          updated_at:
                            type: string
                            format: date-time
                          created_by_user_id:
                            type: number
                            format: double
                          created_at:
                            type: string
                            format: date-time
                          value_source_attribute:
                            type: string
                          description:
                            type: string
                          name:
                            type: string
                          id:
                            type: number
                            format: double
                        required:
                          - updated_by_user_id
                          - updated_at
                          - created_by_user_id
                          - created_at
                          - value_source_attribute
                          - description
                          - name
                          - id
                        type: object
                  ok:
                    type: boolean
                required:
                  - errors
                  - segment
                  - ok
                type: object
        '400':
          description: Unique constraint violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      description: |-
        Update an existing segment's fields. Pass only the fields you want to change
        inside the "data" property of the request body.
      summary: Segment UPDATE
      tags:
        - Segments
      security: []
      parameters:
        - description: The segment's numeric ID
          in: path
          name: id
          required: true
          schema:
            format: int32
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSegmentBody'
    delete:
      operationId: SegmentDelete
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items: {}
                    type: array
                  ok:
                    type: boolean
                required:
                  - errors
                  - ok
                type: object
        '404':
          description: Segment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      description: Permanently delete a segment by its ID.
      summary: Segment DELETE
      tags:
        - Segments
      security: []
      parameters:
        - description: The segment's numeric ID
          in: path
          name: id
          required: true
          schema:
            format: int32
            type: integer
  /v1/platform_alerts:
    get:
      operationId: PlatformAlertsList
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                items:
                  properties:
                    message:
                      type: string
                    type:
                      $ref: '#/components/schemas/PlatformAlertType'
                    id:
                      type: number
                      format: double
                  required:
                    - message
                    - type
                    - id
                  type: object
                type: array
      summary: Platform Alerts LIST
      tags:
        - PlatformAlerts
      security: []
      parameters: []
  /v1/notifications/summary:
    get:
      operationId: NotificationSummary
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  notifications:
                    items:
                      properties:
                        experiment_type:
                          $ref: '#/components/schemas/ExperimentType'
                        created_by_id:
                          type: number
                          format: double
                        created_by_name:
                          type: string
                        created_at:
                          type: string
                        seen:
                          type: boolean
                        read:
                          type: boolean
                        full_on_variant:
                          type: number
                          format: double
                        related_field:
                          type: number
                          format: double
                        action_rationale:
                          properties:
                            experiment_type:
                              $ref: '#/components/schemas/ExperimentType'
                            label:
                              type: string
                            archived:
                              type: boolean
                            updated_at:
                              type: string
                              format: date-time
                            created_at:
                              type: string
                              format: date-time
                            name:
                              type: string
                            id:
                              type: number
                              format: double
                          required:
                            - experiment_type
                            - label
                            - archived
                            - updated_at
                            - created_at
                            - name
                            - id
                          type: object
                        related_entity_url:
                          type: string
                        related_entity_name:
                          type: string
                        related_entity_id:
                          type: number
                          format: double
                        type:
                          $ref: '#/components/schemas/NotificationType'
                        id:
                          type: number
                          format: double
                      required:
                        - experiment_type
                        - created_by_id
                        - created_by_name
                        - created_at
                        - seen
                        - read
                        - full_on_variant
                        - related_field
                        - action_rationale
                        - related_entity_url
                        - related_entity_name
                        - related_entity_id
                        - type
                        - id
                      type: object
                    type: array
                  next_cursor:
                    type: number
                    format: double
                  unread_count:
                    type: number
                    format: double
                  unseen_count:
                    type: number
                    format: double
                required:
                  - notifications
                  - next_cursor
                  - unread_count
                  - unseen_count
                type: object
      description: Get notification summary including unseen/unread counts and a paginated list of notifications.
      summary: Notification Summary GET
      tags:
        - Notifications
      security: []
      parameters:
        - description: Cursor-based pagination. Pass the last notification ID from the previous page.
          in: query
          name: cursor
          required: false
          schema:
            format: int32
            type: integer
  /v1/notifications/see:
    put:
      operationId: NotificationSee
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items: {}
                    type: array
                  ok:
                    type: boolean
                required:
                  - errors
                  - ok
                type: object
      description: Mark all unseen notifications as seen for the current user.
      summary: Notifications Seen UPDATE
      tags:
        - Notifications
      security: []
      parameters: []
  /v1/notifications/read:
    put:
      operationId: NotificationRead
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: string
                    type: array
                  ok:
                    type: boolean
                required:
                  - errors
                  - ok
                type: object
      description: |-
        Mark notifications as read/unread. If ids are provided, only those notifications are updated.
        If ids are omitted, all notifications for the current user are updated.
      summary: Notifications Read UPDATE
      tags:
        - Notifications
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadNotificationsBody'
  /v1/notifications/has-new:
    get:
      operationId: NotificationHasNew
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: boolean
      description: Check if there are new notifications since the given notification ID.
      summary: Notifications Has New GET
      tags:
        - Notifications
      security: []
      parameters:
        - description: The ID of the last known notification. Returns true if newer notifications exist.
          in: query
          name: last_notification_id
          required: false
          schema:
            format: int32
            type: integer
  /v1/events/quota:
    get:
      operationId: EventsQuotaGet
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  monthlyActiveUnitsQuotaMillions:
                    type: number
                    format: double
                  monthlyEventsQuotaMillions:
                    type: number
                    format: double
                required:
                  - monthlyActiveUnitsQuotaMillions
                  - monthlyEventsQuotaMillions
                type: object
      summary: Monthly Events Quota GET
      tags:
        - Events
      security: []
      parameters: []
  /v1/events/summary:
    get:
      operationId: EventSummaryGet
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  teams:
                    items:
                      properties:
                        color:
                          type: string
                        initials:
                          type: string
                        name:
                          type: string
                        id:
                          type: number
                          format: double
                      required:
                        - color
                        - initials
                        - name
                        - id
                      type: object
                    type: array
                  events:
                    items:
                      $ref: '#/components/schemas/EventSummaryRowType'
                    type: array
                required:
                  - teams
                  - events
                type: object
        '400':
          description: Invalid date range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      description: |-
        Retrieve a summary of experiment exposure and goal events grouped by date and team,
        for a given time range. Maximum range is 100 days.
      summary: Event Summary GET
      tags:
        - Events
      security: []
      parameters:
        - description: Unix timestamp (ms) for the start of the range. Defaults to 30 days ago.
          in: query
          name: from
          required: false
          schema:
            format: int32
            type: integer
        - description: Unix timestamp (ms) for the end of the range. Defaults to now.
          in: query
          name: to
          required: false
          schema:
            format: int32
            type: integer
  /v1/events/usageAlerts:
    get:
      operationId: UsageAlertGetAll
      summary: Usage Alert LIST
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  alerts:
                    items:
                      properties:
                        config_users:
                          items:
                            properties:
                              user_id:
                                type: number
                                format: double
                            required:
                              - user_id
                            type: object
                          type: array
                        enabled:
                          type: boolean
                        threshold_pct:
                          type: number
                          format: double
                        id:
                          type: number
                          format: double
                      required:
                        - config_users
                        - enabled
                        - threshold_pct
                        - id
                      type: object
                    type: array
                  ok:
                    type: boolean
                required:
                  - alerts
                  - ok
                type: object
      tags:
        - Events
      security: []
      parameters: []
    post:
      operationId: UsageAlertAdd
      summary: Usage Alert CREATE
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      enabled:
                        type: boolean
                      threshold_pct:
                        type: number
                        format: double
                      quota_type:
                        $ref: '#/components/schemas/BillingMetric'
                      created_at:
                        type: string
                        format: date-time
                      id:
                        type: number
                        format: double
                    required:
                      - enabled
                      - threshold_pct
                      - quota_type
                      - created_at
                      - id
                    type: object
                  ok:
                    type: boolean
                required:
                  - result
                  - ok
                type: object
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Events
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                user_ids:
                  items:
                    type: number
                    format: double
                  type: array
                threshold_pct:
                  type: number
                  format: double
              required:
                - user_ids
                - threshold_pct
              type: object
  /v1/events/usageAlerts/{id}:
    put:
      operationId: UsageAlertUpdate
      summary: Usage Alert UPDATE
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      enabled:
                        type: boolean
                      threshold_pct:
                        type: number
                        format: double
                      quota_type:
                        $ref: '#/components/schemas/BillingMetric'
                      created_at:
                        type: string
                        format: date-time
                      id:
                        type: number
                        format: double
                    required:
                      - enabled
                      - threshold_pct
                      - quota_type
                      - created_at
                      - id
                    type: object
                  ok:
                    type: boolean
                required:
                  - result
                  - ok
                type: object
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Events
      security: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: double
            type: number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                user_ids:
                  items:
                    type: number
                    format: double
                  type: array
                enabled:
                  type: boolean
                threshold_pct:
                  type: number
                  format: double
              required:
                - user_ids
                - enabled
                - threshold_pct
              type: object
    patch:
      operationId: UsageAlertPatch
      summary: Usage Alert PATCH
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      enabled:
                        type: boolean
                      threshold_pct:
                        type: number
                        format: double
                      quota_type:
                        $ref: '#/components/schemas/BillingMetric'
                      created_at:
                        type: string
                        format: date-time
                      id:
                        type: number
                        format: double
                    required:
                      - enabled
                      - threshold_pct
                      - quota_type
                      - created_at
                      - id
                    type: object
                  ok:
                    type: boolean
                required:
                  - result
                  - ok
                type: object
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Events
      security: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: double
            type: number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                user_ids:
                  items:
                    type: number
                    format: double
                  type: array
                enabled:
                  type: boolean
                threshold_pct:
                  type: number
                  format: double
              type: object
    delete:
      operationId: UsageAlertDelete
      summary: Usage Alert DELETE
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  ok:
                    type: boolean
                required:
                  - ok
                type: object
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Events
      security: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: double
            type: number
components:
  examples: {}
  headers: {}
  parameters: {}
  requestBodies: {}
  responses: {}
  schemas:
    Experiment:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: test_experiment
        iteration:
          type: integer
          minimum: 1
        state:
          type: string
          example: running
        development_at:
          type: string
          format: date-time
          nullable: true
        start_at:
          type: string
          format: date-time
          nullable: true
        stop_at:
          type: string
          format: date-time
          nullable: true
          example: null
        full_on_at:
          nullable: true
          type: string
          format: date-time
        full_on_variant:
          nullable: true
          type: integer
          minimum: 0
          maximum: 3
        last_seen_in_code_at:
          type: string
          format: date-time
          nullable: true
        nr_variants:
          type: integer
          maximum: 3
          minimum: 1
          example: 3
        percentages:
          type: string
          pattern: \d{2}\/\d{2}\/\d{2}
          example: 34/33/33
          nullable: true
        percentage_of_traffic:
          type: integer
          example: 100
        seed:
          type: string
          format: bigint
        traffic_seed:
          type: string
          format: bigint
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
          minimum: 1
        updated_at:
          type: string
          format: date-time
          nullable: true
        updated_by:
          $ref: '#/components/schemas/User'
        updated_by_user_id:
          type: integer
          minimum: 1
          nullable: true
        description:
          type: string
          example: This experiment's description
        unit_type:
          $ref: '#/components/schemas/UnitType'
        unit_type_id:
          type: integer
          example: 1
        primary_metric:
          $ref: '#/components/schemas/Metric'
        primary_metric_id:
          type: integer
          example: 20
        audience:
          type: string
          pattern: \{"filter":{and:\[]}}
        audience_strict:
          type: boolean
          example: false
        hypothesis:
          type: string
        prediction:
          type: string
        action_points:
          type: string
        implementation_details:
          type: string
        other:
          type: string
        minimum_detectable_effect:
          type: integer
          example: 10
          nullable: true
        archived:
          type: boolean
          example: false
        applications:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentApplication'
        variants:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentVariant'
        secondary_metrics:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentSecondaryMetric'
        previews:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentPreview'
        preview_variants:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentVariantPreview'
        teams:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentTeam'
        owners:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentOwner'
        experiment_tags:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentExperimentTag'
        notes:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentNote'
        new_experiment_notes:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentNote'
        favorited_users:
          type: array
          items:
            $ref: '#/components/schemas/UserFavoriteExperiment'
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentAlert'
        sample_size:
          nullable: true
          $ref: '#/components/schemas/ExperimentSampleSize'
        variant_screnshots:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentVariantScreenshot'
    ExperimentVariantScreenshot:
      type: object
      properties:
        experiment_id:
          type: integer
          example: 1
        variant:
          type: integer
          example: 2
        screenshot_file_upload_id:
          type: integer
          example: 14
        label:
          type: string
          example: Variant C's second iteration
        experiment:
          $ref: '#/components/schemas/Experiment'
        file_upload:
          $ref: '#/components/schemas/FileUpload'
    FileUsage:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        cropped:
          type: boolean
          example: false
        resize_on_demand:
          type: boolean
          example: false
        file_uploads:
          type: array
          items:
            $ref: '#/components/schemas/FileUpload'
    FileUpload:
      type: object
      properties:
        id:
          type: integer
        file_usage:
          $ref: '#/components/schemas/FileUsage'
        file_usage_id:
          type: integer
        width:
          type: integer
          example: 1080
        height:
          type: integer
          example: 720
        file_size:
          type: integer
        file_name:
          type: string
          example: avatar_john_doe.png
        content_type:
          type: string
          example: image/png
        base_url:
          type: string
          format: url
        crop_left:
          type: number
          format: float
        crop_top:
          type: number
          format: float
        crop_width:
          type: number
          format: float
        crop_height:
          type: number
          format: float
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        avatar_users:
          type: array
          items:
            $ref: '#/components/schemas/User'
        variant_screenshots:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentVariantScreenshot'
    ExperimentTag:
      type: object
      properties:
        id:
          type: integer
        tag:
          type: string
          example: stack:backend
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by:
          nullable: true
          $ref: '#/components/schemas/User'
        updated_by_user_id:
          nullable: true
          type: integer
        experiments:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentExperimentTag'
    Team:
      type: object
      properties:
        id:
          type: integer
        external_id:
          nullable: true
          type: integer
        name:
          type: string
          example: Marketing
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        updated_at:
          type: string
          format: date-time
          nullable: true
        updated_by:
          nullable: true
          $ref: '#/components/schemas/User'
        updated_by_user_id:
          type: integer
          nullable: true
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserTeam'
        experiments:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentTeam'
        goals:
          type: array
          items:
            $ref: '#/components/schemas/GoalTeam'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricTeam'
    UserTeam:
      type: object
      properties:
        user_id:
          type: integer
        user:
          $ref: '#/components/schemas/User'
        team_id:
          type: integer
        team:
          $ref: '#/components/schemas/Team'
    GoalTeam:
      type: object
      properties:
        goal_id:
          type: integer
        goal:
          $ref: '#/components/schemas/Goal'
        team_id:
          type: integer
        team:
          $ref: '#/components/schemas/Team'
    MetricTeam:
      type: object
      properties:
        metric_id:
          type: integer
        metric:
          $ref: '#/components/schemas/Metric'
        team_id:
          type: integer
        team:
          $ref: '#/components/schemas/Team'
    Goal:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: purchase
        description:
          type: string
          example: A goal for tracking how many purchases are made on any of our applications
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        updated_at:
          type: string
          format: date-time
          nullable: true
        updated_by:
          nullable: true
          $ref: '#/components/schemas/User'
        updated_by_user_id:
          type: integer
          nullable: true
        archived:
          type: boolean
          example: false
        tags:
          type: array
          items:
            $ref: '#/components/schemas/GoalGoalTag'
        teams:
          type: array
          items:
            $ref: '#/components/schemas/GoalTeam'
        owners:
          type: array
          items:
            $ref: '#/components/schemas/GoalOwner'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/Metric'
    GoalGoalTag:
      type: object
      properties:
        goal_id:
          type: integer
        goal:
          $ref: '#/components/schemas/Goal'
        goal_tag_id:
          type: integer
        goal_tag:
          $ref: '#/components/schemas/GoalTag'
    GoalOwner:
      type: object
      properties:
        goal:
          $ref: '#/components/schemas/Goal'
        goal_id:
          type: integer
        user:
          $ref: '#/components/schemas/User'
        user_id:
          type: integer
    GoalTag:
      type: object
      properties:
        id:
          type: integer
        tag:
          type: string
          example: psychological:Trust
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by:
          nullable: true
          $ref: '#/components/schemas/User'
        updated_by_user_id:
          type: integer
          nullable: true
        goals:
          type: array
          items:
            $ref: '#/components/schemas/GoalGoalTag'
    ExperimentSampleSize:
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
        required_sample_size:
          type: integer
          format: bigint
          example: 109234
        reached_at:
          type: string
          format: date-time
          nullable: true
          example: null
        reached_at_sample_size:
          type: integer
          format: bigint
          nullable: true
          example: null
    ExperimentPreview:
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        environment_type:
          enum:
            - development
            - production
        unit_count:
          type: integer
          format: bigint
        first_exposure_at:
          nullable: true
          type: string
          format: date-time
        last_exposure_at:
          nullable: true
          type: string
          format: date-time
        data_cutoff_at:
          nullable: true
          type: string
          format: date-time
        updated_at:
          nullable: true
          type: string
          format: date-time
    ExperimentNote:
      type: object
      properties:
        id:
          type: integer
        reply_to:
          $ref: '#/components/schemas/ExperimentNote'
          nullable: true
          example: null
        reply_to_note_id:
          type: integer
          nullable: true
          example: null
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        action:
          enum:
            - create
            - development
            - start
            - restart
            - edit
            - stop
            - full_on
            - comment
            - archive
            - unarchive
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        updated_at:
          type: string
          format: date-time
          nullable: true
        updated_by:
          $ref: '#/components/schemas/User'
          nullable: true
        updated_by_user_id:
          type: integer
          nullable: true
        note:
          type: string
          nullable: true
        variant:
          type: integer
          nullable: true
        new_experiment:
          $ref: '#/components/schemas/Experiment'
          nullable: true
        new_experiment_id:
          nullable: true
          type: integer
        reply_to_experiment_note:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentNote'
    ExperimentAlert:
      type: object
      properties:
        id:
          type: integer
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        type:
          enum:
            - cleanup_needed
            - audience_mismatch
            - sample_size_reached
            - sample_ratio_mismatch
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
        metadata:
          type: string
          nullable: true
    ExperimentVariantPreview:
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        metric:
          $ref: '#/components/schemas/Metric'
        metric_id:
          type: integer
        environment_type:
          enum:
            - development
            - production
        variant:
          type: integer
          maximum: 3
        unit_count:
          type: integer
          format: bigint
        first_exposure_at:
          nullable: true
          type: string
          format: date-time
        last_exposure_at:
          nullable: true
          type: string
          format: date-time
        value:
          type: number
          format: decimal
        mean:
          type: number
          format: decimal
        variance:
          type: number
          format: decimal
        pvalue:
          nullable: true
          type: number
          format: float
        impact:
          nullable: true
          type: number
          format: float
        impact_lower:
          nullable: true
          type: number
          format: float
        impact_upper:
          nullable: true
          type: number
          format: float
    ExperimentApplication:
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/Experiment'
        application:
          $ref: '#/components/schemas/Application'
        experiment_id:
          type: integer
        application_id:
          type: integer
        application_version:
          type: integer
          format: bigint
    Application:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: ios
        description:
          type: string
          example: Our iOS app
        created_at:
          type: string
          format: date-time
        created_by:
          $ref: '#/components/schemas/User'
        created_by_user_id:
          type: integer
        updated_at:
          type: string
          format: date-time
          nullable: true
        updated_by:
          $ref: '#/components/schemas/User'
          nullable: true
        updated_by_user_id:
          nullable: true
          type: integer
        archived:
          type: boolean
          example: false
        experiments:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentApplication'
    ExperimentTeam:
      experiment:
        $ref: '#/components/schemas/Experiment'
      experiment_id:
        type: integer
      team:
        $ref: '#/components/schemas/Team'
      team_id:
        type: integer
    ExperimentOwner:
      experiment:
        $ref: '#/components/schemas/Experiment'
      experiment_id:
        type: integer
      user:
        $ref: '#/components/schemas/User'
      user_id:
        type: integer
    ExperimentExperimentTag:
      experiment:
        $ref: '#/components/schemas/Experiment'
      experiment_id:
        type: integer
      experiment_tag:
        $ref: '#/components/schemas/ExperimentTag'
      experiment_tag_id:
        type: integer
    User:
      type: object
      properties:
        archived:
          type: boolean
          example: false
        avatar:
          type: object
          nullable: true
        avatar_file_upload_url:
          type: string
          example: /cropUrl/100x100/1.png
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
          minimum: 1
        department:
          type: string
          example: Marketing
        email:
          type: string
          format: email
    UserFavoriteExperiment:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/User'
        user_id:
          type: integer
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        created_at:
          type: string
          format: date-time
    UnitType:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: user_id
        description:
          type: string
          example: The ids of our users
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
        archived:
          type: boolean
          example: false
    Metric:
      type: object
      properties:
        id:
          type: integer
        goal_id:
          type: integer
          example: 70
        name:
          type: string
          example: Time to Book
        description:
          type: string
          example: The amount of time before a booking has been made
        type:
          type: string
          example: goal_time_to_achievement
        effect:
          type: string
          enum:
            - positive
            - negative
            - unknown
        archived:
          type: boolean
          example: false
        format_str:
          type: string
          example: '{}s'
        scale:
          type: integer
          example: 1
        precision:
          type: number
          example: 0
        value_source_property:
          type: string
          example: ''
        property_filter:
          type: string
          example: ''
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
          example: 1
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        goal:
          $ref: '#/components/schemas/Goal'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/MetricTag'
        owners:
          type: array
          items:
            $ref: '#/components/schemas/MetricOwner'
        teams:
          type: array
          items:
            $ref: '#/components/schemas/MetricTeam'
    MetricOwner:
      type: object
      properties:
        metric_id:
          type: integer
        user_id:
          type: integer
        user:
          $ref: '#/components/schemas/User'
    ExperimentVariant:
      type: object
      properties:
        config:
          type: string
          example: ''
        experiment_id:
          type: integer
          example: 1
        name:
          type: string
          example: Red Button
        variant:
          type: integer
          minimum: 0
          maximum: 3
    ExperimentSecondaryMetric:
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/Experiment'
        experiment_id:
          type: integer
        metric:
          $ref: '#/components/schemas/Metric'
        metric_id:
          type: integer
    ExperimentWritable:
      type: object
      properties:
        name:
          type: string
          example: experiment_name
        iteration:
          type: integer
          minimum: 1
        state:
          enum:
            - created
            - development
            - running
            - stopped
        nr_variants:
          type: integer
          example: 1
        percentages:
          type: string
          example: 34/33/33
        percentage_of_traffic:
          type: integer
          example: 100
        description:
          type: string
          example: An experiment into whether changing our cta_button to red will effect our monthly revenue
        unit_type:
          $ref: '#/components/schemas/ExperimentWritableUnitType'
        owners:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentWritableOwner'
        teams:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentWritableTeam'
        experiment_tags:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentWritableTag'
        hypothesis:
          type: string
        prediction:
          type: string
        action_points:
          type: string
        audience:
          type: string
        audience_strict:
          type: boolean
          example: true
        implementation_details:
          type: string
        other:
          type: string
        applications:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentWritableApplication'
        primary_metric:
          $ref: '#/components/schemas/ExperimentWritableMetric'
        secondary_metrics:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentWritableMetric'
        variants:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentVariant'
        variant_screenshots:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentVariantScreenshotWritable'
        minimum_detectable_effect:
          nullable: true
          type: string
    ExperimentWritableUnitType:
      type: object
      properties:
        unit_type_id:
          type: integer
    ExperimentWritableOwner:
      type: object
      properties:
        user_id:
          type: integer
    ExperimentWritableTeam:
      type: object
      properties:
        team_id:
          type: integer
    ExperimentWritableTag:
      type: object
      properties:
        experiment_tag_id:
          type: integer
    ExperimentWritableApplication:
      type: object
      properties:
        application_id:
          type: integer
        application_version:
          type: string
    ExperimentWritableMetric:
      type: object
      properties:
        metric_id:
          type: integer
    ExperimentVariantScreenshotWritable:
      type: object
      properties:
        variant:
          type: integer
        label:
          type: string
        file_upload:
          $ref: '#/components/schemas/FileUploadWritable'
    FileUploadWritable:
      type: object
      properties:
        data:
          type: string
        content_type:
          type: string
          example: image/png
        file_name:
          type: string
          example: headshot.png
        file_size:
          type: integer
        width:
          type: integer
          example: 500
        height:
          type: integer
          example: 500
        crop_left:
          type: integer
        crop_top:
          type: integer
        crop_width:
          type: integer
        crop_height:
          type: integer
        temp_url:
          nullable: true
          type: string
          format: url
    ApiKey:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: All CRUD API Key
        description:
          type: string
          example: An API key with all permissions
        key:
          type: string
          format: uuid
        permissions:
          type: string
          pattern: create,edit,delete,read
        used_at:
          nullable: true
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
    CORS:
      type: object
      properties:
        id:
          type: integer
        type:
          enum:
            - regex
            - specific
          example: specific
        origin:
          type: string
          format: url
        description:
          type: string
          example: Our homepage
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
    Environment:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: Sandbox
        description:
          type: string
          example: Our sandbox environment.
        type:
          enum:
            - development
            - production
        archived:
          type: boolean
          example: false
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
        updated_by:
          nullable: true
          $ref: '#/components/schemas/User'
    ExperimentAnnotation:
      type: object
      properties:
        id:
          type: integer
        timestamp:
          type: string
          format: date-time
        description:
          type: string
          example: This was just after a successful marketing campaign
        color:
          type: string
          pattern: ^#[A-Fa-f0-9]{6}
          example: '#CFC8FF'
        type:
          enum:
            - local
            - global
        experiment_id:
          type: integer
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
        updated_by:
          nullable: true
          $ref: '#/components/schemas/User'
    MetricTag:
      type: object
      properties:
        id:
          type: integer
        tag:
          type: string
          example: location:Header
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
    PermissionCategories:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
    Permission:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        category_id:
          type: integer
    Role:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: Admin
        description:
          type: string
          example: A role with all permissions except user CRUD
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        deletable:
          type: boolean
        default_user_role:
          type: boolean
          example: false
        full_admin_role:
          type: boolean
          example: false
        permissions:
          type: array
          items:
            type: object
            properties:
              permission_id:
                type: integer
              role_id:
                type: integer
              permission:
                $ref: '#/components/schemas/Permission'
        created_by:
          $ref: '#/components/schemas/User'
    Segment:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: Language
        description:
          type: string
          example: The user's language
        value_source_attribute:
          type: string
          example: language
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
    WebhookEvent:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: ExperimentCreated
        description:
          type: string
          example: Event generated when an experiment draft is created.
    Webhook:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: Slack
        description:
          type: string
          example: Our connection between experiments and Slack
        url:
          type: string
          format: url
        enabled:
          type: boolean
          example: true
        ordered:
          type: boolean
          example: false
        max_retries:
          type: integer
          example: 10
        created_at:
          type: string
          format: date-time
        created_by_user_id:
          type: integer
        updated_at:
          nullable: true
          type: string
          format: date-time
        updated_by_user_id:
          nullable: true
          type: integer
        created_by:
          $ref: '#/components/schemas/User'
        events:
          type: array
          items:
            type: object
            properties:
              webhook_id:
                type: integer
              webhook_event_id:
                type: integer
              enabled:
                type: boolean
              event:
                $ref: '#/components/schemas/WebhookEvent'
    ValidationErrorResponse:
      properties:
        ok:
          type: boolean
          enum:
            - false
          nullable: false
        errors:
          items:
            type: string
          type: array
      required:
        - ok
        - errors
      type: object
      additionalProperties: false
    Pick_SegmentCreateInput.Exclude_keyofSegmentCreateInput.AuditFields__:
      properties:
        name:
          type: string
        description:
          type: string
        value_source_attribute:
          type: string
      required:
        - name
        - description
        - value_source_attribute
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    Omit_SegmentCreateInput.AuditFields_:
      $ref: '#/components/schemas/Pick_SegmentCreateInput.Exclude_keyofSegmentCreateInput.AuditFields__'
      description: Construct a type with the properties of T except for those in type K.
    CreateSegmentBody:
      properties:
        name:
          type: string
        description:
          type: string
        value_source_attribute:
          type: string
      required:
        - name
        - description
        - value_source_attribute
      type: object
      additionalProperties: false
    Partial_Omit_SegmentCreateInput.AuditFields__:
      properties:
        name:
          type: string
        description:
          type: string
        value_source_attribute:
          type: string
      type: object
      description: Make all properties in T optional
    UpdateSegmentData:
      properties:
        name:
          type: string
        description:
          type: string
        value_source_attribute:
          type: string
      type: object
      additionalProperties: false
    UpdateSegmentBody:
      properties:
        data:
          $ref: '#/components/schemas/UpdateSegmentData'
      required:
        - data
      type: object
      additionalProperties: false
    PlatformAlertType:
      type: string
      enum:
        - info
        - warning
    NotificationType:
      type: string
      enum:
        - PLATFORM_RELEASE
        - TEAM_MEMBER_ADDED
        - TEAM_MEMBER_REMOVED
        - TEAM_MEMBER_ROLES_EDITED
        - EXPERIMENT_OWNER_ADDED
        - EXPERIMENT_STARTED
        - EXPERIMENT_ABORTED
        - EXPERIMENT_FULL_ON
        - EXPERIMENT_KEEP_CURRENT
        - EXPERIMENT_READY_FOR_DECISION
        - EXPERIMENT_ALERT_TRIGGERED
        - FEATURE_ON
        - FEATURE_OFF
        - EXPERIMENT_ACCESS_GRANTED
        - EXPERIMENT_ACCESS_REMOVED
        - METRIC_ACCESS_GRANTED
        - METRIC_ACCESS_REMOVED
        - GOAL_ACCESS_GRANTED
        - GOAL_ACCESS_REMOVED
        - USAGE_ALERT_THRESHOLD_REACHED
        - METRIC_REVIEW_REQUESTED
        - METRIC_APPROVED
        - METRIC_REVIEW_COMMENT_ADDED
    ExperimentType:
      type: string
      enum:
        - test
        - feature
        - test_template
        - feature_template
    ReadNotificationsBody:
      properties:
        read:
          type: boolean
          description: Whether to mark the notifications as read or unread. Defaults to true.
        ids:
          items:
            type: number
            format: double
          type: array
          description: Notification IDs to update. If omitted, all notifications for the user are updated.
      type: object
    EventSummaryRowType:
      properties:
        type:
          type: string
          enum:
            - exposure
            - goal
        team_id:
          type: number
          format: double
        count:
          type: number
          format: double
        date:
          type: number
          format: double
      required:
        - type
        - team_id
        - count
        - date
      type: object
    BillingMetric:
      type: string
      enum:
        - monthly_events
        - yearly_experiments
        - monthly_active_units
    ErrorResponse:
      properties:
        errors:
          items:
            type: string
          type: array
        ok:
          type: boolean
          enum:
            - false
          nullable: false
      required:
        - errors
        - ok
      type: object
  securitySchemes:
    UserApiKey:
      type: apiKey
      in: header
      description: A User API Key for API authorization. **Must be in the format "Api-Key your_user_api_key"**
      name: Authorization
      scheme: ^Api-Key\s\S+
externalDocs:
  description: Find out more about ABsmartly
  url: https://www.absmartly.com