Magnite

Magnite Segments API

The Segments API from Magnite — 9 operation(s) for segments.

GitHub OpenAPI

Operations 12

GET /api/v0/segments Index #
POST /api/v0/segments Create #
GET /api/v0/segments/{id} Show #
PUT /api/v0/segments/{id} Update #
DELETE /api/v0/segments/{id} Destroy #
GET /api/v0/segments/{segment_id}/items Index #
POST /api/v0/segments/{segment_id}/items/bulk_create Bulk Create #
DELETE /api/v0/segments/{segment_id}/items/bulk_delete Bulk Delete #
POST /api/v0/segments/{segment_id}/items/bulk_replace Bulk Replace #
POST /api/v0/segments/{segment_id}/items/file_bulk_create File Bulk Create #
DELETE /api/v0/segments/{segment_id}/items/file_bulk_delete File Bulk Delete #
POST /api/v0/segments/{segment_id}/items/file_bulk_replace File Bulk Replace #

Documentation

📖
APIReference
https://api.springserve.com/api-docs
📖
Documentation
https://springserve.atlassian.net/wiki/spaces/SSD/pages/1584726013/SpringServe+API+SDK
📖
GettingStarted
https://springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/authentication/magnite-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/rate-limits/magnite-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/openapi/magnite-segments-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/errors/magnite-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/conventions/magnite-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/data-model/magnite-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/magnite/refs/heads/main/lifecycle/magnite-lifecycle.yml
🔗
SDKs
https://pypi.org/project/springserve/

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/magnite-segments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

magnite-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SpringServe UI API (V0) Segments API
  version: 0.1.0
  description: '> **_NOTE:_** This document covers the v0 API (`/api/v0`).'
security:
- api_key: []
- bearer_token: []
tags:
- name: Segments
paths:
  /api/v0/segments:
    get:
      summary: Index
      description: List all segments. Supports pagination via page, per, and ids params.
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: List of segments
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Segments
      operationId: segments_get
    post:
      summary: Create
      description: Creating a Segment
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              segment_list_create_simple:
                $ref: '#/components/examples/segment_list_create_simple'
              segment_list_create_full:
                $ref: '#/components/examples/segment_list_create_full'
              segment_pixel_create_simple:
                $ref: '#/components/examples/segment_pixel_create_simple'
              segment_pixel_create_full:
                $ref: '#/components/examples/segment_pixel_create_full'
        required: true
      responses:
        '201':
          description: Created segment
          content:
            application/json:
              schema:
                type: object
              example:
                name: My Cookie ID Segment
      tags:
      - Segments
      operationId: segments_post
  /api/v0/segments/{id}:
    get:
      summary: Show
      description: Get a segment
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Segment details
          content:
            application/json:
              schema:
                type: object
              example:
                id: 10044
                account_id: 1
                name: My DID Segment
                description: My description
                active: true
                segment_type: list
                segment_list_type: cookie
                created_at: '2020-03-18T19:17:01.383Z'
      tags:
      - Segments
      operationId: segments_id_get
    put:
      summary: Update
      description: Update a segment
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              segment_update_simple:
                $ref: '#/components/examples/segment_update_simple'
              segment_update_full:
                $ref: '#/components/examples/segment_update_full'
      responses:
        '200':
          description: Updated segment
          content:
            application/json:
              schema:
                type: object
      tags:
      - Segments
      operationId: segments_id_put
    delete:
      summary: Destroy
      description: Delete a segment
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      tags:
      - Segments
      operationId: segments_id_delete
  /api/v0/segments/{segment_id}/items:
    get:
      summary: Index
      description: Get Device IDs or Cookies in a Segment
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: List of segment items
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
              example:
              - item: d207654f-6bdd-474e-9734-67b7c3d02d96
              - item: d20gt57i-6bdd-474e-9734-67b7c3d02d96
      tags:
      - Segments
      operationId: segments_segment_id_items_get
  /api/v0/segments/{segment_id}/items/bulk_create:
    post:
      summary: Bulk Create
      description: Add elements to a Segment
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              segment_items_bulk_create_single:
                $ref: '#/components/examples/segment_items_bulk_create_single'
              segment_items_bulk_create_multiple:
                $ref: '#/components/examples/segment_items_bulk_create_multiple'
        required: true
      responses:
        '201':
          description: Created items
          content:
            application/json:
              schema:
                type: object
              example:
                created: true
      tags:
      - Segments
      operationId: segments_segment_id_items_bulk_create_post
  /api/v0/segments/{segment_id}/items/bulk_delete:
    delete:
      summary: Bulk Delete
      description: Remove specific Device Ids or Cookies
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              items:
              - d207654f-6bdd-474e-9734-67b7c3d02d96
      responses:
        '200':
          description: Deleted items
          content:
            application/json:
              schema:
                type: object
              example:
                deleted: true
      tags:
      - Segments
      operationId: segments_segment_id_items_bulk_delete_delete
  /api/v0/segments/{segment_id}/items/bulk_replace:
    post:
      summary: Bulk Replace
      description: Replace Entire Segment
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              segment_items_bulk_replace_single:
                $ref: '#/components/examples/segment_items_bulk_replace_single'
              segment_items_bulk_replace_multiple:
                $ref: '#/components/examples/segment_items_bulk_replace_multiple'
        required: true
      responses:
        '200':
          description: Replaced items
          content:
            application/json:
              schema:
                type: object
              example:
                created: true
      tags:
      - Segments
      operationId: segments_segment_id_items_bulk_replace_post
  /api/v0/segments/{segment_id}/items/file_bulk_create:
    post:
      summary: File Bulk Create
      description: Add Items to a Segment using a File
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - csv_file
              properties:
                csv_file:
                  type: string
                  format: binary
                  description: CSV file containing device IDs or cookies to append
        required: true
      responses:
        '201':
          description: Append confirmation
          content:
            application/json:
              schema:
                type: object
              example:
                created: true
      tags:
      - Segments
      operationId: segments_segment_id_items_file_bulk_create_post
  /api/v0/segments/{segment_id}/items/file_bulk_delete:
    delete:
      summary: File Bulk Delete
      description: Remove specific items using a File
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - csv_file
              properties:
                csv_file:
                  type: string
                  format: binary
                  description: CSV file containing device IDs or cookies to remove
      responses:
        '200':
          description: Deletion confirmation
          content:
            application/json:
              schema:
                type: object
              example:
                deleted: true
      tags:
      - Segments
      operationId: segments_segment_id_items_file_bulk_delete_delete
  /api/v0/segments/{segment_id}/items/file_bulk_replace:
    post:
      summary: File Bulk Replace
      description: Replace Entire Segment with a File
      parameters:
      - name: segment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - csv_file
              properties:
                csv_file:
                  type: string
                  format: binary
                  description: CSV file containing device IDs or cookies to replace existing segment
        required: true
      responses:
        '200':
          description: Replacement confirmation
          content:
            application/json:
              schema:
                type: object
              example:
                created: true
      tags:
      - Segments
      operationId: segments_segment_id_items_file_bulk_replace_post
components:
  examples:
    segment_items_bulk_replace_multiple:
      summary: Replace with multiple items
      value:
        items:
        - d207654f-6bdd-474e-9734-67b7c3d02d96
        - a1b2c3d4-6bdd-474e-9734-67b7c3d02d96
    segment_pixel_create_full:
      summary: Pixel segment (full)
      value:
        name: Segment Name
        description: Segment description
        segment_type: pixel
        segment_pixel_type: device_id
        user_expiration_value: 30
        active: true
    segment_items_bulk_replace_single:
      summary: Replace with single item
      value:
        items:
        - d207654f-6bdd-474e-9734-67b7c3d02d96
    segment_list_create_simple:
      summary: List segment (simple)
      value:
        name: Segment Name
        segment_type: list
        segment_list_type: cookie
    segment_update_full:
      summary: Update segment (full)
      value:
        name: Segment Name
        description: Segment description
        active: true
    segment_update_simple:
      summary: Update segment (simple)
      value:
        name: Segment Name
        active: true
    segment_items_bulk_create_multiple:
      summary: Add multiple items
      value:
        items:
        - d207654f-6bdd-474e-9734-67b7c3d02d96
        - a1b2c3d4-6bdd-474e-9734-67b7c3d02d96
    segment_pixel_create_simple:
      summary: Pixel segment (simple)
      value:
        name: Segment Name
        segment_type: pixel
        segment_pixel_type: device_id
        user_expiration_value: 30
    segment_items_bulk_create_single:
      summary: Add single item
      value:
        items:
        - d207654f-6bdd-474e-9734-67b7c3d02d96
    segment_list_create_full:
      summary: List segment (full)
      value:
        name: Segment Name
        description: Segment description
        segment_type: list
        segment_list_type: cookie
        active: true
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth