Outbrain Walkthrough
  • 1 Minute to read
  • Dark
    Light
  • PDF

Outbrain Walkthrough

  • Dark
    Light
  • PDF

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.

Report Report_uri Params
Campaigns Data marketers/{id}/campaigns extraFields
Campaigns Performance Statistics reports/marketers/{id}/campaigns campaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Promoted Links Performance Statistics reports/marketers/{id}/content campaignId, includeArchivedCampaigns, promotedLinkId, includeConversionDetails, conversionsByClickDate
Periodic Performance Statistics reports/marketers/{id}/periodic campaignId, includeArchivedCampaigns, promotedLinkId, breakdown, includeConversionDetails, conversionsByClickDate
Periodic Performance Statistics by Camapaign reports/marketers/{id}/campaigns/periodic includeArchivedCampaigns, breakdown, includeConversionDetails, conversionsByClickDate
Periodic Performance Statistics by Promoted Link reports/marketers/{id}/campaigns/{campaignId}/periodicContent campaignId, breakdown, includeConversionDetails, conversionsByClickDate
Performance Statistics by Publisher reports/marketers/{id}/publishers campaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Performance Statistics for all Marketer Campaigns by Publisher reports/marketers/{id}/campaigns/publishers includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Performance Statistics by Section reports/marketers/{id}/sections campaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Performance Statistics for all Marketer Campaigns by Section reports/marketers/{id}/campaigns/sections includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Performance Statistics by Platform reports/marketers/{id}/platforms campaignId, includeArchivedCampaigns, breakdown, includeConversionDetails, conversionsByClickDate
Performance Statistics for all Marketer Campaigns by Platform reports/marketers/{id}/campaigns/platforms includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Geo Performance Statistics reports/marketers/{id}/geo campaignId, breakdown, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Performance Statistics for all Marketer Campaigns by Geo reports/marketers/{id}/campaigns/geo breakdown, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Performance Statistics by Interest reports/marketers/{id}/interests campaignId, includeArchivedCampaigns, includeConversionDetails, conversionsByClickDate
Campaign Optimization Experiments reports/marketers/{id}/campaigns/{campaignId}/experiments campaignId, 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?