SocialToAIStart freeConsole

Response format

Every SocialToAI call answers in the same shape, whatever the platform: an envelope that says what was called, how it ended and what it cost, around a list of items. There are 38 kinds of item, and each has the same fields on every platform. A field a platform cannot give is null, never missing.

The envelope

schema_version is v1. Clients should ignore fields and codes they do not know.

FieldTypeWhat it is
request_idstringIdentifies this call. Quote it when you report a problem.
schema_version"v1"Always "v1".
fetched_atstringWhen the data was read from the platform, ISO 8601 in UTC.
actionstringThe action that ran.
opstringThe platform-specific interface that ran. Present on call only. (may be absent)
platformstringThe platform this answer is from.
targetstringThe target this answer is for, as you wrote it. Present when the request names several. (may be absent)
status"ok" | "empty" | "error" | "not_supported" | "timeout" | "skipped"ok, empty, error, not_supported, timeout or skipped.
reasonstringWhy this answer was skipped. Present when status is skipped. (may be absent)
unavailablestring[]Field paths this platform cannot give. Those fields are null in every item.
page.has_morebooleantrue when there is another page. (may be absent)
page.cursorstringSend it back as cursor to get the next page. Absent on the last page. (may be absent)
page.cursor_expires_atstringWhen the cursor stops working, ISO 8601 in UTC. (may be absent)
warningsarrayThings worth knowing that did not fail the call.
applied_paramsobjectThe parameters as they were applied.
includesobjectThe extra parts you asked for with include, by name: each with its own status and cost_credits. Their fields are filled into the items. (may be absent)
cost_creditsintegerWhat this answer cost. 0 when the call failed.
billing.cost_creditsintegerWhat the whole request cost.
billing.balance_creditsintegerYour balance after this call.
billing.today_spend_creditsintegerCredits spent today, in UTC.
billing.daily_limit_creditsinteger | nullYour daily limit; null when none is set.
billing.daily_remaining_creditsinteger | nullWhat is left of the daily limit; null when none is set.
billing.displaystringOne sentence an AI can repeat to you.
replayedbooleantrue when this is a stored result returned again under the same idempotency key: it cost 0.
replayed_cost_creditsintegerWhat the first answer cost. Present when replayed is true. (may be absent)
watch_hintstringOne line that offers to run this every day, at most once an hour. Over HTTP only when the same target is asked for again, with the request that makes the schedule. (may be absent)
empty_reason"no_match" | "filtered"Why there is nothing: no_match, or filtered by your own conditions. Present when status is empty. (may be absent)

Statuses

statusChargedWhat it means
okYesThe call worked and items holds the results.
emptyYesThe call worked and found nothing. A search that ran and matched nothing is charged as usual.
errorNoThe call failed. error says why and fix says what to do.
not_supportedNoThe platform does not offer this action.
timeoutNoThe result is not known. We do not retry on our own.
skippedNoThis part was not run.

Items

Each item says what it is in type. Times are ISO 8601 in UTC. Whoever wrote a comment is never named: comments carry an anonymous label that is stable within one answer.

contentA post, video, note or article

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"content"The object type.
urlstring | nullA link that opens the item.
format"video" | "image" | "text" | "article" | nullvideo, image, text or article.
titlestring | nullThe title.
textstring | nullThe body text or caption.
published_atstring | nullWhen it was published, ISO 8601 in UTC.
author.idstring | nullThe author's account ID.
author.usernamestring | nullThe author's handle.
author.namestring | nullThe author's display name.
author.verifiedboolean | nullWhether the author is verified.
author.followersinteger | nullThe author's follower count.
metrics.likesinteger | nullLikes.
metrics.commentsinteger | nullComments.
metrics.sharesinteger | nullShares.
metrics.collectsinteger | nullSaves.
metrics.viewsinteger | nullViews or plays.
metrics.repostsinteger | nullReposts.
imagesstring[] | nullImage addresses.
hashtagsstring[] | nullHashtags, without the #.
is_pinnedboolean | nullWhether the author pinned it.

accountAn account

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"account"The object type.
usernamestring | nullThe handle.
namestring | nullThe display name.
urlstring | nullA link to the profile.
biostring | nullThe bio.
verifiedboolean | nullWhether the account is verified.
followersinteger | nullFollower count.
followinginteger | nullHow many accounts it follows.
posts_countinteger | nullHow many posts it has published.

commentA comment

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"comment"The object type.
urlstring | nullA link to the comment, where the platform has one.
textstring | nullThe comment itself.
published_atstring | nullWhen it was posted, ISO 8601 in UTC.
author.labelstringAn anonymous label, stable within one response. Whoever wrote it is never named.
metrics.likesinteger | nullLikes.
reply_countinteger | nullHow many replies it has.
content_idstring | nullThe item the comment is under.
parent_idstring | nullThe comment it replies to directly; null for a top-level comment.
root_idstring | nullThe top-level comment its thread hangs under.

entry:trend

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"trend"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fieldsobjectEmpty for a trend.

entry:transcript

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"transcript"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.langstring | nullThe language of the transcript.
fields.textstring | nullThe full text.
fields.segmentsarray | nullTimed segments: start, end and text.

entry:creator_rates

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"creator_rates"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.currencystring | nullThe currency of the amounts.
fields.ratesarray | nullWhat the creator charges: name, amount, settlement and whether it is open.

entry:community

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"community"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.descriptionstring | nullThe community's description.
fields.nsfwboolean | nullWhether it is marked as adult content.
fields.created_atstring | nullWhen it was created, ISO 8601 in UTC.
fields.membersinteger | nullMember count.

entry:product

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"product"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.descriptionstring | nullThe product description.
fields.pricestring | nullThe current price, as a decimal string in fields.currency.
fields.original_pricestring | nullThe price before discount.
fields.currencystring | nullThe currency of the prices.
fields.imagesstring[] | nullImage addresses.
fields.ratingnumber | nullThe rating.
fields.soldinteger | nullUnits sold.
fields.reviews_countinteger | nullHow many reviews it has.
fields.shop.idstring | nullThe shop's ID.
fields.shop.namestring | nullThe shop's name.

entry:review

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"review"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.product_idstring | nullThe product the review is about.
fields.textstring | nullThe review itself.
fields.ratingnumber | nullThe rating given.
fields.published_atstring | nullWhen it was posted, ISO 8601 in UTC.
fields.author.labelstringAn anonymous label, stable within one response. Whoever wrote it is never named.
fields.imagesstring[] | nullImage addresses.
fields.variantstring | nullThe variant that was bought.

entry:keyword_history

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"keyword_history"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.pointsarray | nullOne entry per day, oldest first: date, search_index, composite_index, notes, impressions, views, engagements.

entry:keyword_related

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"keyword_related"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.related_tostring | nullThe keyword you asked about.
fields.relation"query" | "posts" | "prior" | "after" | "suggestion" | nullHow it is related: query (searched together with your keyword), posts (appears with it in content), prior (searched before it), after (searched after it), suggestion (offered as your keyword is typed into the search box).
fields.relevancenumber | nullHow closely it is related to your keyword, from 0 to 1.
fields.search_indexinteger | nullThe related keyword's search index: the platform's own index, not a count of searches. null where the platform gives no figure for the word.
fields.composite_indexinteger | nullThe related keyword's composite index: the platform's own index of how much attention content about it drew, not a count.

entry:keyword_audience

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"keyword_audience"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.agearray | nullBy age group: label, share, tgi. tgi says how over-represented the group is; 100 is average.
fields.genderarray | nullBy gender: label, share, tgi.
fields.provincearray | nullBy province: label, share, tgi.
fields.cityarray | nullBy city, the largest only, so the shares do not add up to 1: label, share, tgi.
fields.city_tierarray | nullBy city tier: label, share, tgi.
fields.interestarray | nullBy interest. One person can have several, so the shares do not add up to 1: label, share, tgi.

entry:brand_history

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"brand_history"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.categorystring | nullThe industry the platform puts the brand in, in the platform's words.
fields.pointsarray | nullOne entry per day, oldest first: date, search_index, content_index, spread_index.

entry:brand_metrics

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"brand_metrics"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.categorystring | nullThe industry the platform puts the brand in, in the platform's words.
fields.search_indexinteger | nullDaily average of the search index over the period.
fields.content_indexinteger | nullDaily average of the content index over the period.
fields.spread_indexinteger | nullDaily average of the spread index over the period.
fields.benchmarksarray | nullBenchmarks from the same industry: the average of all its brands, and of its top brands. Each has scope, search_index, content_index, spread_index.

entry:account_history

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"account_history"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.daysinteger | nullHow many of the most recent days the figures cover.
fields.gained.followersinteger | nullNet new followers; negative when followers were lost.
fields.gained.likesinteger | nullNew likes.
fields.gained.commentsinteger | nullNew comments.
fields.gained.sharesinteger | nullNew shares.
fields.gained.postsinteger | nullPosts published.
fields.change.followersnumber | nullNet new followers compared with the period before, as a ratio.
fields.change.likesnumber | nullNew likes compared with the period before, as a ratio.
fields.change.commentsnumber | nullNew comments compared with the period before, as a ratio.
fields.change.sharesnumber | nullNew shares compared with the period before, as a ratio.
fields.change.postsnumber | nullPosts published compared with the period before, as a ratio.
fields.totals.followersinteger | nullFollowers now.
fields.totals.likesinteger | nullLikes received in total.
fields.totals.postsinteger | nullPosts published in total.

entry:index_creator_metrics

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"index_creator_metrics"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.average_7d.likesnumber | nullNew likes a day, on average over the last week.
fields.average_7d.followsnumber | nullFollows a day, on average over the last week, as the platform counts them: not the net gain in followers, larger, and positive even when followers were lost.
fields.average_7d.sharesnumber | nullNew shares a day, on average over the last week.
fields.average_7d.commentsnumber | nullNew comments a day, on average over the last week.
fields.average_30d.likesnumber | nullNew likes a day, on average over the last month.
fields.average_30d.followsnumber | nullFollows a day, on average over the last month, as the platform counts them (not the net gain in followers).
fields.average_30d.sharesnumber | nullNew shares a day, on average over the last month.
fields.average_30d.commentsnumber | nullNew comments a day, on average over the last month.
fields.change_7d.likesnumber | nullNew likes a day over the last week compared with the week before, as a ratio.
fields.change_7d.followsnumber | nullFollows a day over the last week compared with the week before, as a ratio.
fields.change_7d.sharesnumber | nullNew shares a day over the last week compared with the week before, as a ratio.
fields.change_7d.commentsnumber | nullNew comments a day over the last week compared with the week before, as a ratio.
fields.change_30d.likesnumber | nullNew likes a day over the last month compared with the month before, as a ratio.
fields.change_30d.followsnumber | nullFollows a day over the last month compared with the month before, as a ratio.
fields.change_30d.sharesnumber | nullNew shares a day over the last month compared with the month before, as a ratio.
fields.change_30d.commentsnumber | nullNew comments a day over the last month compared with the month before, as a ratio.

entry:creator

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"creator"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.account_idstring | nullThe creator's account ID on the platform, which the platform's account calls take.
fields.usernamestring | nullThe creator's handle.
fields.locationstring | nullWhere the creator is based, in the platform's words.
fields.categoriesstring[] | nullContent categories, first level, in the platform's words.
fields.subcategoriesstring[] | nullContent categories, second level, in the platform's words.
fields.followersinteger | nullFollowers.

entry:audience

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"audience"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.measured_atstring | nullThe day the figures are for, as the start of that day in China time (UTC+8).
fields.genderarray | nullBy gender: name, share, count.
fields.agearray | nullBy age group: name, share, count.
fields.provincearray | nullBy province: name, share, count.
fields.cityarray | nullBy city, the largest only: name, share, count.
fields.interestarray | nullBy interest: name, share, count.
fields.devicearray | nullBy phone brand: name, share, count.
fields.city_tierarray | nullBy city tier: name, share, count.
fields.crowdarray | nullBy the consumer groups the platform sorts people into: name, share, count.
fields.purchase_categoryarray | nullBy category of goods bought: name, share, count.
fields.purchase_amountarray | nullBy amount spent per order: name, share, count.

entry:xingtu_creator_metrics

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"xingtu_creator_metrics"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.videosinteger | nullVideos in the period.
fields.median_viewsinteger | nullMedian views per video.
fields.average_likesinteger | nullAverage likes per video.
fields.average_commentsinteger | nullAverage comments per video.
fields.average_sharesinteger | nullAverage shares per video.
fields.engagement_ratenumber | nullEngagement rate, 0 to 1.
fields.engagement_rate_percentilenumber | nullThe share of comparable creators this engagement rate beats, 0 to 1.
fields.completion_ratenumber | nullCompletion rate, 0 to 1. Counted only of videos by a Xingtu creator published about 2023 or later: 0 may mean there is none.
fields.completion_rate_percentilenumber | nullThe share of comparable creators this completion rate beats, 0 to 1.
fields.currencystring | nullThe currency of the four costs below.
fields.cpm_integratedstring | nullExpected cost per thousand views of an integrated video (the brand worked into the creator's own video).
fields.cpm_customstring | nullExpected cost per thousand views of a custom video (made for the brand).
fields.cpe_integratedstring | nullExpected cost per interaction of an integrated video.
fields.cpe_customstring | nullExpected cost per interaction of a custom video.

entry:xingtu_creator_post

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"xingtu_creator_post"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.published_atstring | nullWhen it was published.
fields.durationnumber | nullLength of the video, in seconds.
fields.viewsinteger | nullViews.
fields.likesinteger | nullLikes.
fields.commentsinteger | nullComments.
fields.completion_ratenumber | nullCompletion rate, 0 to 1.
fields.engagement_ratenumber | nullEngagement rate, 0 to 1.

entry:pgy_creator_metrics

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"pgy_creator_metrics"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.notesinteger | nullNotes in the period.
fields.median_impressionsinteger | nullMedian impressions per note.
fields.median_readsinteger | nullMedian reads per note.
fields.median_engagementsinteger | nullMedian interactions per note.
fields.median_likesinteger | nullMedian likes per note.
fields.median_collectsinteger | nullMedian saves per note.
fields.median_commentsinteger | nullMedian comments per note.
fields.median_sharesinteger | nullMedian shares per note.
fields.engagement_ratenumber | nullEngagement rate, 0 to 1.
fields.video_completion_ratenumber | nullCompletion rate of video notes, 0 to 1.
fields.image_3s_read_ratenumber | nullShare of image-note reads that last 3 seconds, 0 to 1.
fields.hundred_like_sharenumber | nullShare of notes with 100 likes or more, 0 to 1.
fields.thousand_like_sharenumber | nullShare of notes with 1,000 likes or more, 0 to 1.
fields.impressions_percentilenumber | nullThe share of comparable creators this median of impressions beats, 0 to 1.
fields.reads_percentilenumber | nullThe share of comparable creators this median of reads beats, 0 to 1.
fields.engagements_percentilenumber | nullThe share of comparable creators this median of interactions beats, 0 to 1.

entry:pgy_creator_post

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"pgy_creator_post"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.format"image" | "video" | nullimage for an image note, video for a video note.
fields.published_atstring | nullThe day it was published. The platform gives the day only, shown as the start of that day in China time (UTC+8).
fields.cover_urlstring | nullAddress of the cover image.
fields.is_sponsoredboolean | nullWhether it is a sponsored note: one with a brand.
fields.is_promotedboolean | nullWhether it carried paid promotion traffic. Sponsored or not has nothing to do with it.
fields.brandstring | nullThe brand it was made for, in the platform's words; null when the note is not sponsored.
fields.viewsinteger | nullReads.
fields.likesinteger | nullLikes.
fields.collectsinteger | nullSaves.

entry:pgy_creator_costs

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"pgy_creator_costs"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.datestring | nullThe day the figures are of: a day in China time, as midnight UTC of its date.
fields.currencystring | nullThe currency of the costs.
fields.image_cpmstring | nullEstimated CPM of an image note; null where the marketplace has no estimate.
fields.image_cpm_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.video_cpmstring | nullEstimated CPM of a video note; null where the marketplace has no estimate.
fields.video_cpm_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.image_cpestring | nullEstimated cost per interaction of an image note; null where the marketplace has no estimate.
fields.image_cpe_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.video_cpestring | nullEstimated cost per interaction of a video note; null where the marketplace has no estimate.
fields.video_cpe_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.image_read_coststring | nullEstimated cost per read of an image note; null where the marketplace has no estimate.
fields.image_read_cost_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.video_read_coststring | nullEstimated cost per read of a video note; null where the marketplace has no estimate.
fields.video_read_cost_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.image_shop_visit_coststring | nullEstimated cost per shop visitor an image note brings; null where the marketplace has no estimate.
fields.image_shop_visit_cost_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.video_shop_visit_coststring | nullEstimated cost per shop visitor a video note brings; null where the marketplace has no estimate.
fields.video_shop_visit_cost_percentilenumber | nullThe share of comparable creators whose cost is higher, 0 to 1.
fields.median_impressionsinteger | nullMedian impressions of a note.
fields.median_impressions_percentilenumber | nullThe share of comparable creators it exceeds, 0 to 1.
fields.median_readsinteger | nullMedian reads of a note.
fields.median_reads_percentilenumber | nullThe share of comparable creators it exceeds, 0 to 1.
fields.median_engagementsinteger | nullMedian interactions of a note.
fields.median_engagements_percentilenumber | nullThe share of comparable creators it exceeds, 0 to 1.
fields.median_shop_visitsinteger | nullMedian shop visitors a note brings.
fields.median_shop_visits_percentilenumber | nullThe share of comparable creators it exceeds, 0 to 1.
fields.follower_growthnumber | nullFollower growth over the last 30 days: 0.037 is 3.7% more; negative when followers were lost.
fields.follower_growth_percentilenumber | nullThe share of comparable creators it exceeds, 0 to 1.
fields.invite_reply_ratenumber | nullThe share of invitations answered within 48 hours, 0 to 1.
fields.easy_to_reachboolean | nullWhether the marketplace marks the creator easy to reach.
fields.active_days_7dinteger | nullDays active of the last 7.
fields.is_activeboolean | nullWhether the marketplace marks the creator active.
fields.notes_30dinteger | nullNotes published over the last 30 days, everyday and sponsored.
fields.highlightstring | nullThe strength the marketplace marks, in its words; null when none.
fields.highlight_reasonstring | nullWhat that strength rests on, in its words.
fields.content_mixarray | nullThe kinds of content and their shares, the largest first: category, share.
fields.industriesstring[] | nullIndustries worked with, in the platform's words.

entry:pgy_creator_followers

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"pgy_creator_followers"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.followersinteger | nullFollowers.
fields.gainedinteger | nullNet followers gained over the last 30 days; negative when followers were lost.
fields.growthnumber | nullFollower growth over the last 30 days: 0.008 is 0.8% more.
fields.growth_percentilenumber | nullThe share of comparable creators it exceeds, 0 to 1.
fields.active_followersinteger | nullFollowers active on the platform in the last 28 days.
fields.active_sharenumber | nullTheir share of all followers, 0 to 1.
fields.active_percentilenumber | nullThe share of comparable creators that share exceeds, 0 to 1.
fields.engaged_followersinteger | nullFollowers who interacted with the creator's notes in the last 30 days.
fields.engaged_sharenumber | nullTheir share of all followers, 0 to 1.
fields.engaged_percentilenumber | nullThe share of comparable creators that share exceeds, 0 to 1.
fields.reading_followersinteger | nullFollowers who read the creator's notes in the last 30 days.
fields.reading_sharenumber | nullTheir share of all followers, 0 to 1.
fields.reading_percentilenumber | nullThe share of comparable creators that share exceeds, 0 to 1.
fields.buying_followersinteger | nullFollowers who bought something on the platform in the last 30 days.
fields.buying_sharenumber | nullTheir share of all followers, 0 to 1.

entry:pgy_creator_cost_history

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"pgy_creator_cost_history"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.daysinteger | nullHow many of the most recent days the figures cover.
fields.currencystring | nullThe currency of the costs.
fields.datestring | nullThe day the period's figures run to, as midnight UTC of its date in China time.
fields.cpmstring | nullCost of a thousand impressions; null where there is none.
fields.cpestring | nullCost of one interaction; null where there is none.
fields.cpvstring | nullCost of one read; null where there is none.
fields.shop_visit_coststring | nullCost per shop visitor a note brings; null where there is none.
fields.median_impressionsinteger | nullMedian impressions of a note.
fields.median_readsinteger | nullMedian reads of a note.
fields.median_engagementsinteger | nullMedian interactions of a note.
fields.median_shop_visitsinteger | nullMedian shop visitors a note brings.
fields.pointsarray | nullThe same figures day by day, oldest first: date, cpm, cpe, cpv, shop_visit_cost and the four medians.

entry:pgy_note

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"pgy_note"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.format"image" | "video" | nullimage for an image note, video for a video note.
fields.textstring | nullThe note's text.
fields.published_atstring | nullWhen it was published.
fields.imagesstring[] | nullAddresses of its pictures, in order.
fields.creator_idstring | nullThe creator's marketplace ID, as the other creator calls take it.
fields.creator_namestring | nullThe creator's name.
fields.brandstring | nullThe brand it was reported as sponsored by; null when it is no reported sponsored note.
fields.brand_idstring | nullThe platform account ID of that brand; null when there is none.
fields.impressionsinteger | nullImpressions.
fields.viewsinteger | nullReads.
fields.likesinteger | nullLikes.
fields.collectsinteger | nullSaves.
fields.commentsinteger | nullComments.
fields.sharesinteger | nullShares.
fields.followsinteger | nullFollowers the note brought its creator.
fields.component_clicks.comment_area"normal" | "high" | "very_high" | nullClick band of the brand's comment-area component: normal (0–2%), high (2–10%) or very_high; null when the note has none.
fields.component_clicks.content"normal" | "high" | "very_high" | nullClick band of the in-text component; null when the note has none.
fields.component_clicks.note_bottom"normal" | "high" | "very_high" | nullClick band of the component at the bottom of the note; null when the note has none.

entry:xingtu_creator_keywords

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"xingtu_creator_keywords"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.keywordsarray | nullThe words that come up most, one entry each: keyword, mentions.

entry:xingtu_creator_scores

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"xingtu_creator_scores"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.overall.scorenumber | nullThe overall Xingtu score, 0 to 100.
fields.overall.averagenumber | nullWhat comparable creators average on the overall Xingtu score.
fields.overall.rankinteger | nullThe creator's rank on the overall Xingtu score; 1 is the highest.
fields.overall.rank_sharenumber | nullHow near the top that rank is, 0 to 1: 0.05 means the top 5%.
fields.reach.scorenumber | nullThe reach score, 0 to 100.
fields.reach.averagenumber | nullWhat comparable creators average on the reach score.
fields.reach.rankinteger | nullThe creator's rank on the reach score; 1 is the highest.
fields.reach.rank_sharenumber | nullHow near the top that rank is, 0 to 1: 0.05 means the top 5%.
fields.seeding.scorenumber | nullThe seeding score, 0 to 100.
fields.seeding.averagenumber | nullWhat comparable creators average on the seeding score.
fields.seeding.rankinteger | nullThe creator's rank on the seeding score; 1 is the highest.
fields.seeding.rank_sharenumber | nullHow near the top that rank is, 0 to 1: 0.05 means the top 5%.
fields.conversion.scorenumber | nullThe conversion score, 0 to 100.
fields.conversion.averagenumber | nullWhat comparable creators average on the conversion score.
fields.conversion.rankinteger | nullThe creator's rank on the conversion score; 1 is the highest.
fields.conversion.rank_sharenumber | nullHow near the top that rank is, 0 to 1: 0.05 means the top 5%.
fields.cooperation.scorenumber | nullThe cooperation score, 0 to 100.
fields.cooperation.averagenumber | nullWhat comparable creators average on the cooperation score.
fields.cooperation.rankinteger | nullThe creator's rank on the cooperation score; 1 is the highest.
fields.cooperation.rank_sharenumber | nullHow near the top that rank is, 0 to 1: 0.05 means the top 5%.
fields.value_for_money.scorenumber | nullThe value-for-money score, 0 to 100.
fields.value_for_money.averagenumber | nullWhat comparable creators average on the value-for-money score.
fields.value_for_money.rankinteger | nullThe creator's rank on the value-for-money score; 1 is the highest.
fields.value_for_money.rank_sharenumber | nullHow near the top that rank is, 0 to 1: 0.05 means the top 5%.

entry:xingtu_creator_content_mix

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"xingtu_creator_content_mix"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.categoriesarray | nullThe content categories, one entry each: name, share, videos.

entry:xingtu_campaign

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"xingtu_campaign"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.descriptionstring | nullWhat the campaign is.
fields.category"platform_event" | "ecommerce" | "seasonal" | "creative" | "industry" | nullThe kind of campaign: a platform event, an e-commerce date, a seasonal or mood moment, creative marketing, or an industry campaign.
fields.stage"preparing" | "open" | "live" | "ended" | nullHow far along the campaign is: in preparation, open for sign-up, live, or ended.
fields.signup_starts_atstring | nullWhen sign-up opens.
fields.signup_ends_atstring | nullWhen sign-up closes.
fields.starts_atstring | nullWhen the campaign starts.
fields.ends_atstring | nullWhen the campaign ends.
fields.image_urlstring | nullThe campaign's main image.

entry:ad

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"ad"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.format"video" | "image" | "carousel" | "text" | "other" | nullThe ad's format: text, image or video. other is a format of the platform's own.
fields.textstring | nullThe ad's body text.
fields.landing_urlstring | nullWhere a click on the ad leads.
fields.advertiser.idstring | nullAdvertiser ID.
fields.advertiser.namestring | nullAdvertiser's name.
fields.advertiser.urlstring | nullThe advertiser's page on the platform.
fields.imagesstring[] | nullAddresses of the ad's images.
fields.first_shown_atstring | nullWhen the ad was first shown.
fields.last_shown_atstring | nullWhen the ad was last shown. For an ad still running, when the platform last saw it.

entry:advertiser

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"advertiser"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.regionstring | nullThe code of the country or region the advertiser is registered in.

entry:channels_collection

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"channels_collection"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.descriptionstring | nullThe collection's own description; null when it has none.
fields.cover_urlstring | nullAddress of the collection's cover image.
fields.updated_atstring | nullWhen the collection was last updated.
fields.videosinteger | nullVideos in the collection.

entry:topic

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"topic"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.descriptionstring | nullThe topic's own description; null when it has none.
fields.viewsinteger | nullViews of the topic.
fields.postsinteger | nullPosts under the topic.

entry:account_owner

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"account_owner"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.owner_type"company" | "government" | "media" | "individual" | "other" | nullWhat the owner is: company, government, media, individual or other.
fields.registration_idstring | nullThe number the owner is registered under, such as a unified social credit code; null where the platform gives none.
fields.countrystring | nullThe owner's country or region, in the platform's words.
fields.verification"verified" | "unverified" | "expired" | nullThe account's verification: verified, unverified or expired.
fields.verification_typestring | nullThe kind of verification, in the platform's words; null when not verified.
fields.verified_atstring | nullWhen the verification was granted.
fields.account_idstring | nullThe account you asked about.
fields.account_created_atstring | nullWhen the account was registered.

entry:miniprogram

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"miniprogram"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.app_idstring | nullThe AppID (starting with wx), used to open or link to the mini program; null where the platform gives none.
fields.descriptionstring | nullWhat the mini program says it is.
fields.owner_namestring | nullThe company or body that runs it.
fields.owner_verifiedboolean | nullWhether the owner is verified.
fields.recent_usersinteger | nullHow many used it lately, as the platform shows it; a figure shown like 1万+ is a lower bound.
fields.is_gameboolean | nullWhether it is a mini game.

entry:follower_history

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"follower_history"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.daysinteger | nullHow many of the most recent days the figures cover.
fields.gainedinteger | nullNet followers gained over those days; negative when followers were lost.
fields.growthnumber | nullThat gain against the followers at the start: 0.01 is 1% more.
fields.pointsarray | nullFollowers day by day, oldest first: date, followers.

entry:channels_share_link

FieldTypeWhat it is
platformstringThe platform the item is from.
idstring | nullThe platform's own ID.
refstring | nullWhat to send back in a request to point at this item.
approxarrayWhich numbers of this item are approximate or lower bounds; empty when all are exact.
extraobjectWhat the platform gives of this item beyond the fields below, under the platform's own names (an IP location, a uid, a showcase flag); the interface's extra_fields says what each is. Empty when there is nothing more. Of a comment or a review, never who wrote it.
type"entry"The object type.
entry_type"channels_share_link"What kind of entry this is.
titlestring | nullThe entry's title or name.
urlstring | nullA link that opens it; null where the platform's list has none.
rankinteger | nullPosition on a board, from 1.
heatinteger | nullThe platform's heat score.
fields.share_urlstring | nullA link that opens the video in WeChat (also the entry's url): a new one each time, and the old ones still open it.

Versions and deprecation

  • The API's version is in its address (/v1) and in every answer (schema_version: "v1").
  • Within a version, fields and error codes are only added: ignore the ones your code does not know. A field that is there stays, and a value the platform cannot give is null.
  • A published MCP tool name or op name is never removed or reused. An interface can be paused: the catalog, its page and the answer say so, and a paused call is not charged.
  • A change that would break existing calls comes as a new version, announced in the changelog before the old one stops.

The error structure

A request that fails as a whole answers with this instead of the envelope, under the HTTP status of its code. A result that fails inside a 200 answer carries the same error object.

FieldTypeWhat it is
request_idstringIdentifies this call. Quote it when you report a problem.
schema_version"v1"Always "v1".
error.codestringThe error code: one row of the error table.
error.messagestringWhat went wrong, in Chinese and in English.
error.retryablebooleanWhether sending the same request again can work.
error.reasonstringWhich case of the code this is, where a code has several. (may be absent)
error.quote_creditsintegerWhat the refused request would have cost. (may be absent)
error.resets_atstringWhen a daily limit starts again, ISO 8601 in UTC. (may be absent)
error.retry_atstringAfter free_failure_limit: from when a call may be sent again, ISO 8601 in UTC. (may be absent)
error.retry_after_secondsintegerWith an upstream_error worth one more try: how many seconds to wait before sending it once more. (may be absent)
error.whystringWith not_found, when the platform says why: deleted, self_only, partial, withheld, no_such, closed or link_refused. (may be absent)
error.platform_saysstringThe platform's own words about it, as it gave them (at most 200 characters). (may be absent)
error.charged"true"true when this failure was charged: a lookup of something not there, where the platform's source charges for it. Absent: nothing was charged. (may be absent)
error.alternative.opstringWith an upstream_error of a call that has a backup source: the backup call. (may be absent)
error.alternative.creditsintegerWhat the backup call costs. (may be absent)
error.alternative.callobjectThe same request on the backup, ready to send. It is never sent unless you send it. (may be absent)
error.alternative.notestringOne sentence on it, for the AI. (may be absent)
error.fix.paramstringThe parameter to correct. (may be absent)
error.fix.allowedarrayThe values that parameter may take. (may be absent)
error.fix.example_callobjectA call that would work, ready to copy. It never repeats a key. (may be absent)
error.fix.mcp_call.toolstringThe MCP tool to call. (may be absent)
error.fix.mcp_call.argumentsobjectIts arguments. (may be absent)
error.fix.action_urlstringWhere to go to fix it: the console, billing or the status page. (may be absent)
error.fix.notestringWhat to do, in a sentence. (may be absent)
billing.cost_creditsintegerAlways 0: a request that fails as a whole is not charged. (may be absent)
billing.balance_creditsintegerYour balance. Present when the key is known. (may be absent)
billing.today_spend_creditsintegerCredits spent today, in UTC. (may be absent)
billing.daily_limit_creditsinteger | nullYour daily limit; null when none is set. (may be absent)
billing.daily_remaining_creditsinteger | nullWhat is left of the daily limit; null when none is set. (may be absent)
billing.displaystringOne sentence an AI can repeat to you. (may be absent)

Errors lists every code.

When the answer is not ready

A call that cannot answer within its request answers HTTP 202 with a handle instead of this envelope, and the envelope is read with the handle afterwards. See Results and handles.

Last updated: