Outbrain

Outbrain Multiple Conversions API

Multiple Conversions gives the ability to track any of the actions a user takes after clicking through to your content. You can track everything from top of funnel (page landings and time on site) to bottom of funnel (e-book downloads and product purchases). Please note: This new feature requires the installation of the new multiple conversion pixel which can be retrieved from your account on Outbrain.com. If you have the old conversion pixel placed you will need to remove that before installing the Multiple Conversion Pixel. If both pixels are installed there will be overcounting of data and results will be inaccurate.

GitHub OpenAPI

Operations 5

GET /conversionEvents/{id} Retrieve a Single Conversion Event #
PUT /conversionEvents/{id} Update a Conversion Event #
POST /marketers/{marketerId}/conversionEvents Create a Conversion Event #
GET /marketers/{id}/conversionEvents Retrieve all Marketer's Conversion Events #
GET /marketers/{id}/engagementMetrics Retrieve Marketer's Engagement Metrics #

Documentation

📖
APIReference
https://amplifyv01.docs.apiary.io/
📖
Documentation
https://developer.outbrain.com/home-page/amplify-api/documentation/
📖
APIReference
https://teadsapi.docs.apiary.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/outbrain/refs/heads/main/openapi/outbrain-multiple-conversions-api-openapi.yml

Other Resources

🔗
SignUp
https://www.outbrain.com/partner-api/
🔗
ErrorCodes
https://raw.githubusercontent.com/api-evangelist/outbrain/refs/heads/main/errors/outbrain-error-codes.yml
🔗
Support
mailto:api@teads.tv

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/outbrain-multiple-conversions-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

outbrain-multiple-conversions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Outbrain Amplify Multiple Conversions API
  version: '0.1'
  description: This API describes the interfaces for interacting with the Outbrain Amplify product.
  contact:
    name: Outbrain Developer Center
    url: https://developer.outbrain.com
servers:
- url: https://api.outbrain.com/amplify/v0.1
  description: Production Server
security:
- OBTokenAuth: []
tags:
- name: Multiple Conversions
  description: Multiple Conversions gives the ability to track any of the actions a user takes after clicking through to your content.
paths:
  /conversionEvents/{id}:
    get:
      operationId: getConversionEventsId
      summary: Retrieve a Single Conversion Event
      description: 'The Conversion Event object has the following attributes:


        Property

        Type

        Semantic

        Example


        id

        String

        The id of this Conversion Event. read-only

        "00f4b02153ee75f3c9dc4fc128ab041962"


        name

        String

        The name of this Conversion Event.

        "My Conversion Event"


        type

        ConversionEventType

        The type of this Conversion Event

        URL_BASED


        url

        String

        The url configured for this Conversion Event

        "/thank-you"


        marketerId

        String

        The marketer Id of this Conversion Event

        "00f4b02153ee75f3c9dc4fc128ab041962"


        enabled

        Boolean

        Indicates if the Conversion Event is enabled You can have up to 60 enabled conversions at one time

        true


        conversionWindow

        Integer

        The conversion window you’re looking to track. This is the time it takes from click to conversion. The default is 60 days, but you may select any whole number between 1-60.

        50


        includeInConversions

        Boolean

        Indicates if you’d like to include these conversions in your total conversions reporting

        true


        trackingStatus

        TrackingStatus

        Indicates if the conversion event is active or inactive

        ACTIVE


        category

        ConversionEventCategory

        The category of this Conversion Event

        PURCHASE


        orderValue

        OrderValue

        The value of your conversion to help track overall ROI.

        ''{"value": 100, "currency": "USD"}''


        segment

        ConversionEventSegment

        The conversion segment, if such exists. read-only


        lastModified

        Date

        The time when the Conversion Event was last modified. read-only

        "2013-03-16 10:32:31"


        creationTime

        Date

        The time when the Conversion Event was created. read-only

        "2013-01-18 07:19:16"


        timeOnPageSettingValue

        Integer

        Relevant only for TIME_ON_PAGE engagment conversions. The number of seconds a user stays on a page with Outbrain pixel, that will trigger the conversion TIME_ON_PAGE

        30


        scrollDepthSettingValue

        Integer

        Relevant only for SCROLL_DEPTH engagment conversions. The percentage of scroll (out of the total webview) a user performs on a page with Outbrain pixel, that will trigger the conversion SCROLL_DEPTH

        50


        source

        String

        Relevant only for SCROLL_DEPTH and TIME_ON_PAGE engagment conversions. The should always say "OUTBRAIN"

        "OUTBRAIN"'
      tags:
      - Multiple Conversions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: the Conversion Event's id
        example: 00f4b02153ee75f3c9dc4fc128ab041962
      responses:
        '200':
          description: JSON representation of Marketer Resource
          content:
            application/json:
              schema:
                type: object
              example:
                enabled: true
                url: /thank-you
                includeInConversions: true
                creationTime: '2017-06-07 22:39:21'
                conversionWindow: 60
                lastModified: '2017-06-09 01:49:33'
                type: URL_BASED
                marketerId: 007514a95316bh6fe7ejc0cad101c23343
                name: My Conversion Event
                trackingStatus: ACTIVE
                category: PURCHASE
                id: 00177f47ba1ff1118s86dd1898adbb6e07
          headers:
            AMPLIFY-REQUEST-ID:
              description: Request correlation / rate-limit signal
              schema:
                type: string
        '400':
          description: Bad Request - the request could not be understood or was missing required parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - authentication failed or the user lacks permission for the requested operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found - resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: updateConversionEventsId
      summary: Update a Conversion Event
      description: 'The Conversion Event object has the following attributes:


        Property

        Type

        Semantic

        Example


        id

        String

        The id of this Conversion Event. read-only

        "00f4b02153ee75f3c9dc4fc128ab041962"


        name

        String

        The name of this Conversion Event.

        "My Conversion Event"


        type

        ConversionEventType

        The type of this Conversion Event

        URL_BASED


        url

        String

        The url configured for this Conversion Event

        "/thank-you"


        marketerId

        String

        The marketer Id of this Conversion Event

        "00f4b02153ee75f3c9dc4fc128ab041962"


        enabled

        Boolean

        Indicates if the Conversion Event is enabled You can have up to 60 enabled conversions at one time

        true


        conversionWindow

        Integer

        The conversion window you’re looking to track. This is the time it takes from click to conversion. The default is 60 days, but you may select any whole number between 1-60.

        50


        includeInConversions

        Boolean

        Indicates if you’d like to include these conversions in your total conversions reporting

        true


        trackingStatus

        TrackingStatus

        Indicates if the conversion event is active or inactive

        ACTIVE


        category

        ConversionEventCategory

        The category of this Conversion Event

        PURCHASE


        orderValue

        OrderValue

        The value of your conversion to help track overall ROI.

        ''{"value": 100, "currency": "USD"}''


        segment

        ConversionEventSegment

        The conversion segment, if such exists. read-only


        lastModified

        Date

        The time when the Conversion Event was last modified. read-only

        "2013-03-16 10:32:31"


        creationTime

        Date

        The time when the Conversion Event was created. read-only

        "2013-01-18 07:19:16"


        timeOnPageSettingValue

        Integer

        Relevant only for TIME_ON_PAGE engagment conversions. The number of seconds a user stays on a page with Outbrain pixel, that will trigger the conversion TIME_ON_PAGE

        30


        scrollDepthSettingValue

        Integer

        Relevant only for SCROLL_DEPTH engagment conversions. The percentage of scroll (out of the total webview) a user performs on a page with Outbrain pixel, that will trigger the conversion SCROLL_DEPTH

        50


        source

        String

        Relevant only for SCROLL_DEPTH and TIME_ON_PAGE engagment conversions. The should always say "OUTBRAIN"

        "OUTBRAIN"'
      tags:
      - Multiple Conversions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: the Conversion Event's id
        example: 00f4b02153ee75f3c9dc4fc128ab041962
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              enabled: false
              url: /registration
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
              example:
                enabled: false
                url: /registration
                includeInConversions: true
                creationTime: '2017-06-07 22:39:21'
                conversionWindow: 60
                lastModified: '2017-06-09 01:49:33'
                type: URL_BASED
                marketerId: 007514a95316bh6fe7ejc0cad101c23343
                name: My Conversion Event
                trackingStatus: ACTIVE
                category: PURCHASE
                id: 00177f47ba1ff1118s86dd1898adbb6e07
          headers:
            AMPLIFY-REQUEST-ID:
              description: Request correlation / rate-limit signal
              schema:
                type: string
        '400':
          description: Bad Request - the request could not be understood or was missing required parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - authentication failed or the user lacks permission for the requested operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found - resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /marketers/{marketerId}/conversionEvents:
    post:
      operationId: createMarketersMarketerIdConversionEvents
      summary: Create a Conversion Event
      description: 'The Conversion Event object has the following attributes:


        Property

        Type

        Semantic

        Example


        id

        String

        The id of this Conversion Event. read-only

        "00f4b02153ee75f3c9dc4fc128ab041962"


        name

        String

        The name of this Conversion Event.

        "My Conversion Event"


        type

        ConversionEventType

        The type of this Conversion Event

        URL_BASED


        url

        String

        The url configured for this Conversion Event

        "/thank-you"


        marketerId

        String

        The marketer Id of this Conversion Event

        "00f4b02153ee75f3c9dc4fc128ab041962"


        enabled

        Boolean

        Indicates if the Conversion Event is enabled You can have up to 60 enabled conversions at one time

        true


        conversionWindow

        Integer

        The conversion window you’re looking to track. This is the time it takes from click to conversion. The default is 60 days, but you may select any whole number between 1-60.

        50


        includeInConversions

        Boolean

        Indicates if you’d like to include these conversions in your total conversions reporting

        true


        trackingStatus

        TrackingStatus

        Indicates if the conversion event is active or inactive

        ACTIVE


        category

        ConversionEventCategory

        The category of this Conversion Event

        PURCHASE


        orderValue

        OrderValue

        The value of your conversion to help track overall ROI.

        ''{"value": 100, "currency": "USD"}''


        segment

        ConversionEventSegment

        The conversion segment, if such exists. read-only


        lastModified

        Date

        The time when the Conversion Event was last modified. read-only

        "2013-03-16 10:32:31"


        creationTime

        Date

        The time when the Conversion Event was created. read-only

        "2013-01-18 07:19:16"


        timeOnPageSettingValue

        Integer

        Relevant only for TIME_ON_PAGE engagment conversions. The number of seconds a user stays on a page with Outbrain pixel, that will trigger the conversion TIME_ON_PAGE

        30


        scrollDepthSettingValue

        Integer

        Relevant only for SCROLL_DEPTH engagment conversions. The percentage of scroll (out of the total webview) a user performs on a page with Outbrain pixel, that will trigger the conversion SCROLL_DEPTH

        50


        source

        String

        Relevant only for SCROLL_DEPTH and TIME_ON_PAGE engagment conversions. The should always say "OUTBRAIN"

        "OUTBRAIN"'
      tags:
      - Multiple Conversions
      parameters:
      - name: marketerId
        in: path
        required: true
        schema:
          type: string
        description: the marketer's id
        example: 00f4b02153ee75f3c9dc4fc128ab041962
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              enabled: true
              url: /thank-you
              includeInConversions: true
              type: URL_BASED
              name: My Conversion Event
              conversionWindow: 60
              category: PURCHASE
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
              example:
                enabled: true
                url: /thank-you
                includeInConversions: true
                creationTime: '2017-06-07 22:39:21'
                conversionWindow: 60
                lastModified: '2017-06-09 01:49:33'
                type: URL_BASED
                marketerId: 007514a95316bh6fe7ejc0cad101c23343
                name: My Conversion Event
                trackingStatus: ACTIVE
                category: PURCHASE
                id: 00177f47ba1ff1118s86dd1898adbb6e07
          headers:
            AMPLIFY-REQUEST-ID:
              description: Request correlation / rate-limit signal
              schema:
                type: string
        '400':
          description: Bad Request - the request could not be understood or was missing required parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - authentication failed or the user lacks permission for the requested operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found - resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /marketers/{id}/conversionEvents:
    get:
      operationId: getMarketersIdConversionEvents
      summary: Retrieve all Marketer's Conversion Events
      description: Retrieve all Conversion Events associated with the current Marketer.
      tags:
      - Multiple Conversions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
              example:
                count: 2
                conversionEvents:
                - trackingStatus: ACTIVE
                  name: My Conversion 1
                  enabled: false
                  conversionWindow: 60
                  id: 00d5d192ea6d0aaa2201d8fseb7a2da14a
                  type: URL_BASED
                  category: PURCHASE
                  includeInConversions: true
                  marketerId: 0075c1a9s316bf6ff7e3cgcad101c23343
                  url: /registration
                  lastModified: '2017-06-07 00:26:09'
                  usingNewTag: false
                  creationTime: '2017-02-23 04:35:40'
                - name: My Conversion 2
                  trackingStatus: INACTIVE
                  conversionWindow: 20
                  enabled: true
                  includeInConversions: true
                  type: EVENT_BASED
                  category: PURCHASE
                  id: 00793fd2a8b7w77b937aafe290987s2522
                  creationTime: '2017-06-07 00:25:56'
                  lastModified: '2017-06-14 21:56:01'
                  marketerId: 0075csa9331fbf6fe7e3cgcad101c23343
          headers:
            AMPLIFY-REQUEST-ID:
              description: Request correlation / rate-limit signal
              schema:
                type: string
        '400':
          description: Bad Request - the request could not be understood or was missing required parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - authentication failed or the user lacks permission for the requested operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found - resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /marketers/{id}/engagementMetrics:
    get:
      operationId: getMarketersIdEngagementMetrics
      summary: Retrieve Marketer's Engagement Metrics
      description: 'Retrieve all Engagement Metrics avaialable for optimization associated with the current Marketer.

        Relevant only for Marketers with a successful Google Analytics integration for Engagement Bid Strategy (EBS).'
      tags:
      - Multiple Conversions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
              example:
                conversionEvents:
                - id: 009f0588d62d67df8bca855ed9ae756d34
                  name: Session Duration
                  type: ENGAGEMENT
                  marketerId: 00fd3edf18cbf93f937ae9a81cbcba3e62
                  enabled: true
                  conversionWindow: 60
                  includeInConversions: true
                  trackingStatus: INACTIVE
                  category: OTHER
                  description: Engagement external conversion
                  isValuable: false
                  creationTime: '2022-07-18 12:08:51'
                  lastModified: '2022-07-18 12:08:51'
                - id: 00d95d0ca7fdfaa6388199695c2ecde330
                  name: Pages Per Session
                  type: ENGAGEMENT
                  marketerId: 00fd3edf18cbf93f937ae9a81cbcba3e62
                  enabled: true
                  conversionWindow: 60
                  includeInConversions: true
                  trackingStatus: INACTIVE
                  category: OTHER
                  description: Engagement external conversion
                  isValuable: false
                  creationTime: '2022-07-18 12:08:52'
                  lastModified: '2022-07-18 12:08:52'
                - id: 0064fa01ca9a08a621087b7885776b4284
                  name: Bounce Rate
                  type: ENGAGEMENT
                  marketerId: 00fd3edf18cbf93f937ae9a81cbcba3e62
                  enabled: true
                  conversionWindow: 60
                  includeInConversions: true
                  trackingStatus: INACTIVE
                  category: OTHER
                  description: Engagement external conversion
                  isValuable: false
                  creationTime: '2022-07-18 12:08:52'
                  lastModified: '2022-07-18 12:08:52'
                count: 3
          headers:
            AMPLIFY-REQUEST-ID:
              description: Request correlation / rate-limit signal
              schema:
                type: string
        '400':
          description: Bad Request - the request could not be understood or was missing required parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - authentication failed or the user lacks permission for the requested operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found - resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      description: Error envelope returned on 400/401/403/404/429 responses.
      properties:
        moreInfo:
          type: string
          description: Short machine-readable hint identifying the failing operation.
        errorMessage:
          type: string
          description: Human-readable error message.
      examples:
      - moreInfo: get-budget
        errorMessage: access denied
  securitySchemes:
    OBTokenAuth:
      type: apiKey
      in: header
      name: OB-TOKEN-V1
      description: Token obtained from GET /login (HTTP Basic) or from https://my.outbrain.com/create-token. Valid for 30 days.
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic credentials used only on GET /login to obtain an OB-TOKEN-V1 token.