Skip to main content
GET
Shopify stats

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id
integer

Read one of your child brands instead of the organization that owns the key. Any id that is not one of your brands answers 404.

start_date
string<date>

First day, YYYY-MM-DD. Default: 29 days before end_date.

end_date
string<date>

Last day, YYYY-MM-DD. Default: today (UTC). At most 366 days in all.

campaign_scope
enum<string>

Which programs: ambassador programs (default), social campaigns and contracts, or all.

Available options:
ambassador,
social,
all
campaign_ids
string

Comma separated campaign ids of your organization.

creator_id
integer

Only this creator (Growi user id).

sale_source
enum<string>

all (default), sales from Meta ads, or organic.

Available options:
all,
meta,
organic
customer_occurrence
enum<string>

First-time or repeat customers only.

Available options:
first_time,
repeat,
all
joined_start_date
string<date>

Only creators who joined on or after this day, YYYY-MM-DD.

joined_end_date
string<date>

Only creators who joined on or before this day, YYYY-MM-DD.

Response

OK

success
boolean
data
object