BidReport

1
2
3
4
5
{
    "Name": "Mopedo.Reporting.BidReport",
    "Kind": "EntityResource",
    "Methods": ["GET", "REPORT", "HEAD"]
}

BidReport is a short-term reporting resource that works like the WinReport resource, but for Bid entities instead of Win entities.

Report parameters

The following properties can be used in request URIs to specify the report parameters:

Property name Type Description
User User The user on which the bid(s) was placed
Device Device The device on which the bid(s) was placed
Site Site The site on which the bid(s) was placed
App User The app on which the bid(s) was placed
Id string The unique ID for the bid
AdMarkup string The HTML markup contained in the bid
SampleImageUrl string The sample image URL from the Campaign
CreativeId string The id of the creative contained in the bid
AdvertiserDomain string The advertiser domain from the Campaign
CreativeAttributes string Creative attributes as defined in OpenRTB
Error string Error code if this bid was invalid
ErrorInfo string Information about an invalid bid
Test string Is this a test bid?
AutoClickTrackingEnabled boolean Is auto click tracking enabled for this ad?
LandingPage string The landing page as defined in Ad
SupportsClickTracking boolean Is click tracking implemented for this bid?
BidderType string The type of bidder used to generate this bid
CampaignId string The id of the Campaign used for this bid
BuyerId string An optional buyer id (of campaigns) to filter against
AdId string The id of the Ad used for this bid
Time datetime The time when the bid was placed
Price Price The price for the bid

Format

The response then has the following format:

Property name Type Description
From datetime The report start time
To datetime The report end time
NrOfBids integer The total number of bids in the report
TotalBidPrice Price The total price sum for all bids in the report
HighestBidPrice Price The highest bid price for all bids in the report
LowestBidPrice Price The lowest bid price for all bids in the report
AverageBidPrice Price The average bid price for all bids in the report
MedianBidPrice Price The median bid price for all bids in the report
FirstBidAt datetime The date and time of the first bid included in the report
LastBidAt datetime The date and time of the last bid included in the report
BidCount integer Obsolete: use NrOfBids instead