openapi: 3.2.0
info:
  title: Console Configs API
  description: The "Console API" is the CRUD API for performing the actions offered on console.statsig.com without needing to go through the web UI.
  version: 20240601.0.0
  contact: {}
servers:
- url: https://statsigapi.net
tags:
- name: Configs
paths:
  /console/v1/exposure_count:
    get:
      summary: Read Exposure Event Count
      description: Get the count of exposure events recently received by Statsig.
      parameters:
      - name: experiments
        required: false
        in: query
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
            maxItems: 25
      - name: gates
        required: false
        in: query
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
            maxItems: 25
      - name: dynamicConfigs
        required: false
        in: query
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
            maxItems: 25
      responses:
        '200':
          description: Get Experiment Success
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SingleDataResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/ExposureCountDto'
                example:
                  message: Exposure count fetched successfully.
                  data:
                    gates:
                    - id: a_gate
                      pastDay: 0
                      past7Days: 98
                    experiments:
                    - id: my_experiment
                      pastDay: 102
                      past7Days: 558
                    - id: another_experiment
                      pastDay: 5904
                      past7Days: 2078
                    dynamicConfigs:
                    - id: dc_limit
                      pastDay: 240830
                      past7Days: 1329945
              example:
                message: Exposure count fetched successfully.
                data:
                  gates:
                  - id: a_gate
                    pastDay: 0
                    past7Days: 98
                  experiments:
                  - id: my_experiment
                    pastDay: 102
                    past7Days: 558
                  - id: another_experiment
                    pastDay: 5904
                    past7Days: 2078
                  dynamicConfigs:
                  - id: dc_limit
                    pastDay: 240830
                    past7Days: 1329945
        '400':
          description: Invalid request. Please check the request input and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    enum:
                    - 400
                  message:
                    type: string
                required:
                - status
                - message
              examples:
                Invalid Request:
                  value:
                    status: 400
                    message: Data is not available
        '401':
          description: 'This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    enum:
                    - 401
                  message:
                    type: string
                required:
                - status
                - message
              examples:
                Invalid Endpoint:
                  value:
                    status: 401
                    message: 'This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx'
      tags:
      - Configs
      security:
      - STATSIG-API-KEY: []
      operationId: getConsoleV1ExposureCount
      x-operation-id-source: derived
components:
  schemas:
    ExposureCountDto:
      type: object
      properties:
        gates:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              pastDay:
                type: number
              past7Days:
                type: number
            required:
            - id
            - pastDay
            - past7Days
          maxItems: 25
          description: ids of gates to query (max 25)
        experiments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              pastDay:
                type: number
              past7Days:
                type: number
            required:
            - id
            - pastDay
            - past7Days
          maxItems: 25
          description: ids of experiments to query (max 25)
        dynamicConfigs:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              pastDay:
                type: number
              past7Days:
                type: number
            required:
            - id
            - pastDay
            - past7Days
          maxItems: 25
          description: ids of dynamic configs to query (max 25)
      required:
      - gates
      - experiments
      - dynamicConfigs
    SingleDataResponse:
      type: object
      properties:
        message:
          type: string
          description: A simple string explaining the result of the operation.
        data:
          type: object
          description: A single result.
      required:
      - message
      - data
  securitySchemes:
    STATSIG-API-KEY:
      type: apiKey
      name: STATSIG-API-KEY
      in: header