AMALYZE Falcon API

advertising.spa.keywords.histogram (POST)

Endpoint

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

Endpoint
POST advertising.spa.keywords.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.adgroupstringFilters for adgroup dimensionoptional. Usage and valid filter for adgroup dimension
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.keywordstringFilters for keyword dimensionoptional. Usage and valid filter for keyword dimension
filters.marketplacestringFilters for marketplace dimensionoptional. Usage and valid filter for marketplace 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