WHwhatnot
Analytics

Get show analytics

Retrieve the analytics for one show owned by the authenticated seller. A show without final analytics still returns 200 with null metrics and a calculation_status saying why: WILL_NOT_BE_CALCULATED if the show was cancelled, is private or is a rehearsal, NOT_ENDED if it has not ended, PENDING if it ended and the metrics are still being calculated. Requires read:reports.

get/analytics/shows/{show_id}

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/analytics/shows/{show_id}
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Path parameters

show_idstring uuid required

The show's ID.

Response

Successful Response

show_idstring required

The show these analytics describe.

titlestring required

The show's title.

start_timestring date-time required

When the show started.

calculation_status'WILL_NOT_BE_CALCULATED' | 'NOT_ENDED' | 'PENDING' | 'GENERATED' required
orders_countinteger nullable required

Number of orders.

giveaway_orders_countinteger nullable required

Number of giveaway orders.

show_impression_countinteger nullable required

Number of times the show was shown to viewers.

show_clickthrough_ratenumber nullable required

Percentage of impressions that were tapped, to two decimal places. Null when there were no impressions.

buyers_countinteger nullable required

Number of distinct buyers.

first_time_buyers_countinteger nullable required

Buyers purchasing from the seller for the first time.

returning_buyers_countinteger nullable required

Buyers who had purchased from the seller before.

giveaway_winners_countinteger nullable required

Number of distinct giveaway winners.

first_time_giveaway_winners_countinteger nullable required

Giveaway winners who had not bought from the seller before.

returning_giveaway_winners_countinteger nullable required

Giveaway winners who had bought from the seller before.

buyer_shares_countinteger nullable required

Number of times buyers shared the show.

stream_minutesinteger nullable required

Minutes the show ran.

max_concurrent_viewersinteger nullable required

Peak number of simultaneous viewers.

total_viewsinteger nullable required

Total views.

distinct_viewers_countinteger nullable required

Number of distinct viewers.

average_ratingnumber nullable required

Average viewer rating of the show.

Changes

No recorded changes to this operation across all 1 revision of this API.