ABMeter Audiences API

openapi: 3.2.0
info:
  title: Abmeter Ai Audiences API
  version: 1.0.0
  contact:
    name: ABMeter Support
    email: info@abmeter.com
  license:
    name: Commercial
    url: https://abmeter.ai/terms
  description: 'Operations tagged Audiences across 2 of this provider''s published API definitions: spec.yaml, abmeter-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://abmeter.ai/api/v1
  description: ABMeter API
security:
- bearerAuth: []
tags:
- name: Audiences
paths:
  /audiences:
    get:
      summary: List all global audiences
      description: Retrieve a list of all global audiences that can be used across multiple experiments and feature flags. Audiences define user segments through predicates or explicit user lists.
      security:
      - bearerAuth: []
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
          enum:
          - predicate
          - user_list
        description: Filter audiences by their type
      responses:
        '200':
          description: List of global audiences
          content:
            application/json:
              example:
              - slug: audience-internal-testers
                created_at: '2026-01-30T12:00:00Z'
                predicate: /test.*@example\.com$/
                type: predicate
                updated_at: '2026-01-30T12:00:00Z'
              - slug: audience-vip-users
                created_at: '2026-01-30T12:00:00Z'
                type: user_list
                updated_at: '2026-01-30T12:00:00Z'
                user_ids:
                - user1
                - user2
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalAudience'
      tags:
      - Audiences
      operationId: getAudiences
      x-operation-id-source: derived
    post:
      summary: Create a new global audience
      description: Create a new global audience that can be reused across multiple experiments and feature flags. Supports both predicate-based and explicit user list audiences.
      security:
      - bearerAuth: []
      parameters: []
      responses:
        '201':
          description: Predicate audience created successfully
        '400':
          description: Validation error
          content:
            application/json:
              example:
                error: Bad request
                status: 400
                details:
                  slug:
                  - can only contain lowercase letters, numbers and hyphens
                  predicate:
                  - can't be blank
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GlobalAudience'
              example:
                slug: audience-beta-users
                type: predicate
                predicate: /@beta\.com$/
      tags:
      - Audiences
      operationId: postAudiences
      x-operation-id-source: derived
    servers:
    - url: https://abmeter.ai/api/v1
      description: ABMeter API
  /audiences/{audience_slug}:
    parameters:
    - name: audience_slug
      in: path
      schema:
        $ref: '#/components/schemas/Slug'
      required: true
      description: The unique identifier of the audience
    get:
      summary: Get a specific global audience
      description: Retrieve detailed information about a specific global audience by its slug, including all configuration and user targeting criteria.
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Audience details
          content:
            application/json:
              example:
                slug: audience-test-domain-users
                created_at: '2026-01-30T12:00:00Z'
                predicate: /test.*@example\.com$/
                type: predicate
                updated_at: '2026-01-30T12:00:00Z'
              schema:
                $ref: '#/components/schemas/GlobalAudience'
        '404':
          description: Audience not found
          content:
            application/json:
              example:
                error: Audience 'non-existent' not found
                status: 404
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Audiences
      operationId: getAudiencesByAudienceSlug
      x-operation-id-source: derived
    patch:
      summary: Update a global audience
      description: Update an existing global audience configuration. Changes will affect all feature flags that use this audience.
      security:
      - bearerAuth: []
      parameters: []
      responses:
        '200':
          description: Predicate audience updated successfully
          content:
            application/json:
              example:
                slug: audience-qa-team
                created_at: '2026-01-30T12:00:00Z'
                predicate: /test.*@example\.com$/
                type: predicate
                updated_at: '2026-01-30T12:00:00Z'
              schema:
                $ref: '#/components/schemas/GlobalAudience'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                predicate:
                  type: string
                  example: /test.*@example\.com$/
                user_ids:
                  type: array
                  items:
                    type: string
                  example:
                  - user-a
                  - user-b
              description: Only include fields to be updated. The `type` of audience cannot be changed.
              example:
                predicate: /test.*@example\.com$/
      tags:
      - Audiences
      operationId: patchAudiencesByAudienceSlug
      x-operation-id-source: derived
    delete:
      summary: Delete a global audience
      description: Permanently delete a global audience. This action cannot be undone and will remove the audience from all associated experiments and feature flags.
      security:
      - bearerAuth: []
      responses:
        '204':
          description: Audience deleted successfully
      tags:
      - Audiences
      operationId: deleteAudiencesByAudienceSlug
      x-operation-id-source: derived
    servers:
    - url: https://abmeter.ai/api/v1
      description: ABMeter API
components:
  schemas:
    Error:
      type: object
      description: 'Standard error response format for all API endpoints


        **Important:** The response is ALWAYS an object/hash, never null or any other type.

        The `details` field, when present, is ALWAYS an object/hash (e.g., `{}` not `null` or `[]`).

        The `details` field may be omitted when there are no additional details to provide.'
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Machine-readable error code (optional)
        details:
          type: object
          description: 'Additional error details. When present, ALWAYS an object/hash.

            May contain field-specific errors or other structured information.

            Examples: `{"name": ["can''t be blank"]}` for validation errors, `{"message": "Invalid state"}` for other errors'
          additionalProperties: true
      required:
      - error
    Slug:
      type: string
      description: 'Standardized identifier for entities used across the API. Recommended format: each entity type has its own prefix pattern followed by a short alphanumeric identifier (e.g., parameter-ab4c, space-main, audience-control).'
    GlobalAudience:
      type: object
      description: Reusable targeting rules that can be used across multiple feature flags and experiments
      properties:
        slug:
          $ref: '#/components/schemas/Slug'
        type:
          type: string
          enum:
          - predicate
          - user_list
          description: 'Type of audience: predicate (Global audience based on user attributes) or user_list (Global audience with specific user IDs)'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - slug
      - type
      oneOf:
      - type: object
        properties:
          predicate:
            type: string
            description: Predicate expression for audience matching
        required:
        - predicate
      - type: object
        properties:
          user_ids:
            type: array
            items:
              type: string
            description: List of user IDs for this audience
            maxItems: 100
        required:
        - user_ids
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the ABMeter dashboard. Pass it in the Authorization header with 'Bearer' prefix.
x-refined-from:
- spec.yaml
- abmeter-ai-openapi.yml