WordstatInstall

Summary

Fetches request dynamics over a selected period for a specified phrase

Inputs

• phrase (required) — The phrase to search for. Supports operators like ".".
• regions — List of region IDs (e.g. [213, 2]). You can get values from "Get Regions Tree" operation. Default is all regions.
• devices — List of device types. If empty, defaults to all.
• period (required) — Aggregation period. Monthly, weekly, or daily.
• fromDate (required) — Start date of the period (YYYY-MM-DD). Daily: last 60 days. Weekly/Monthly: from 2018-01-01. Monthly: must be 1st day of month. Weekly: must be Monday.
• toDate — End date of the period (YYYY-MM-DD). Monthly: must be last day of month. Weekly: must be Sunday. Defaults: last month end (monthly), last Sunday (weekly), yesterday (daily).

Output shape

an array of items representing the dynamics response

Each item contains the API response data; the array is wrapped in execution metadata per input item.

Examples

Example 1: Weekly dynamics for phrase 'online shopping' from 2023-01-01 to 2023-01-31, regions [213,2], devices [desktop]

phrase: online shopping; period: weekly; fromDate: 2023-01-01; toDate: 2023-01-31; regions: [213,2]; devices: [desktop]

Example 2: Monthly dynamics for phrase 'mobile app' with all regions and devices

phrase: mobile app; period: monthly; regions: []; devices: []