Sign in

Welcome to our Support Center

Get help with integration and live campaigns

Welcome to our Support Center. Get help with integration and live campaigns

How do I call the reporting information using the Criteo API?

To call a report using the Crieto API you can do so using the following queries: 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

List of API calls & Responses

 
1. clientLogin
Returns an authToken, to be used in all subsequent calls.

Parameters:
Field Type Description
username xsd:string Advertiser's username
password xsd:string Advertiser's password
source xsd:string Short string identifying your application, for logging purposes. This string should take the form: "companyName-applicationName-versionID".

Response:
Field Type Description
clientLoginResult xsd:string The clientLoginResult is the authentication token (authToken), to be used in all other calls. It is valid 48 hours.
 
2. getAccount
Returns basic account information

Parameters:
N/A

Response:
Field Type Description
advertiserName xsd:string Name of this account
email xsd:string Main contact's email for the advertiser
currency xsd:string Currency for this account. Enumeration
timezone xsd:string Timezone for this account. Enumeration
country xsd:string Country for this account. Enumeration
 
3. getBudgets
Returns the list of budgets that meets the selector criteria.

Parameters:
Field Type Description
budgetSelector BudgetIDs[] A list of budget ID to retrieve. If empty, all budgets are retrieved.

Response:
Field Type Description
getBudgetsResult Budget[] A list of budget objects
 
4. getCampaigns
Returns the list of campaigns that meets the selector criteria.

Parameters:
Field Type Description
campaignSelector CampaignSelector BudgetID,CampaignID,CampaignStatus and BiddingStartegy can be used to retrieve campaigns.

Response:
Field Type Description
getCampaignsResult Campaign[] A list of campaign objects
 
5. getCategories
Returns the list of categories that meets the selector criteria.

Parameters:
Field Type Description
categorySelector CategorySelector CategoryID, and Selected can be used to retrieve categories.

Response:
Field Type Description
getCategoriesResult Category[] A list of category objects
 
6. mutateCategories
Updates categories.

Parameters:
Field Type Description
mutateCategories CategoryMutates[] A list of mutate operations. Only SET operations are supported.

Response:
Field Type Description
jobResponse categoryMutateJobResponse[] A list of categoryJobResponseObjects. Each operation has its own jobID, that can be checked with getJobStatus.
 
7. mutateCampaigns
Updates campaigns.

Parameters:
Field Type Description
mutateCampaigns CampaignMutates[] A list of mutate operations. Only SET operations are supported.


Response:
Field Type Description
jobResponse campaignMutateJobResponse[] A list of campaignJobResponseObjects. Each operation has its own jobID, that can be checked with getJobStatus.


8. scheduleReportJob
Schedules a report job for execution.

Parameters:
Field Type Description
reportJob ReportJob A reportJob object is passed, describing the Report requested.

Response:
Field Type Description
jobID xsd:int ID of the job requested. Can be used in getJobStatus and getReportDownloadURL.
jobStatus xsd:string Status of the request. If the reportJob was accepted, returns ‘Pending’
reportJob ReportJob The initial reportJob request


9. getJobStatus
Retrives a job status based on its ID.

Parameters:
Field Type Description
jobID xsd:int The jobID for which the status is retrieved.

Response:
Field Type Description
getJobStatusResult xsd:String Status of the job requested. Enumeration


10. getReportDownloadUrl
Returns a URL from which the report with the given job ID can be downloaded. After invoking this method, the caller can do a regular HTTP GET on the returned URL to retrieve the report. The reports are in XML format.

Parameters:
Field Type Description
jobID xsd:int The jobID for which the download URL is retrieved.

Response:
Field Type Description
jobURL xsd:String Full URL where the report can be downloaded.


11. getStatisticsLastUpdate
Returns a list of StatUpdate objects to indicate the “books closed” for the related Type of statistics (ClicksAndImpressions, Sales for now).

Parameters:
None.

Response:
Field Type Description
getStatisticsLastUpdateResult StatUpdate[] List of StatUpdateObjects. A StatUpdate contains a type and a date.

 

Objects descriptions

 
Type Campaign
Field Type Description
campaignID xsd:int ID of the campaign
campaignName xsd:string Name of the campaign
campaignBid BidInformation BidInformation for the campaign
budgetID xsd:decimal ID of the budget the campaign is using.
remainingDays xsd:int Number of days this campaign can run with the existing budget. This value is estimated on the current spending trend.
status xsd:string Status of the campaign:
  • RUNNING : the campaign is currently active
  • NOT_RUNNING : the campaign is inactive
  • DEAD : the campaign is archived (read only)
categoryBids CategoryBid[] List of BidInformation attached to a category.


Type Category
Field Type Description
categoryID xsd:int ID of the category
categoryName xsd:string Name of the category (retrieved from the catalog feed).
avgPrice xsd:double Average price of the products of this category.
numberOfProducts xsd:int Number of products tagged with this category.
selected xsd:boolean True if the category is selected (selected means available for bidding and reporting).


Type Budget
Field Type Description
budgetID xsd:int ID of the budget.
budgetName xsd:string Name of the budget.
totalAmount xsd:int Total amount added to this budget.
remainingBudget xsd:decimal Amount available.
remainingBudgetUpdated xsd:dateTime Time at which remainingBudget was computed.


Type BidInformation
Field Type Description
biddingStrategy xsd:string Strategy of the bid:
  • Cpc : cost per click
  • Cpa : cost per action
  • Cpm: cost per thousand
Note: only Cpc is supported.
cpcBid xsd:double Value of the cost per click.
cpaBid CPABid CPABid contains postClick, postView, commission and percent. (Not supported yet).


Type CategoryBid
Field Type Description
campaignCategoryUID xsd:int Global UID identifying the category for a specific campaign.
campaignID xsd:int ID of the campaign for which this category bid is done.
categoryID xsd:int ID of the category for which this bid is done.
selected xsd:boolean True if the category is selected (selected means available for bidding and reporting).
bidInformation BidInformation BidInformation for the category bid.


Type ReportJob
Field Type Description
reportSelector CategoryIDs
CampaignIDs
List of Category or Campaign IDs on which the report should retrieve data.
reportType xsd:string Type of report to run:
  • Campaign
  • Category
aggregationType xsd:string Type of aggregation for the report:
  • Hourly
  • Daily
startDate xsd:string startDate of the report (YYYY-MM-DD).
endDate xsd:string endDate of the report (YYYY-MM-DD).
selectedColumns ReportColumn[] List of columns requested in the report:
  • clicks
  • impressions
  • ctr
  • revcpc
  • ecpm
  • cost
  • sales
  • convRate
  • orderValue
  • salesPostView
  • convRatePostView
  • orderValuePostView
  • costOfSale
  • overallCompetitionWin
  • costPerOrder
isResultGzipped xsd:boolean True is the report needs to be zipped.

 

Was this article helpful?
0 out of 1 found this helpful
Powered by Zendesk