Migration guide for PAPI users

Are you a PAPI user? This article has an overview of the Criteo API endpoints you can use to replace your PAPI connections. This will help you migrate before the PAPI deprecation by April 2021.

First, you will need to complete your onboarding in our new Developer Portal as indicated in the onboarding checklist. Then, you will be ready to start migrating your PAPI endpoints.

Below, you can see the Criteo API's equivalent for your PAPI endpoints.

PAPI	Criteo API equivalent
getAccount Retrieves generic information about the advertiser (name, email of the primary admin, currency, timezone, and country)	/portfolio Retrieve your advertisers' ids and names. This endpoint does not include the email of the primary admin, currency, timezone, or country information
getCampaigns Returns the campaigns of the advertiser (can query one or more)	/advertiser/{advertiserid}/campaigns Retrieve your campaigns and categories for a specific advertiser Available soon
getCategories Returns all categories for all the partners of the advertiser	/advertiser/{advertiserid}/categories Retrieve your campaigns and categories for a specific advertiser Filter result per category status Available soon
getBudgets Returns the budgets of the advertiser (can query one or more)	/budgets Retrieve budgets for your portfolio Available soon
getStatisticsLastUpdate Returns the max date available in the statistics storage	This field is not relevant anymore. This was necessary in PAPI due to the asynchronous nature of the Statistics reports. Through the Criteo API, reports are instead pulled in real-time.
mutateCampaigns Changes the CPC of one or more campaigns and of their associated categories	/campaigns/bids Set new bid values to your campaign or campaign categories Available soon
mutateCategories Enables/disables the ability to bid on a category	/categories Update Category-Level bids for a Campaign Available soon
scheduleReportJob Launches the generation of a statistics report along with the dimension Campaign or Category, with the granularity Day or Hour, for a given time period.	/preview/statistics/report Retrieve data related to your campaigns' performance. You can customize the specific metrics returned and the dimensions that the data is grouped by (including all the previous dimensions and temporal granularity)

PAPI

Criteo API equivalent

getAccount

Retrieves generic information about the advertiser (name, email of the primary admin, currency, timezone, and country)

/portfolio

Retrieve your advertisers' ids and names. This endpoint does not include the email of the primary admin, currency, timezone, or country information

getCampaigns

Returns the campaigns of the advertiser (can query one or more)

/advertiser/{advertiserid}/campaigns

Retrieve your campaigns and categories for a specific advertiser

Available soon

getCategories
Returns all categories for all the partners of the advertiser

/advertiser/{advertiserid}/categories

Retrieve your campaigns and categories for a specific advertiser
Filter result per category status

Available soon

getBudgets

Returns the budgets of the advertiser (can query one or more)

/budgets

Retrieve budgets for your portfolio

Available soon

getStatisticsLastUpdate

Returns the max date available in the statistics storage

This field is not relevant anymore. This was necessary in PAPI due to the asynchronous nature of the Statistics reports. Through the Criteo API, reports are instead pulled in real-time.

mutateCampaigns

Changes the CPC of one or more campaigns and of their associated categories

/campaigns/bids

Set new bid values to your campaign or campaign categories

Available soon

mutateCategories

Enables/disables the ability to bid on a category

/categories
Update Category-Level bids for a Campaign

Available soon

scheduleReportJob

Launches the generation of a statistics report along with the dimension Campaign or Category, with the granularity Day or Hour, for a given time period.

/preview/statistics/report

Retrieve data related to your campaigns' performance. You can customize the specific metrics returned and the dimensions that the data is grouped by (including all the previous dimensions and temporal granularity)