Admiral Holdouts API

The holdouts API from Admiral — 5 operation(s) for holdouts.

GitHub OpenAPI

Operations 6

GET /holdouts/live Live Holdouts #
GET /accounts/{account_id}/holdouts/preflight Holdout Preflight #
GET /accounts/{account_id}/holdouts List Holdouts #
POST /accounts/{account_id}/holdouts Start Holdout #
GET /accounts/{account_id}/holdouts/{holdout_id} Get Holdout #
POST /accounts/{account_id}/holdouts/{holdout_id}/end End Holdout #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/meetadmiral-com:meetadmiral-com-holdouts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

meetadmiral-com-holdouts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Holdouts API
  version: 0.1.0
tags:
- name: holdouts
paths:
  /holdouts/live:
    get:
      tags:
      - holdouts
      summary: Live Holdouts
      description: 'Every split still running in the caller''s workspaces, with what the

        switch-off needs. Membership only, never product access: after a plan

        lapses the campaign pages do not load, and Billing (which does) lists

        these so a split still running in his account can always be switched

        off (Greptile on #467).'
      operationId: live_holdouts_holdouts_live_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /accounts/{account_id}/holdouts/preflight:
    get:
      tags:
      - holdouts
      summary: Holdout Preflight
      description: 'Can this campaign hold one, and how long would a reading take at

        each share. Reads only.'
      operationId: holdout_preflight_accounts__account_id__holdouts_preflight_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      - name: campaign_id
        in: query
        required: true
        schema:
          type: string
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/holdouts:
    get:
      tags:
      - holdouts
      summary: List Holdouts
      description: 'Every hold-out on the account, newest first, or one campaign''s.

        Membership only, like the switch: a lapsed plan must still see the split

        that is running in its account in order to switch it off.'
      operationId: list_holdouts_accounts__account_id__holdouts_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      - name: campaign_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - holdouts
      summary: Start Holdout
      operationId: start_holdout_accounts__account_id__holdouts_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HoldoutCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/holdouts/{holdout_id}:
    get:
      tags:
      - holdouts
      summary: Get Holdout
      operationId: get_holdout_accounts__account_id__holdouts__holdout_id__get
      parameters:
      - name: holdout_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Holdout Id
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /accounts/{account_id}/holdouts/{holdout_id}/end:
    post:
      tags:
      - holdouts
      summary: End Holdout
      description: 'Switch off. Membership only, never product access: a split that is

        still running in his account must stay switchable after a plan lapses.'
      operationId: end_holdout_accounts__account_id__holdouts__holdout_id__end_post
      parameters:
      - name: holdout_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Holdout Id
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HoldoutCreate:
      properties:
        campaign_id:
          type: string
          title: Campaign Id
        manual_share:
          type: integer
          maximum: 20.0
          minimum: 5.0
          title: Manual Share
          default: 10
      type: object
      required:
      - campaign_id
      title: HoldoutCreate
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError