AMALYZE Falcon API

research.keyword.histogram (POST)

Endpoint

Endpoint research.keyword.histogram returns date histogram including metrics (e.g. searchVolume) for keywords / marketplaces

Method
POST research.keyword.histogram
Example call

JSON Payload

PropertyTypeDescriptionFurther information
filtersobjectObject containing the filter information
filters.startdateSart date in format YYYY-MM-DDmandatory
filters.enddateEnd date in format YYYY-MM-DDmandatory
filters.intervalstringThe interval, in which the data shall be returnedmandatory. valid intervals
filters.keywordsarrayArray containing the keywordsmandatory
filters.keywords.keywordstringString containing the keywordmandatory
filters.keywords.marketplacestringString containing the marketplacemandatory. valid marketplaces
metricsarrayArray containing the returned metricsmandator
  • searchVolume
JSON Response

PropertyTypeDescription
itemsarrayArray containing the keyword histogram items
items.dimensionobjectObject containing the histogram item’s dimensions
items.dimension.datedateString containing the date, according to the requested interval
items.seriesarrayArray containing the histogram item’s series
items.series.dimensionobjectObject containing the serie’s dimensions
items.series.dimension.keywordstringString containing the series’ keyword
items.series.dimension.marketplacestringString containing the series’ marketplace Id
items.series.metricsobjectObject containing the series’ metrics according to the requested metrics
requestobjectThe request information object (see request information object definition for more information)
Updates / Changes
VersionDescription
0.1.17new endpoint
Menü