Outbrain walkthrough
Outbrain API version 1 is currently supported.
Outbrain is a native advertising company that uses targeted advertising to recommend articles and slideshows.
Connection
Authentication is done via Username and Password, which provides a token. This token is used 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:
https://api.outbrain.com/amplify/v0.1/<report_uri>
Each report requires a marketer ID (and some require a campaign ID). Choose any parameter via the UI, or if left blank, the REST call is made to all. You can use the limit and offset parameters to perform pagination.
| Report | Report_uri | Params |
|---|---|---|
| Campaigns Data | marketers/{id}/campaigns | extraFields |
| Marketers | /marketers | 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
You will get a 429 status code error when you reach the API limit. This response includes a header that is then used(+0.5 seconds) as the time to sleep until the subsequent 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. To learn more, refer to the Reports rate limits topic.
Each marketer is limited to 50 requests per minute for the entire real-time performance reporting API. To learn more, refer to theRealtime reports rate limits.
To learn more about Outbrain APIs, refer to Official Outbrain API documentation.
