Get the search report
How the store was found in a search engine over a period: clicks, impressions, click rate and position, over time and by search, page, country and device. From an engine the store has connected in the dashboard. With none connected it is refused with search_unavailable. Neither engine has figures for today.
Needs the analytics.read permission (Read Analytics). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key.
Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.
Query Parameters
Which engine.
google, bing The period.
today, yesterday, 7d, 30d, this_week, last_week, this_month, last_month, this_year The first day of a period of your own, as YYYY-MM-DD. With to, in place of range.
Its last day, as YYYY-MM-DD.
The time zone those days are in, as an IANA name. Left out, UTC.
"Europe/Berlin"
To ask about one thing: what kind of thing value is.
query, page, country, device The one search, page, country or device to ask about.
Only rows of one list that contain these words.
Which list find narrows.
query, page Response
It worked.
Whether the request did what was asked.
Words for a person. Empty when it worked.
Why it was refused, as a word that does not change. Empty when it worked.
The thing asked for: an object, or for a list its rows.
For a paged list: how many pages there are.
For a paged list: how many rows there are in all.
Anything else the route answers beside the thing itself.

