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

# Get advertiser tracking configuration

> Get advertiser-level macro and third-party tracker defaults. Raw vendor URLs and their canonical AdCP-macro translations are retained separately with stable tracker IDs.



## OpenAPI

````yaml /v2/buyer-api-v2.yaml get /advertisers/{advertiserId}/tracking-config
openapi: 3.0.0
info:
  title: Scope3 Buyer API
  version: 2.0.0
  description: |-
    REST API for advertisers to manage advertisers, campaigns, and reporting.

    ## Authentication

    All endpoints require a Bearer token in the Authorization header:
    ```
    Authorization: Bearer your-api-key
    ```

    ## Base URL

    `https://api.interchange.io/api/v2/buyer`

    ## For AI Agents

    AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools:
    - `initialize`: Start an MCP session
    - `api_call`: Make REST API calls
    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/buyer
    description: Production server
security: []
tags:
  - name: Signup
    description: Request reviewed access to Interchange
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Advertisers
    description: Manage advertisers
  - name: Product Discovery
    description: Discover and select products
  - name: Campaigns
    description: Manage advertising campaigns
  - name: Creatives
    description: Build, manage, and sync campaign creatives via AdCP Creative Protocol
  - name: Reporting
    description: Access performance metrics
  - name: Event Sources
    description: >-
      Manage event source configurations and log conversion/marketing events for
      attribution
  - name: Property Lists
    description: Validate property lists against AAO registry
  - name: Sales Agents
    description: View and connect sales agents
  - name: Measurement
    description: Measurement sources, records, context, and freshness
  - name: Syndication
    description: Syndicate resources to ADCP agents
  - name: Tasks
    description: Track async operation status
  - name: Buyer Billing
    description: >-
      Consolidated invoicing for buyers — invoices and pending invoice items
      issued by Scope3 across the buyer customer.
  - name: MCP
    description: Model Context Protocol endpoints for AI agents
paths:
  /advertisers/{advertiserId}/tracking-config:
    get:
      tags:
        - Advertisers
      summary: Get advertiser tracking configuration
      description: >-
        Get advertiser-level macro and third-party tracker defaults. Raw vendor
        URLs and their canonical AdCP-macro translations are retained separately
        with stable tracker IDs.
      operationId: getAdvertiserTrackingConfig
      parameters:
        - in: path
          name: advertiserId
          schema:
            description: Unique identifier for the advertiser
            example: '12345'
            type: string
            minLength: 1
          required: true
          description: Unique identifier for the advertiser
      responses:
        '200':
          description: Get advertiser tracking configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingConfigResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    TrackingConfigResponse:
      description: Response containing tracking configuration
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TrackingConfigOutput'
      required:
        - data
      additionalProperties: false
    ErrorResponse:
      description: Standard error response
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
    TrackingConfigOutput:
      description: Full tracking configuration for an advertiser
      type: object
      properties:
        advertiser_id:
          description: Unique identifier for the advertiser
          example: '12345'
          type: string
        enabled_macros:
          description: System macros enabled on all tracking pixels for this advertiser
          type: array
          items:
            description: A valid system macro name for tracking pixels
            type: string
            enum:
              - CAMPAIGN_ID
              - CREATIVE_ID
              - TRACKING_TAG_ID
              - DATA_SET_ID
              - TACTIC_ID
              - MEDIA_BUY_ID
              - SALES_AGENT_ID
              - ATTRIBUTION_TRACKING_ID
              - DEVICE_ID
              - DEVICE_ID_TYPE
              - CACHEBUSTER
              - GDPR
              - GDPR_CONSENT
              - US_PRIVACY
              - LIMIT_AD_TRACKING
              - DEVICE_TYPE
              - OS
              - OS_VERSION
              - DEVICE_MAKE
              - DEVICE_MODEL
              - APP_BUNDLE
              - APP_NAME
              - COUNTRY
              - REGION
              - CITY
              - ZIP
              - DMA
              - LAT
              - LONG
              - PLACEMENT_ID
              - FOLD_POSITION
              - AD_WIDTH
              - AD_HEIGHT
              - VIDEO_ID
              - VIDEO_TITLE
              - VIDEO_DURATION
              - VIDEO_CATEGORY
              - CONTENT_GENRE
              - CONTENT_RATING
              - PLAYER_WIDTH
              - PLAYER_HEIGHT
              - POD_POSITION
              - POD_SIZE
              - AD_BREAK_ID
              - AXEM
              - TIMESTAMP
        custom_macros:
          description: Advertiser-defined custom macros
          type: array
          items:
            $ref: '#/components/schemas/CustomMacroOutput'
        impression_tracker_enabled:
          description: Whether impression tracking is enabled
          type: boolean
        click_tracker_enabled:
          description: Whether click tracking is enabled
          type: boolean
        custom_tracker_urls:
          description: Third-party tracker URL configurations
          type: array
          items:
            $ref: '#/components/schemas/TrackerResource'
        revision:
          description: Monotonic advertiser tracking configuration revision
          type: integer
          minimum: 0
          maximum: 9007199254740991
        created_at:
          description: When the tracking config was created (ISO 8601)
          example: '2025-01-15T10:30:00Z'
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        updated_at:
          description: When the tracking config was last updated (ISO 8601)
          example: '2025-01-20T14:45:00Z'
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
      required:
        - advertiser_id
        - enabled_macros
        - custom_macros
        - impression_tracker_enabled
        - click_tracker_enabled
        - custom_tracker_urls
        - revision
        - created_at
        - updated_at
      additionalProperties: false
    ApiError:
      description: Structured error object
      type: object
      properties:
        code:
          description: Machine-readable error code
          type: string
        message:
          description: Human-readable error message
          type: string
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
    CustomMacroOutput:
      description: An advertiser-defined custom macro for tracking URL expansion
      type: object
      properties:
        name:
          description: Custom macro name in UPPER_SNAKE_CASE format (e.g., UTM_SOURCE)
          example: UTM_SOURCE
          type: string
          minLength: 1
          maxLength: 50
          pattern: ^[A-Z][A-Z0-9_]*$
        param_key:
          description: URL parameter key used when expanding this macro
          example: utm_source
          type: string
          minLength: 1
          maxLength: 30
          pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
        description:
          description: Human-readable description of what this macro represents
          example: Identifies the traffic source for UTM tracking
          type: string
      required:
        - name
        - param_key
      additionalProperties: false
    TrackerResource:
      description: >-
        Persisted third-party tracker with stable identity, raw vendor input,
        canonical URL, and server-owned timestamps
      type: object
      properties:
        tracker_id:
          description: Stable third-party tracker resource identifier
          example: trk_0123456789abcdef01234567
          type: string
          pattern: ^trk_[a-f0-9]{24}$
        name:
          description: Display name for the tracker
          example: DoubleVerify Impression
          type: string
          minLength: 1
          maxLength: 100
        url:
          description: The third-party tracker URL
          example: https://tracker.doubleverify.com/pixel?id=123
          type: string
          format: uri
        tracker_type:
          description: Whether this tracker fires on impressions, clicks, or custom events
          type: string
          enum:
            - IMPRESSION
            - CLICK
            - CUSTOM
        custom_event_name:
          description: >-
            AdCP custom event name. Optional for V2 compatibility; required for
            publishable CUSTOM trackers and strict V3 writes.
          type: string
          minLength: 1
          maxLength: 100
        vendor_name:
          description: Human-readable measurement or tracking vendor name
          example: HappyDemics
          type: string
          minLength: 1
          maxLength: 100
        raw_url:
          type: string
          format: uri
        enabled:
          type: boolean
        source_dialect:
          description: Macro dialect of the retained raw tracker input
          type: string
          enum:
            - adcp
            - happydemics
            - gam
            - vast
            - custom
            - mixed
            - unknown
        compiler_version:
          description: Version of the raw-to-AdCP macro compiler
          type: string
          minLength: 1
          maxLength: 50
        mapping_artifact:
          description: Auditable macro mapping diagnostics and documentation provenance
          type: object
          additionalProperties: {}
        created_at:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        updated_at:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
      required:
        - tracker_id
        - name
        - url
        - tracker_type
        - raw_url
        - enabled
        - created_at
        - updated_at
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````