AMALYZE Falcon API

advertising.spa.campaigns.histogram (POST)

Endpoint

Endpoint advertising.spa.camapaigns.histogram returns campaign’s statistics based on timeframe and timeinterval for sponsored products ads (SPA).

Method
POST advertising.spa.campaigns.histogram
Example call

JSON Payload

PropertyTypeDescriptionFurther information
filtersobjectThe object containing the filter information
filters.startdateSart date in format YYYY-MM-DDmandatory
filters.enddateEnd date in format YYYY-MM-DDmandatory
filters.intervaldateThe interval, in which the data shall be returnedmandatory (see valid intervals)
filters.advertiserstringFilters for advertiser dimensionoptional. Usage and valid filter for advertiser dimension
filters.campaignstringFilters for campaign dimensionoptional. Usage and valid filter for campaign dimension
filters.marketplacestringFilters for marketplace dimensionoptional. Usage and valid filter for marketplace dimension
filters.placementstringFilters for placement dimensionoptional. Usage and valid filter for placement dimension
filters.metricsstringFilter for metricsoptional. Usage and valid metrics to filter
metricsarrayArray containing the metrics to be returnedoptional. Usage and valid metrics to return
JSON Response

PropertyTypeDescription
itemsarrayArray containing the merchant / vendor items
metricsobjectObject containing the requested metrics
dimensionsobjectObject containing the dimensions
dimensions.datedateThe date
requestobjectThe request information object (see request information object definition for more information)
Updates / Changes
VersionDescription
Menu