Skip to main content
POST
douyin-xingtu.creator.spread

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
oAuthorId
string
required

The creator's id in the marketplace.

Required string length: 1 - 512
flowType
string

Which flow to read, as the marketplace names them.

Required string length: 1 - 32
onlyAssign
boolean

True to count only assigned orders.

platform
enum<string>

The content format to read.

Available options:
SHORT_VIDEO,
LIVE_STREAMING,
PICTURE_TEXT,
SHORT_DRAMA
range
string

The reported period, as the marketplace names it.

Required string length: 1 - 32
type
string

Which spread report to read, as the marketplace names them.

Required string length: 1 - 32

Response

The result

interactRateLabel
string

Interaction-rate grade, as the marketplace words it.

itemNumLabel
string

Item-count grade, as the marketplace words it.

itemNumOvertake
number

Share of creators this item count is above, as the marketplace reports it.

playOverRateLabel
string

Play-over-rate grade, as the marketplace words it.

playConsistencyLabel
string

Play-consistency grade, as the marketplace words it.

playConsistencyOvertake
number

Share of creators this consistency is above, as the marketplace reports it.

playConsistencyValue
number

The consistency figure itself.