CreatorService
The Creator Hub: overview, analytics, sales, uploads and payouts.
On this page
- Summary
- Methods
- GetOverview
- GetExperienceAnalytics
- ListSales
- ListMyItems
- ListUploads
- RequestPayout
- ListPayouts
- Types
- CreatorOverview
- CreatorOverviewRequest
- DailyPoint
- ExperienceAnalytics
- ExperienceAnalyticsRequest
- ItemSales
- ListMyItemsRequest
- ListMyItemsResponse
- ListPayoutsRequest
- ListPayoutsResponse
- ListSalesRequest
- ListSalesResponse
- ListUploadsRequest
- ListUploadsResponse
- Payout
- RequestPayoutRequest
- Sale
- Upload
- See also
The Creator Hub: creations, analytics, earnings. Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
| Method | Auth | Description |
|---|---|---|
| GetOverview | Account | |
| GetExperienceAnalytics | Account | |
| ListSales | Account | |
| ListMyItems | Account | |
| ListUploads | Account | |
| RequestPayout | Account | Cash-out request; local builds only record it. |
| ListPayouts | Account |
Methods#
GetOverview#
POST /neo.platform.v1.CreatorService/GetOverview
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: CreatorOverviewRequest. Response: CreatorOverview.
GetExperienceAnalytics#
POST /neo.platform.v1.CreatorService/GetExperienceAnalytics
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ExperienceAnalyticsRequest. Response: ExperienceAnalytics.
ListSales#
POST /neo.platform.v1.CreatorService/ListSales
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListSalesRequest. Response: ListSalesResponse.
ListMyItems#
POST /neo.platform.v1.CreatorService/ListMyItems
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListMyItemsRequest. Response: ListMyItemsResponse.
ListUploads#
POST /neo.platform.v1.CreatorService/ListUploads
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListUploadsRequest. Response: ListUploadsResponse.
RequestPayout#
Cash-out request; local builds only record it.
POST /neo.platform.v1.CreatorService/RequestPayout
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: RequestPayoutRequest. Response: Payout.
ListPayouts#
POST /neo.platform.v1.CreatorService/ListPayouts
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListPayoutsRequest. Response: ListPayoutsResponse.
Types#
CreatorOverview#
| Field | Type | Description |
|---|---|---|
experiences | string (int64) | |
publicExperiences | string (int64) | |
items | string (int64) | |
visitsTotal | string (int64) | |
visits7d | string (int64) | |
playingNow | string (int64) | |
favoritesTotal | string (int64) | |
earnedAvailable | string (int64) | |
earnedPending | string (int64) | |
sales7d | string (int64) | |
revenue7d | string (int64) | |
visitsSeries | array of DailyPoint | |
revenueSeries | array of DailyPoint |
CreatorOverviewRequest#
No fields: send {}.
DailyPoint#
| Field | Type | Description |
|---|---|---|
date | string | YYYY-MM-DD |
value | string (int64) |
ExperienceAnalytics#
| Field | Type | Description |
|---|---|---|
experienceId | string | |
visits | array of DailyPoint | |
uniquePlayers | array of DailyPoint | |
revenue | array of DailyPoint | |
playingNow | string (int64) | |
favorites | string (int64) | |
upVotes | string (int64) | |
downVotes | string (int64) | |
avgSessionSeconds | string (int64) | Average session length in seconds over the window. |
day1Retention | number | Share of first-day players who came back the next day (0-100). |
topItems | array of ItemSales |
ExperienceAnalyticsRequest#
| Field | Type | Description |
|---|---|---|
experienceId | string | |
days | number |
ItemSales#
| Field | Type | Description |
|---|---|---|
itemId | string | |
name | string | |
sales | string (int64) | |
revenue | string (int64) |
ListMyItemsRequest#
| Field | Type | Description |
|---|---|---|
kind | string |
ListMyItemsResponse#
| Field | Type | Description |
|---|---|---|
items | array of Item |
ListPayoutsRequest#
No fields: send {}.
ListPayoutsResponse#
| Field | Type | Description |
|---|---|---|
payouts | array of Payout |
ListSalesRequest#
| Field | Type | Description |
|---|---|---|
limit | number |
ListSalesResponse#
| Field | Type | Description |
|---|---|---|
sales | array of Sale |
ListUploadsRequest#
No fields: send {}.
ListUploadsResponse#
| Field | Type | Description |
|---|---|---|
uploads | array of Upload | |
usedToday | string (int64) | |
dailyLimit | string (int64) |
Payout#
| Field | Type | Description |
|---|---|---|
id | string | |
credits | string (int64) | |
amountUsd | string | US dollars, as a decimal string. |
method | string | |
status | string | requested -> processing -> paid | failed; paid -> reversed (failed and reversed payouts return their Credits to earned_available). |
createdAt | string | |
failureReason | string | Why a payout failed or was reversed. |
updatedAt | string |
RequestPayoutRequest#
| Field | Type | Description |
|---|---|---|
credits | string (int64) | |
method | string | |
requestId | string | A client-generated idempotency key: a retried or double-submitted request returns the first payout instead of making a second one. |
Sale#
| Field | Type | Description |
|---|---|---|
transactionId | string | |
itemId | string | |
itemName | string | |
buyerName | string | |
price | string (int64) | |
earned | string (int64) | The creator's share. |
status | string | |
createdAt | string |
Upload#
| Field | Type | Description |
|---|---|---|
sha256 | string | |
url | string | |
contentType | string | |
size | string (int64) | |
createdAt | string |