Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

provider
enum<string>
default:google

Which engine.

Available options:
google,
bing
range
enum<string>
default:30d

The period.

Available options:
today,
yesterday,
7d,
30d,
this_week,
last_week,
this_month,
last_month,
this_year
from
string

The first day of a period of your own, as YYYY-MM-DD. With to, in place of range.

to
string

Its last day, as YYYY-MM-DD.

tz
string

The time zone those days are in, as an IANA name. Left out, UTC.

Example:

"Europe/Berlin"

dimension
enum<string>

To ask about one thing: what kind of thing value is.

Available options:
query,
page,
country,
device
value
string

The one search, page, country or device to ask about.

find
string

Only rows of one list that contain these words.

findIn
enum<string>

Which list find narrows.

Available options:
query,
page

Response

It worked.

success
boolean
required

Whether the request did what was asked.

message
string | null
required

Words for a person. Empty when it worked.

code
string | null
required

Why it was refused, as a word that does not change. Empty when it worked.

data
any
required

The thing asked for: an object, or for a list its rows.

pages
integer

For a paged list: how many pages there are.

total
integer

For a paged list: how many rows there are in all.

meta
object

Anything else the route answers beside the thing itself.