Get Vendor Report

Endpoint to get a vendor’s total behavioral summary report between given dates.

Path Parameters

vendor-id

string

required

The ID of the vendor.

Minimum length: 1

Query Parameters

start_date

string

required

The start date for which reports will be generated.

end_date

string

required

The end date for which reports will be generated.

Response

200 - application/json

Auctions information attributed to this report item in addition to normal report data.

auctions

object

required

How many auctions are attributed to this report item.

Show child attributes

auctions.lost

integer

required

Number of auctions lost for a campaign in a given period of time.

auctions.percentageWon

number

required

Percentage of auctions won for a campaign in a given period of time.

auctions.won

integer

required

Number of auctions won for a campaign in a given period of time.

clicks

object

required

How many clicks are attributed to this report item.

Show child attributes

clicks.adSpent

integer

required

Ad spent over a period of time, in minor units of currency according to ISO 4217.

clicks.charged

integer

required

Number of charged events.

clicks.total

integer

required

Total number of events.

impressions

object

required

How many impressions are attributed to this report item.

Show child attributes

impressions.adSpent

integer

required

Ad spent over a period of time, in minor units of currency according to ISO 4217.

impressions.charged

integer

required

Number of charged events.

impressions.total

integer

required

Total number of events.

purchases

object

required

How many purchases are attributed to this report item.

Show child attributes

purchases.amount

integer

required

Amount of money made by purchases over a period of time, in minor units of currency according to ISO 4217.

purchases.count

integer

required

Amount of purchase events.

purchases.quantity

integer

required

Amount of items purchased.

purchases.countByProduct

object

Purchase count by product. Available if count_by_product is set to true.

Show child attributes

purchases.countByProduct.{key}

integer