Contents x
    Outbrain Walkthrough
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Outbrain Walkthrough

    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Outbrain API version 1 is currently supported

    This provides a general description of Outbrain and its capabilities.

    Introduction

    Outbrain is a native advertising company that is using targeted advertising to recommend articles, slideshows, etc.

    Connection

    Authentication is done via Username and Password, which provides a token.
    This token is added as a header to any request.

    • The token is stored in the AWS parameter store due to the API restriction of authenticating only twice every hour.

    Reports

    • Endpoints we're using:

    https://api.outbrain.com/amplify/v0.1/<report_uri>
    Each report requires a marketer ID (and some require campaign ID). a specific one can be selected via the UI, or if left blank the Rest call is made out to all of them.
    limit and offset params are used to perform pagination.

    ReportReport_uriParams
    Campaigns Datamarketers/{id}/campaignsextraFields
    Campaigns Performance Statisticsreports/marketers/{id}/campaignscampaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Promoted Links Performance Statisticsreports/marketers/{id}/contentcampaignId, includeArchivedCampaigns, promotedLinkId, includeConversionDetails, conversionsByClickDate
    Periodic Performance Statisticsreports/marketers/{id}/periodiccampaignId, includeArchivedCampaigns, promotedLinkId, breakdown, includeConversionDetails, conversionsByClickDate
    Periodic Performance Statistics by Camapaignreports/marketers/{id}/campaigns/periodicincludeArchivedCampaigns, breakdown, includeConversionDetails, conversionsByClickDate
    Periodic Performance Statistics by Promoted Linkreports/marketers/{id}/campaigns/{campaignId}/periodicContentcampaignId, breakdown, includeConversionDetails, conversionsByClickDate
    Performance Statistics by Publisherreports/marketers/{id}/publisherscampaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Performance Statistics for all Marketer Campaigns by Publisherreports/marketers/{id}/campaigns/publishersincludeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Performance Statistics by Sectionreports/marketers/{id}/sectionscampaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Performance Statistics for all Marketer Campaigns by Sectionreports/marketers/{id}/campaigns/sectionsincludeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Performance Statistics by Platformreports/marketers/{id}/platformscampaignId, includeArchivedCampaigns, breakdown, includeConversionDetails, conversionsByClickDate
    Performance Statistics for all Marketer Campaigns by Platformreports/marketers/{id}/campaigns/platformsincludeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Geo Performance Statisticsreports/marketers/{id}/geocampaignId, breakdown, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Performance Statistics for all Marketer Campaigns by Georeports/marketers/{id}/campaigns/geobreakdown, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Performance Statistics by Interestreports/marketers/{id}/interestscampaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
    Campaign Optimization Experimentsreports/marketers/{id}/campaigns/{campaignId}/experimentscampaignId, includeTerminatedExperiments

    API Limitations

    when reaching the limit, we receive a 429 status code error. this response includes a header that is then used(+0.5 seconds) as the time to sleep until the next request.

    • Authentication requests to obtain a token (/login) are limited to two requests per hour per user.

    • Usage of a single token is limited to 30 requests per second for the entire API.

    • Each marketer is limited to 10 requests per minute for the entire performance reporting API (see Reports rate limits).

    • Each marketer is limited to 50 requests per minute for the entire real time performance reporting API (see Realtime reports rate limits).

    Was this article helpful?
    What's Next