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

# Experimentos

> Cada experimento sobre um elemento ou um agente, braço a braço contra `control`, com CUPED e o teste sequencial de mistura, cujo p-valor vale em qualquer leitura.



## OpenAPI

````yaml openapi/pt/cell.json GET /v1/measure/experiments
openapi: 3.1.0
info:
  title: API de dados da Niadra
  version: '1'
  description: >-
    Escrita, contexto, histórico, objetos, identidade, privacidade e governança
    de um espaço. Cada espaço tem um endereço estável, com o espaço e a região
    no nome.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: O espaço, que vem na chave de fonte.
      region:
        default: us-east-2
        description: A região do espaço, que também vem na chave.
security: []
paths:
  /v1/measure/experiments:
    get:
      tags:
        - signals
      summary: Experimentos
      description: >-
        Cada experimento sobre um elemento ou um agente, braço a braço contra
        `control`: ajustado por CUPED, com o teste sequencial de mistura, cujo
        p-valor e intervalo valem por mais vezes que o relatório seja lido.


        **Autenticação.** Token de pessoa do Console com o papel `analysis` (ou
        admin), ou chave de fonte com o escopo `admin`. Só responde num espaço
        com a funcionalidade `measurement` ligada (o documento `features`); num
        espaço sem ela, 404.
      operationId: experiments_v1_measure_experiments_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentReport'
          description: Resposta de sucesso.
      security:
        - sourceKey: []
        - personToken: []
components:
  schemas:
    ExperimentReport:
      additionalProperties: false
      description: >-
        Cada experimento sobre um elemento ou um agente, braço a braço, a partir
        do que as pessoas fizeram depois de designadas: incremental, como só um
        grupo de controle diz.
      properties:
        as_of:
          format: date-time
          title: As Of
          type: string
        experiments:
          items:
            $ref: '#/components/schemas/ExperimentResult'
          title: Experiments
          type: array
      required:
        - as_of
        - experiments
      title: ExperimentReport
      type: object
    ExperimentResult:
      additionalProperties: false
      properties:
        agent:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent
        alpha:
          title: Alpha
          type: number
        arms:
          items:
            $ref: '#/components/schemas/ArmOutcomes'
          title: Arms
          type: array
        comparisons:
          description: Vazio até cada braço ter gente bastante para a aproximação normal.
          items:
            $ref: '#/components/schemas/ArmComparison'
          title: Comparisons
          type: array
        cuped_days:
          description: Os dias antes da designação de cada pessoa tomados como covariável.
          title: Cuped Days
          type: integer
        element:
          anyOf:
            - type: string
            - type: 'null'
          title: Element
        ends_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Ends At
        experiment:
          maxLength: 256
          minLength: 1
          title: Experiment
          type: string
        kind:
          enum:
            - element
            - agent
          title: Kind
          type: string
        starts_at:
          format: date-time
          title: Starts At
          type: string
      required:
        - experiment
        - kind
        - starts_at
        - alpha
        - cuped_days
        - arms
        - comparisons
      title: ExperimentResult
      type: object
    ArmOutcomes:
      additionalProperties: false
      description: >-
        As pessoas de um braço e o que elas fizeram depois de designadas, a
        partir dos vínculos de desfecho.
      properties:
        arm:
          title: Arm
          type: string
        converted:
          description: Pessoas com um desfecho num estado de sucesso.
          title: Converted
          type: integer
        outcomes:
          title: Outcomes
          type: integer
        people:
          title: People
          type: integer
        value_minor:
          description: >-
            O dinheiro das linhas delas, cada linha uma vez, seja qual for o
            método.
          title: Value Minor
          type: integer
      required:
        - arm
        - people
        - converted
        - outcomes
        - value_minor
      title: ArmOutcomes
      type: object
    ArmComparison:
      additionalProperties: false
      description: >-
        Um braço contra `control` numa métrica, ajustado por CUPED quando o
        histórico varia, com o teste sequencial de mistura: o p-valor e o
        intervalo valem em qualquer leitura, então o relatório pode ser lido
        todo dia.
      properties:
        arm:
          title: Arm
          type: string
        arm_mean:
          title: Arm Mean
          type: number
        ci_high:
          title: Ci High
          type: number
        ci_low:
          description: O intervalo sempre válido de `difference`, no `alpha` do teste.
          title: Ci Low
          type: number
        control_mean:
          description: Por pessoa, antes do ajuste.
          title: Control Mean
          type: number
        decided:
          description: '`p_value` igual ou abaixo de `alpha`: a diferença é real.'
          title: Decided
          type: boolean
        difference:
          description: O braço menos o controle, por pessoa, ajustado.
          title: Difference
          type: number
        looks:
          description: As leituras diárias guardadas antes desta.
          title: Looks
          type: integer
        metric:
          enum:
            - conversion
            - value
          title: Metric
          type: string
        p_value:
          description: O mínimo corrente sobre as leituras diárias e esta.
          title: P Value
          type: number
        relative:
          anyOf:
            - type: number
            - type: 'null'
          description: '`difference` sobre a média do controle.'
          title: Relative
        variance_reduction:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            A parte da variância que o CUPED removeu; ausente quando ele não se
            aplicou.
          title: Variance Reduction
      required:
        - arm
        - metric
        - control_mean
        - arm_mean
        - difference
        - relative
        - ci_low
        - ci_high
        - variance_reduction
        - p_value
        - decided
        - looks
      title: ArmComparison
      type: object
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````