IX API 2

    • HOME
    • API REFERENCE
    • RELEASE NOTES
    • LOG IN

    IX API Reference Documentation

    Welcome to the Index Exchange API reference portal. How can we help you?

      API Reference
    HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
      API Reference
    discard
    Only admins can see thisEnable it for everyone

    IX API Reference

    • About IX APIs
    • Available APIs
    • Sending requests
    • Response format

    Publisher API

    • Getting started with the Publisher API
      • Authentication
      • Generate an API key
      • post
        Generate OAuth token
      • Authenticate requests with the OAuth token
      • Error status codes
      • Error codes
      • Rate limits
    • User profile
      • get
        User profile
    • Inventory setup
      • post
        Site tag
      • put
        Site tag
      • patch
        Site tag
      • delete
        Site tag
      • get
        Site information
      • get
        Site categories
      • post
        Aliases
      • put
        Aliases
      • delete
        Aliases
      • post
        Placement
      • put
        Placement
      • patch
        Placement
      • delete
        Placement
      • get
        Placement information
      • get
        Priority
      • patch
        Priority
      • get
        Tier information
      • get
        Tier
      • put
        Tier
      • patch
        Tier
      • delete
        Tier
    • Floor types and criteria
      • get
        Site floor types
      • get
        Site floor
      • put
        Site floor
      • delete
        Site floor
      • get
        Placement floor types
      • get
        Placement floors
      • put
        Placement floor
      • delete
        Placement floor
      • get
        Tier floor types
      • get
        Tier floor
      • put
        Tier floor
      • delete
        Tier floor
      • get
        Passbacks
      • put
        Passback
      • patch
        Passback
      • delete
        Passback
      • get
        Creative types
    • Private Marketplace
      • get
        Deal
      • put
        Deal
      • patch
        Deal
      • delete
        Deal
      • get
        Publisher deal information
      • get
        Deal configuration information
      • get
        Deal custom field definition
      • post
        Deal custom field value
      • put
        Deal custom field value
      • get
        Deal sections
      • put
        Deal section
      • patch
        Deal section
      • delete
        Deal section
    • Inventory Controls
      • post
        Campaign names
      • post
        Campaign brands
      • post
        Campaign content groups
      • get
        Ad units
      • get
        Audience segments
      • get
        Audience types
      • get
        Brand criteria
      • post
        Brand name
      • get
        Brands
      • get
        Buyers
      • get
        Content groups
      • get
        Country codes
      • get
        Domain depths
      • get
        DSPs
      • get
        Tier timeouts
      • get
        Trading desks
      • get
        Auto-approval settings
      • post
        Blacklisted campaigns
      • post
        Blocked brand criteria
      • post
        Blocked buyers
      • post
        Blocked content groups
      • post
        Blocked DSPs
      • post
        Blocked trading desks
      • post
        Whitelisted campaigns
      • put
        Brand criteria
      • put
        Brands
      • put
        Buyers
      • put
        Content groups
      • put
        DSPs
      • put
        Trading desks
      • put
        Site settings
    • Reporting
      • post
        Earnings statistics
      • post
        Earnings statistics by hour
      • post
        Losing bids
      • post
        Private earnings statistics
      • post
        Private earnings statistics by hour
      • get
        Served and deleted deals
      • get
        Served and deleted placements
      • get
        Served and deleted tiers
      • post
        Unfilled statistics
      • post
        Get winning bids

    CAL API

    • Getting Started with the Client Audit Logs API
      • Authentication
      • Error status codes
    • Log retrieval
      • get
        Impression event logs
      • get
        Bid event logs
      • get
        Download log file
    • Mappings service
      • get
        Buyer mapping
      • get
        Campaign mapping
      • get
        Deal mapping
      • get
        DSP mapping
      • get
        Site mapping
      • get
        Partner mapping
    • Exchange rate service
      • get
        Exchange rates
    • Code examples
      • Log retrieval and storage via python + AWS
      • Hourly aggregations to AWS via python
      • Download bid event log files and upload to AWS S3

    Keymaster API

    • Getting started with the Keymaster API
      • Authentication
      • Error status codes
      • post
        Access token
      • post
        Refresh access token
      • put
        Forgot password
      • put
        Reset password
    • put
      Key pairs
    • get
      Key pairs

    Blackbird API

    • Getting started with the Blackbird API
      • Authentication
      • Error status codes
      • post
        Access token
      • post
        Refresh access token
      • put
        Forgot password
      • put
        Reset password
    • delete
      People-based identifier