okdata 0.1.0__py3-none-any.whl

okdata/_generated/_models.py

@@ -0,0 +1,1329 @@
+"""Generated by scripts/generate.ts from @okdata/catalog. Do not edit by hand.
+
+The objects endpoints return, as TypedDicts over the JSON: a Post has the same keys on Douyin and on
+YouTube. Keys outside view=compact may be absent, and fields= keeps only what you ask for.
+"""
+from __future__ import annotations
+
+from typing import Any, Dict, List, Literal, Optional, TypedDict
+
+
+class Account(TypedDict, total=False):
+    id: str
+    """Account ID on the platform."""
+    url: str
+    """Profile link."""
+    username: Optional[str]
+    """Handle, where the platform has one."""
+    name: str
+    """Display name."""
+    bio: Optional[str]
+    """Profile bio."""
+    avatar_url: Optional[str]
+    """Avatar image URL. (view=standard and up)"""
+    verified: Optional[bool]
+    """Whether the platform shows a verification badge. (view=standard and up)"""
+    followers: Optional[int]
+    """Followers."""
+    following: Optional[int]
+    """Accounts it follows."""
+    posts: Optional[int]
+    """Posts, videos, notes or articles published."""
+    likes: Optional[int]
+    """Total likes received, where the platform shows it."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class AccountChange(TypedDict, total=False):
+    followers: Optional[float]
+    """Change in net followers gained."""
+    likes: Optional[float]
+    """Change in likes received."""
+    comments: Optional[float]
+    """Change in comments received."""
+    shares: Optional[float]
+    """Change in shares received."""
+    posts: Optional[float]
+    """Change in posts published."""
+
+
+class AccountGain(TypedDict, total=False):
+    followers: Optional[int]
+    """Net followers gained; negative when the account lost followers."""
+    likes: Optional[int]
+    """Likes received."""
+    comments: Optional[int]
+    """Comments received."""
+    shares: Optional[int]
+    """Shares received."""
+    posts: Optional[int]
+    """Posts published."""
+
+
+class AccountHistory(TypedDict, total=False):
+    id: str
+    """The account's numeric ID (the one asked about)."""
+    name: Optional[str]
+    """Display name."""
+    url: Optional[str]
+    """Profile link."""
+    avatar_url: Optional[str]
+    """Avatar. (view=standard and up)"""
+    days: int
+    """How many of the most recent days the figures cover."""
+    gained: AccountGain
+    """What the account gained over the period."""
+    change: AccountChange
+    """Each gain against the same length of time before, as a ratio: 0.3 is 30% more, -0.5 is half."""
+    totals: Optional[AccountTotals]
+    """Totals as of now. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class AccountOwner(TypedDict, total=False):
+    name: Optional[str]
+    """The owner's name: a company's or body's full name, or a person's name."""
+    type: Optional[Literal["company", "government", "media", "individual", "other"]]
+    """What the owner is."""
+    registration_id: Optional[str]
+    """Registration number (unified social credit code, licence or organisation code); null where none is given."""
+    country: Optional[str]
+    """Country or region, in the platform's words. (view=standard and up)"""
+    verification: Optional[Literal["verified", "unverified", "expired"]]
+    """Verification state of the account."""
+    verification_type: Optional[str]
+    """Kind of verification, in the platform's words; null when not verified. (view=standard and up)"""
+    verified_at: Optional[str]
+    """Date the verification was granted, as 00:00 UTC. (view=standard and up)"""
+    account_id: str
+    """ID of the account asked about."""
+    account_created_at: Optional[str]
+    """Date the account was registered, as 00:00 UTC. (view=standard and up)"""
+    authorized_services: Optional[List[str]]
+    """Third-party services the account has authorised, in the platform's words. (view=full and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class AccountRef(TypedDict, total=False):
+    id: str
+    """Account ID on the platform."""
+    username: Optional[str]
+    """Handle, where the platform has one."""
+    name: Optional[str]
+    """Display name."""
+    avatar_url: Optional[str]
+    """Avatar image URL. (view=standard and up)"""
+    followers: Optional[int]
+    """Follower count at fetch time. (view=standard and up)"""
+    verified: Optional[bool]
+    """Whether the platform shows a verification badge. (view=standard and up)"""
+
+
+class AccountTotals(TypedDict, total=False):
+    followers: Optional[int]
+    """Followers now. (view=standard and up)"""
+    likes: Optional[int]
+    """Likes received in all. (view=standard and up)"""
+    posts: Optional[int]
+    """Posts in all. (view=standard and up)"""
+
+
+class Ad(TypedDict, total=False):
+    id: str
+    """Ad ID in the library."""
+    url: str
+    """Link to the ad in the library."""
+    advertiser: AdvertiserRef
+    """Who runs the ad."""
+    title: Optional[str]
+    """Headline, where the ad has one."""
+    text: str
+    """Ad copy as plain text; empty when the ad has none."""
+    format: Optional[Literal["image", "video", "carousel", "text", "dynamic"]]
+    """Creative format; dynamic means the platform assembles it per viewer (catalog ads)."""
+    images: Optional[List[str]]
+    """Image URLs of the creative. (view=standard and up)"""
+    videos: Optional[List[str]]
+    """Video URLs of the creative. (view=full and up)"""
+    landing_url: Optional[str]
+    """Where the ad leads. (view=standard and up)"""
+    cta: Optional[str]
+    """Call-to-action button text. (view=standard and up)"""
+    platforms: Optional[List[str]]
+    """Where it is delivered, e.g. facebook, instagram. (view=standard and up)"""
+    active: Optional[bool]
+    """Whether the ad is still running."""
+    first_shown_at: Optional[str]
+    """First time or day shown, ISO 8601 in UTC."""
+    last_shown_at: Optional[str]
+    """Last time or day shown, ISO 8601 in UTC."""
+    reach: Optional[str]
+    """People reached, as the library publishes it: a bracket such as 1K-10K, or a count (the EU reach of a Meta ad); null where none is published. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class Advertiser(TypedDict, total=False):
+    id: str
+    """Advertiser ID in the library."""
+    url: str
+    """The advertiser's page in the library."""
+    name: str
+    """The name the library shows, often the legal entity."""
+    region: Optional[str]
+    """Country or region it is registered in (ISO code)."""
+    ads: Optional[int]
+    """The library's estimate of how many ads it has. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class AdvertiserRef(TypedDict, total=False):
+    id: Optional[str]
+    """The advertiser's ID in the library."""
+    name: Optional[str]
+    """The advertiser's name."""
+    url: Optional[str]
+    """The advertiser's page. (view=standard and up)"""
+
+
+class Audience(TypedDict, total=False):
+    creator_id: str
+    """The creator ID asked about."""
+    measured_at: Optional[str]
+    """The day the figures are of, as 00:00 China time."""
+    gender: Optional[List[AudienceSegment]]
+    """By gender."""
+    age: Optional[List[AudienceSegment]]
+    """By age group."""
+    province: Optional[List[AudienceSegment]]
+    """By province."""
+    city: Optional[List[AudienceSegment]]
+    """By city, the largest only."""
+    interest: Optional[List[AudienceSegment]]
+    """By interest."""
+    device: Optional[List[AudienceSegment]]
+    """By phone brand."""
+    city_tier: Optional[List[AudienceSegment]]
+    """By city tier."""
+    crowd: Optional[List[AudienceSegment]]
+    """By the consumer groups the platform sorts people into."""
+    purchase_category: Optional[List[AudienceSegment]]
+    """By the category of goods bought."""
+    purchase_amount: Optional[List[AudienceSegment]]
+    """By the amount spent per order."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class AudienceSegment(TypedDict, total=False):
+    name: str
+    """The segment, in the platform's words (genders come as lower-case English)."""
+    share: Optional[float]
+    """The segment's share of the segments listed, 0 to 1."""
+    count: Optional[int]
+    """Followers in the segment."""
+
+
+class BrandBenchmark(TypedDict, total=False):
+    scope: Literal["all", "top3", "top5", "top10", "top15", "top30"]
+    """Which brands the average is over: the whole industry, or its top 3, 5, 10, 15 or 30."""
+    search_index: Optional[int]
+    """Their daily average search index."""
+    content_index: Optional[int]
+    """Their daily average content index."""
+    spread_index: Optional[int]
+    """Their daily average spread index."""
+
+
+class BrandHistory(TypedDict, total=False):
+    brand: str
+    """The brand's name."""
+    category: Optional[str]
+    """The industry the platform files the brand under, in its words."""
+    points: List[BrandPoint]
+    """One entry a day, oldest first."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class BrandMetrics(TypedDict, total=False):
+    brand: str
+    """The brand's name."""
+    category: Optional[str]
+    """The industry the platform files the brand under, in its words."""
+    search_index: Optional[int]
+    """Daily average search index over the period."""
+    content_index: Optional[int]
+    """Daily average content index over the period."""
+    spread_index: Optional[int]
+    """Daily average spread index over the period."""
+    benchmarks: Optional[List[BrandBenchmark]]
+    """The same averages for the whole industry and for its leading brands."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class BrandPoint(TypedDict, total=False):
+    date: str
+    """The day: a calendar day in China time (UTC+8), written as 00:00 UTC of that date."""
+    search_index: Optional[int]
+    """Search index: search interest in the brand, not a count of searches."""
+    content_index: Optional[int]
+    """Content index: how much content there was about the brand, not a count of posts."""
+    spread_index: Optional[int]
+    """Spread index: how far that content travelled, not a count."""
+
+
+class CategoryShare(TypedDict, total=False):
+    category: str
+    """The content category, in the platform's words. (view=standard and up)"""
+    share: Optional[float]
+    """The category's share of the creator's notes, 0 to 1. (view=standard and up)"""
+
+
+class ChannelsCollection(TypedDict, total=False):
+    id: str
+    """The collection's ID; pass it as is to the endpoint that lists its videos."""
+    name: str
+    """Name of the collection."""
+    description: Optional[str]
+    """What the collection says it is about; null when nothing."""
+    cover_url: Optional[str]
+    """Cover image. (view=standard and up)"""
+    updated_at: Optional[str]
+    """When the collection was last updated."""
+    metrics: CollectionMetrics
+    """Counts at fetch time."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class ChannelsShareLink(TypedDict, total=False):
+    id: str
+    """The video's ID."""
+    url: str
+    """The share link (weixin.qq.com/sph/…)."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class CollectionMetrics(TypedDict, total=False):
+    videos: Optional[int]
+    """Videos in the collection."""
+
+
+class Comment(TypedDict, total=False):
+    id: str
+    """Comment ID."""
+    post_id: str
+    """ID of the post it is under."""
+    parent_id: Optional[str]
+    """The comment it replies to; null for top-level comments."""
+    text: str
+    """Comment text."""
+    published_at: str
+    """When it was posted, ISO 8601 in UTC."""
+    author: AccountRef
+    """Who wrote it."""
+    likes: Optional[int]
+    """Likes on the comment."""
+    replies: Optional[int]
+    """Replies under it."""
+    ip_location: Optional[str]
+    """Region label the platform shows next to the comment, if any. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class Community(TypedDict, total=False):
+    id: str
+    """ID; pass it as is to the endpoints that take one."""
+    name: str
+    """Name of the community."""
+    url: Optional[str]
+    """Link to the community."""
+    description: Optional[str]
+    """What the community says it is about."""
+    avatar_url: Optional[str]
+    """Icon of the community. (view=standard and up)"""
+    nsfw: Optional[bool]
+    """Whether it is marked as adult content. (view=standard and up)"""
+    created_at: Optional[str]
+    """When the community was created. (view=standard and up)"""
+    metrics: CommunityMetrics
+    """Counts at fetch time."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class CommunityMetrics(TypedDict, total=False):
+    members: Optional[int]
+    """Members."""
+
+
+class ContentShare(TypedDict, total=False):
+    name: str
+    """The content category, in the platform's words."""
+    share: Optional[float]
+    """The category's share of the videos counted, 0 to 1."""
+    videos: Optional[int]
+    """Videos in the category."""
+
+
+class Creator(TypedDict, total=False):
+    id: str
+    """The marketplace's creator ID; the other marketplace endpoints take it."""
+    url: str
+    """The creator's page on the marketplace."""
+    account_id: Optional[str]
+    """The creator's own account ID on the platform, where the marketplace gives it: on Douyin the sec_uid (MS4w…) that douyin.users.get takes, on Xiaohongshu the user ID."""
+    username: Optional[str]
+    """Handle on the platform, where given."""
+    name: str
+    """Display name."""
+    avatar_url: Optional[str]
+    """Avatar image URL. (view=standard and up)"""
+    location: Optional[str]
+    """Where the creator says they are. (view=standard and up)"""
+    gender: Optional[Literal["female", "male"]]
+    """The creator's gender as the marketplace lists it. (view=standard and up)"""
+    followers: Optional[int]
+    """Followers."""
+    categories: Optional[List[str]]
+    """Content categories in the marketplace’s own words."""
+    engagement_rate: Optional[float]
+    """Interactions per view of recent posts, 0 to 1 (0.038 is 3.8%)."""
+    median_views: Optional[int]
+    """Median views or reads of recent everyday posts."""
+    median_engagements: Optional[int]
+    """Median interactions (likes, comments, saves, shares) of recent everyday posts."""
+    rates: Optional[List[Rate]]
+    """Published rates for sponsored work; null when the marketplace hides them."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class CreatorKeyword(TypedDict, total=False):
+    keyword: str
+    """The keyword."""
+    mentions: Optional[int]
+    """How often the marketplace counted it; small numbers, good for ordering only."""
+
+
+class CreatorRate(TypedDict, total=False):
+    creator_id: str
+    """The marketplace creator ID."""
+    url: str
+    """The creator's page on the marketplace."""
+    rates: List[Rate]
+    """Every offering on the rate card."""
+    industries: Optional[List[str]]
+    """Industries the marketplace files the creator under."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class CreatorScore(TypedDict, total=False):
+    score: Optional[float]
+    """The score, 0 to 100."""
+    average: Optional[float]
+    """Average score of comparable creators."""
+    rank: Optional[int]
+    """Rank on this score, 1 is the highest."""
+    rank_share: Optional[float]
+    """How far from the top the rank is, 0 to 1 (0.05 is the top 5%); to four decimals, so the top hundred or so read 0."""
+
+
+class FollowerHistory(TypedDict, total=False):
+    creator_id: str
+    """The creator ID asked about."""
+    days: int
+    """How many of the most recent days the figures cover."""
+    gained: Optional[int]
+    """Net followers gained over the period; negative when the creator lost followers."""
+    growth: Optional[float]
+    """The net gain as a share of the followers at the start: 0.01 is 1% more."""
+    points: List[FollowerPoint]
+    """One entry a day, oldest first."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class FollowerPoint(TypedDict, total=False):
+    date: str
+    """The day: a calendar day in China time (UTC+8), written as 00:00 UTC of that date."""
+    followers: Optional[int]
+    """Followers that day."""
+
+
+class IndexCreatorMetrics(TypedDict, total=False):
+    creator_id: str
+    """The account's numeric ID (the one asked about)."""
+    average_7d: Optional[IndexDailyAverages]
+    """Daily averages over the last 7 days."""
+    average_30d: Optional[IndexDailyAverages]
+    """Daily averages over the last 30 days."""
+    change_7d: Optional[IndexDailyChange]
+    """The last 7 days against the 7 before, as a ratio: 0.3 is 30% more."""
+    change_30d: Optional[IndexDailyChange]
+    """The last 30 days against the 30 before, as a ratio."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class IndexDailyAverages(TypedDict, total=False):
+    likes: Optional[float]
+    """New likes a day, on average."""
+    follows: Optional[float]
+    """Follows a day, on average (the platform's own count of follows, not the net change in followers)."""
+    shares: Optional[float]
+    """New shares a day, on average."""
+    comments: Optional[float]
+    """New comments a day, on average."""
+
+
+class IndexDailyChange(TypedDict, total=False):
+    likes: Optional[float]
+    """Change in new likes a day."""
+    follows: Optional[float]
+    """Change in follows a day (the platform's own count of follows, not the net change in followers)."""
+    shares: Optional[float]
+    """Change in new shares a day."""
+    comments: Optional[float]
+    """Change in new comments a day."""
+
+
+class KeywordAudience(TypedDict, total=False):
+    keyword: str
+    """The keyword."""
+    age: Optional[List[KeywordSegment]]
+    """By age group."""
+    gender: Optional[List[KeywordSegment]]
+    """By gender."""
+    province: Optional[List[KeywordSegment]]
+    """By province."""
+    city: Optional[List[KeywordSegment]]
+    """By city: the largest only, so the shares need not add up to 1."""
+    city_tier: Optional[List[KeywordSegment]]
+    """By city tier."""
+    interest: Optional[List[KeywordSegment]]
+    """By interest; the shares need not add up to 1."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class KeywordHistory(TypedDict, total=False):
+    keyword: str
+    """The keyword."""
+    points: List[KeywordPoint]
+    """One entry a day, oldest first."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class KeywordPoint(TypedDict, total=False):
+    date: str
+    """The day: a calendar day in China time (UTC+8), written as 00:00 UTC of that date."""
+    search_index: Optional[int]
+    """That day's search index: the platform's measure of search interest, not a count of searches."""
+    composite_index: Optional[int]
+    """That day's composite index: the platform's measure of attention to content about the keyword, not a count."""
+    notes: Optional[int]
+    """Posts about the keyword that day. (view=standard and up)"""
+    impressions: Optional[int]
+    """Times those posts were shown that day. (view=standard and up)"""
+    views: Optional[int]
+    """Times those posts were read that day. (view=standard and up)"""
+    engagements: Optional[int]
+    """Interactions with those posts that day. (view=standard and up)"""
+
+
+class KeywordRelated(TypedDict, total=False):
+    keyword: str
+    """The related keyword."""
+    related_to: str
+    """The keyword asked about."""
+    relation: Optional[Literal["query", "posts", "prior", "after", "suggestion"]]
+    """How it relates: searched together (query), appears together in content (posts), searched before (prior) or after (after), or suggested as you type (suggestion)."""
+    rank: Optional[int]
+    """Position among the keywords of the same relation, from 1."""
+    relevance: Optional[float]
+    """How closely it is related, 0 to 1."""
+    search_index: Optional[int]
+    """Its search index (the platform's measure, not a count); null where the platform gives none."""
+    composite_index: Optional[int]
+    """Its composite index (the platform's measure of attention, not a count)."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class KeywordSegment(TypedDict, total=False):
+    label: str
+    """The group, in the platform's words."""
+    share: Optional[float]
+    """The group's share of the keyword's audience, 0 to 1."""
+    tgi: Optional[float]
+    """TGI: how strongly the group leans to the keyword; 100 is the platform average."""
+
+
+class Metrics(TypedDict, total=False):
+    views: Optional[int]
+    """Views or plays."""
+    likes: Optional[int]
+    """Likes."""
+    comments: Optional[int]
+    """Comments."""
+    shares: Optional[int]
+    """Shares."""
+    favorites: Optional[int]
+    """Saves or favorites."""
+    reposts: Optional[int]
+    """Reposts, retweets or forwards."""
+
+
+class Miniprogram(TypedDict, total=False):
+    id: str
+    """Original ID (gh_…)."""
+    app_id: Optional[str]
+    """AppID (wx…), used to open or link to it; null where none is given."""
+    name: str
+    """Name."""
+    description: Optional[str]
+    """Description."""
+    icon_url: Optional[str]
+    """Icon. (view=standard and up)"""
+    owner_name: Optional[str]
+    """The company or body that runs it."""
+    owner_verified: Optional[bool]
+    """Whether the owner is verified. (view=standard and up)"""
+    recent_users: Optional[int]
+    """Recent users as the platform shows them; a figure like 1万+ is a lower bound; null where none is shown. (view=standard and up)"""
+    is_game: Optional[bool]
+    """Whether it is a mini game. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyComponentClicks(TypedDict, total=False):
+    comment_area: Optional[Literal["normal", "high", "very_high"]]
+    """Click-through band of the comment-area component: normal (under 2%), high (2-10%) or very_high (over 10%); null when the note has none. (view=standard and up)"""
+    content: Optional[Literal["normal", "high", "very_high"]]
+    """Click-through band of the in-text component: normal (under 2%), high (2-10%) or very_high (over 10%); null when the note has none. (view=standard and up)"""
+    note_bottom: Optional[Literal["normal", "high", "very_high"]]
+    """Click-through band of the component at the end of the note: normal (under 2%), high (2-10%) or very_high (over 10%); null when the note has none. (view=standard and up)"""
+
+
+class PgyCostPoint(TypedDict, total=False):
+    date: str
+    """The day: a calendar day in China time (UTC+8), written as 00:00 UTC of that date."""
+    cpm: Optional[float]
+    """Cost of a thousand impressions, in yuan; null where there is none."""
+    cpe: Optional[float]
+    """Cost of one interaction, in yuan; null where there is none."""
+    cpv: Optional[float]
+    """Cost of one read, in yuan, as the trend chart works it out; null where there is none."""
+    shop_visit_cost: Optional[float]
+    """Cost per shop visitor a note brings, in yuan; null where there is none."""
+    median_impressions: Optional[int]
+    """Median impressions of a note."""
+    median_reads: Optional[int]
+    """Median reads of a note."""
+    median_engagements: Optional[int]
+    """Median interactions of a note."""
+    median_shop_visits: Optional[int]
+    """Median shop visitors a note brings; a note that brought none counts as 0."""
+
+
+class PgyCreatorCostHistory(TypedDict, total=False):
+    creator_id: str
+    """PGY creator ID."""
+    days: int
+    """How many of the most recent days the figures cover."""
+    currency: Optional[str]
+    """Currency of the costs (ISO 4217)."""
+    date: Optional[str]
+    """The last day the figures run to: a calendar day in China time (UTC+8), written as 00:00 UTC of that date."""
+    cpm: Optional[float]
+    """Cost of a thousand impressions, in yuan; null where there is none."""
+    cpe: Optional[float]
+    """Cost of one interaction, in yuan; null where there is none."""
+    cpv: Optional[float]
+    """Cost of one read, in yuan, as the trend chart works it out; null where there is none."""
+    shop_visit_cost: Optional[float]
+    """Cost per shop visitor a note brings, in yuan; null where there is none."""
+    median_impressions: Optional[int]
+    """Median impressions of a note."""
+    median_reads: Optional[int]
+    """Median reads of a note."""
+    median_engagements: Optional[int]
+    """Median interactions of a note."""
+    median_shop_visits: Optional[int]
+    """Median shop visitors a note brings; a note that brought none counts as 0."""
+    points: List[PgyCostPoint]
+    """The figures day by day, oldest first."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyCreatorCosts(TypedDict, total=False):
+    creator_id: str
+    """PGY creator ID."""
+    date: Optional[str]
+    """The day the figures are of: a calendar day in China time (UTC+8), written as 00:00 UTC of that date."""
+    currency: Optional[str]
+    """Currency of the costs (ISO 4217)."""
+    image_cpm: Optional[float]
+    """Estimated CPM (cost of a thousand impressions) of a image note, in yuan; null where PGY has no estimate."""
+    image_cpm_percentile: Optional[float]
+    """Share of comparable creators whose image note CPM (cost of a thousand impressions) is higher, 0 to 1. (view=standard and up)"""
+    video_cpm: Optional[float]
+    """Estimated CPM (cost of a thousand impressions) of a video note, in yuan; null where PGY has no estimate."""
+    video_cpm_percentile: Optional[float]
+    """Share of comparable creators whose video note CPM (cost of a thousand impressions) is higher, 0 to 1. (view=standard and up)"""
+    image_cpe: Optional[float]
+    """Estimated cost per interaction of a image note, in yuan; null where PGY has no estimate."""
+    image_cpe_percentile: Optional[float]
+    """Share of comparable creators whose image note cost per interaction is higher, 0 to 1. (view=standard and up)"""
+    video_cpe: Optional[float]
+    """Estimated cost per interaction of a video note, in yuan; null where PGY has no estimate."""
+    video_cpe_percentile: Optional[float]
+    """Share of comparable creators whose video note cost per interaction is higher, 0 to 1. (view=standard and up)"""
+    image_read_cost: Optional[float]
+    """Estimated cost per read of a image note, in yuan; null where PGY has no estimate."""
+    image_read_cost_percentile: Optional[float]
+    """Share of comparable creators whose image note cost per read is higher, 0 to 1. (view=standard and up)"""
+    video_read_cost: Optional[float]
+    """Estimated cost per read of a video note, in yuan; null where PGY has no estimate."""
+    video_read_cost_percentile: Optional[float]
+    """Share of comparable creators whose video note cost per read is higher, 0 to 1. (view=standard and up)"""
+    image_shop_visit_cost: Optional[float]
+    """Estimated cost per shop visitor of a image note, in yuan; null where PGY has no estimate."""
+    image_shop_visit_cost_percentile: Optional[float]
+    """Share of comparable creators whose image note cost per shop visitor is higher, 0 to 1. (view=standard and up)"""
+    video_shop_visit_cost: Optional[float]
+    """Estimated cost per shop visitor of a video note, in yuan; null where PGY has no estimate."""
+    video_shop_visit_cost_percentile: Optional[float]
+    """Share of comparable creators whose video note cost per shop visitor is higher, 0 to 1. (view=standard and up)"""
+    median_impressions: Optional[int]
+    """Median impressions of a note."""
+    median_impressions_percentile: Optional[float]
+    """Share of comparable creators this one beats on median impressions, 0 to 1. (view=standard and up)"""
+    median_reads: Optional[int]
+    """Median reads of a note."""
+    median_reads_percentile: Optional[float]
+    """Share of comparable creators this one beats on median reads, 0 to 1. (view=standard and up)"""
+    median_engagements: Optional[int]
+    """Median interactions of a note."""
+    median_engagements_percentile: Optional[float]
+    """Share of comparable creators this one beats on median interactions, 0 to 1. (view=standard and up)"""
+    median_shop_visits: Optional[int]
+    """Median shop visitors a note brings."""
+    median_shop_visits_percentile: Optional[float]
+    """Share of comparable creators this one beats on median shop visitors, 0 to 1. (view=standard and up)"""
+    follower_growth: Optional[float]
+    """Follower growth over the last 30 days: 0.037 is 3.7% more; negative when followers were lost. (view=standard and up)"""
+    follower_growth_percentile: Optional[float]
+    """Share of comparable creators this one beats on follower growth, 0 to 1. (view=standard and up)"""
+    invite_reply_rate: Optional[float]
+    """Share of collaboration invitations answered within 48 hours, 0 to 1. (view=standard and up)"""
+    easy_to_reach: Optional[bool]
+    """Whether PGY marks the creator as easy to reach (好联系). (view=standard and up)"""
+    active_days_7d: Optional[int]
+    """Days active in the last 7. (view=standard and up)"""
+    is_active: Optional[bool]
+    """Whether PGY marks the creator as active (活跃). (view=standard and up)"""
+    notes_30d: Optional[int]
+    """Notes published in the last 30 days, everyday and sponsored alike. (view=standard and up)"""
+    highlight: Optional[str]
+    """The strength PGY credits the creator with, in its words; null when none. (view=standard and up)"""
+    highlight_reason: Optional[str]
+    """PGY's reason for that strength, in its words. (view=standard and up)"""
+    content_mix: Optional[List[CategoryShare]]
+    """Share of the creator's notes per content category, largest first. (view=standard and up)"""
+    industries: Optional[List[str]]
+    """Industries the creator has worked with, in the platform's words. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyCreatorFollowers(TypedDict, total=False):
+    creator_id: str
+    """PGY creator ID."""
+    followers: Optional[int]
+    """Followers."""
+    gained: Optional[int]
+    """Net followers gained over the last 30 days; negative when followers were lost."""
+    growth: Optional[float]
+    """Follower growth over the last 30 days: 0.008 is 0.8% more."""
+    growth_percentile: Optional[float]
+    """Share of comparable creators this one beats on follower growth, 0 to 1. (view=standard and up)"""
+    active_followers: Optional[int]
+    """Active followers: active on Xiaohongshu in the last 28 days."""
+    active_share: Optional[float]
+    """Active followers as a share of all followers, 0 to 1."""
+    active_percentile: Optional[float]
+    """Share of comparable creators this one beats on share of active followers, 0 to 1. (view=standard and up)"""
+    engaged_followers: Optional[int]
+    """Engaged followers: interacted with the creator's notes in the last 30 days."""
+    engaged_share: Optional[float]
+    """Engaged followers as a share of all followers, 0 to 1."""
+    engaged_percentile: Optional[float]
+    """Share of comparable creators this one beats on share of engaged followers, 0 to 1. (view=standard and up)"""
+    reading_followers: Optional[int]
+    """Reading followers: read the creator's notes in the last 30 days."""
+    reading_share: Optional[float]
+    """Reading followers as a share of all followers, 0 to 1."""
+    reading_percentile: Optional[float]
+    """Share of comparable creators this one beats on share of reading followers, 0 to 1. (view=standard and up)"""
+    buying_followers: Optional[int]
+    """Buying followers: bought something on Xiaohongshu in the last 30 days."""
+    buying_share: Optional[float]
+    """Buying followers as a share of all followers, 0 to 1."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyCreatorMetrics(TypedDict, total=False):
+    creator_id: str
+    """PGY creator ID."""
+    notes: Optional[int]
+    """Notes in the period."""
+    median_impressions: Optional[int]
+    """Median impressions of a note."""
+    median_reads: Optional[int]
+    """Median reads of a note."""
+    median_engagements: Optional[int]
+    """Median interactions of a note."""
+    median_likes: Optional[int]
+    """Median likes of a note. (view=standard and up)"""
+    median_favorites: Optional[int]
+    """Median saves of a note. (view=standard and up)"""
+    median_comments: Optional[int]
+    """Median comments of a note. (view=standard and up)"""
+    median_shares: Optional[int]
+    """Median shares of a note. (view=standard and up)"""
+    engagement_rate: Optional[float]
+    """Interactions per read, 0 to 1."""
+    video_completion_rate: Optional[float]
+    """Completion rate of video notes, 0 to 1. (view=standard and up)"""
+    image_3s_read_rate: Optional[float]
+    """Share of image-note reads that lasted 3 seconds, 0 to 1. (view=standard and up)"""
+    hundred_like_share: Optional[float]
+    """Share of notes with 100 likes or more, 0 to 1. (view=standard and up)"""
+    thousand_like_share: Optional[float]
+    """Share of notes with 1,000 likes or more, 0 to 1. (view=standard and up)"""
+    impressions_percentile: Optional[float]
+    """Share of comparable creators this one beats on median impressions, 0 to 1. (view=standard and up)"""
+    reads_percentile: Optional[float]
+    """Share of comparable creators this one beats on median reads, 0 to 1. (view=standard and up)"""
+    engagements_percentile: Optional[float]
+    """Share of comparable creators this one beats on median interactions, 0 to 1. (view=standard and up)"""
+    video_notes: Optional[int]
+    """Video notes in the period (included in notes). (view=standard and up)"""
+    video_completion_percentile: Optional[float]
+    """Share of comparable creators this one beats on video completion rate, 0 to 1. (view=standard and up)"""
+    median_follows: Optional[int]
+    """Median new followers a note brought. (view=standard and up)"""
+    traffic_sources: Optional[PgyTrafficSources]
+    """Where the notes got their impressions and reads; each set adds up to 1. (view=standard and up)"""
+    long_term: Optional[PgyLongTerm]
+    """Long-term performance of notes from about half a year back: recent and long-term reads, standing and sources. (view=full and up)"""
+    note_list: Optional[List[PgyNoteFigures]]
+    """The period's notes one by one, oldest first, 15 at most; null when there is none. (view=full and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyCreatorPost(TypedDict, total=False):
+    id: str
+    """Note ID."""
+    title: Optional[str]
+    """The note's title."""
+    type: Optional[Literal["image", "video"]]
+    """Image note or video note."""
+    published_at: Optional[str]
+    """Publication day, as 00:00 China time (the platform gives the day only)."""
+    cover_url: Optional[str]
+    """Cover image. (view=standard and up)"""
+    is_sponsored: Optional[bool]
+    """Whether it was made for a brand (see brand)."""
+    brand: Optional[str]
+    """The brand it was made for, in the platform's words; null when not sponsored."""
+    is_promoted: Optional[bool]
+    """Whether paid promotion sent traffic to it (含推广流量); not the same as sponsored."""
+    metrics: PgyPostMetrics
+    """The note's figures."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyLongTerm(TypedDict, total=False):
+    published_from: Optional[str]
+    """First publication day of the notes counted: a calendar day in China time (UTC+8), written as 00:00 UTC of that date. (view=full and up)"""
+    published_to: Optional[str]
+    """Last publication day of the notes counted, written the same way. (view=full and up)"""
+    notes: Optional[int]
+    """Notes published in that span; when 0 the figures below are null. (view=full and up)"""
+    recent_reads: Optional[int]
+    """Reads of a typical note soon after publication, the platform's representative figure. (view=full and up)"""
+    recent_reads_percentile: Optional[float]
+    """Share of comparable creators this one beats on recent reads, 0 to 1. (view=full and up)"""
+    long_term_reads: Optional[int]
+    """Reads of a typical note in the long term, after the recent part. (view=full and up)"""
+    long_term_reads_percentile: Optional[float]
+    """Share of comparable creators this one beats on long-term reads, 0 to 1. (view=full and up)"""
+    recent_sources: Optional[PgyReadSources]
+    """Where the recent reads came from. (view=full and up)"""
+    long_term_sources: Optional[PgyReadSources]
+    """Where the long-term reads came from. (view=full and up)"""
+
+
+class PgyNote(TypedDict, total=False):
+    id: str
+    """Note ID."""
+    url: Optional[str]
+    """Link to the note, with the access token that makes it open."""
+    type: Optional[Literal["image", "video"]]
+    """Image note or video note."""
+    title: Optional[str]
+    """The note's title."""
+    text: Optional[str]
+    """The note's text. (view=standard and up)"""
+    published_at: Optional[str]
+    """When it was published."""
+    images: Optional[List[str]]
+    """Picture links in order. (view=standard and up)"""
+    creator_id: Optional[str]
+    """The creator's PGY ID."""
+    creator_name: Optional[str]
+    """The creator's name."""
+    brand: Optional[str]
+    """The sponsoring brand, in the platform's words; null when it is not a reported sponsored note."""
+    brand_id: Optional[str]
+    """That brand's Xiaohongshu account ID; null when none. (view=standard and up)"""
+    metrics: PgyNoteMetrics
+    """The note's figures on PGY."""
+    component_clicks: Optional[PgyComponentClicks]
+    """Click-through bands of the components the brand added; null when there are none. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class PgyNoteFigures(TypedDict, total=False):
+    id: str
+    """Note ID. (view=full and up)"""
+    title: Optional[str]
+    """The note's title. (view=full and up)"""
+    type: Optional[Literal["image", "video"]]
+    """Image note or video note. (view=full and up)"""
+    published_at: Optional[str]
+    """Publication day, as 00:00 China time (the platform gives the day only). (view=full and up)"""
+    cover_url: Optional[str]
+    """Cover image. (view=full and up)"""
+    impressions: Optional[int]
+    """Impressions. (view=full and up)"""
+    reads: Optional[int]
+    """Reads. (view=full and up)"""
+    engagements: Optional[int]
+    """Interactions. (view=full and up)"""
+    likes: Optional[int]
+    """Likes. (view=full and up)"""
+    favorites: Optional[int]
+    """Saves. (view=full and up)"""
+    impressions_vs_median: Optional[float]
+    """The note's impressions against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below. (view=full and up)"""
+    reads_vs_median: Optional[float]
+    """The note's reads against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below. (view=full and up)"""
+    engagements_vs_median: Optional[float]
+    """The note's interactions against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below. (view=full and up)"""
+    likes_vs_median: Optional[float]
+    """The note's likes against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below. (view=full and up)"""
+    favorites_vs_median: Optional[float]
+    """The note's saves against the creator's median for the period: 0.5 is 50% above, -0.3 is 30% below. (view=full and up)"""
+
+
+class PgyNoteMetrics(TypedDict, total=False):
+    impressions: Optional[int]
+    """Impressions."""
+    views: Optional[int]
+    """Reads."""
+    likes: Optional[int]
+    """Likes."""
+    favorites: Optional[int]
+    """Saves."""
+    comments: Optional[int]
+    """Comments."""
+    shares: Optional[int]
+    """Shares."""
+    follows: Optional[int]
+    """New followers the note brought."""
+
+
+class PgyPostMetrics(TypedDict, total=False):
+    views: Optional[int]
+    """Reads."""
+    likes: Optional[int]
+    """Likes."""
+    favorites: Optional[int]
+    """Saves."""
+    shop_visits: Optional[int]
+    """Shop visitors the note brought (cross-domain sponsored notes only; 0 for others). (view=standard and up)"""
+
+
+class PgyReadSources(TypedDict, total=False):
+    homefeed: Optional[float]
+    """Share of the reads that came from the explore feed, 0 to 1. (view=full and up)"""
+    search: Optional[float]
+    """Share of the reads that came from search, 0 to 1. (view=full and up)"""
+    profile: Optional[float]
+    """Share of the reads that came from the creator's profile page, 0 to 1. (view=full and up)"""
+    follow: Optional[float]
+    """Share of the reads that came from the following feed, 0 to 1. (view=full and up)"""
+    other: Optional[float]
+    """Share of the reads that came from anywhere else, 0 to 1. (view=full and up)"""
+
+
+class PgySourceShares(TypedDict, total=False):
+    homefeed: Optional[float]
+    """Share of the traffic that came from the explore feed, 0 to 1. (view=standard and up)"""
+    search: Optional[float]
+    """Share of the traffic that came from search, 0 to 1. (view=standard and up)"""
+    follow: Optional[float]
+    """Share of the traffic that came from the following feed, 0 to 1. (view=standard and up)"""
+    detail: Optional[float]
+    """Share of the traffic that came from note detail pages, 0 to 1. (view=standard and up)"""
+    nearby: Optional[float]
+    """Share of the traffic that came from the nearby feed, 0 to 1. (view=standard and up)"""
+    other: Optional[float]
+    """Share of the traffic that came from anywhere else, 0 to 1. (view=standard and up)"""
+
+
+class PgyTrafficSources(TypedDict, total=False):
+    impressions: Optional[PgySourceShares]
+    """Where the impressions came from. (view=standard and up)"""
+    reads: Optional[PgySourceShares]
+    """Where the reads came from. (view=standard and up)"""
+
+
+class Post(TypedDict, total=False):
+    id: str
+    """Post ID on the platform."""
+    url: str
+    """Link to the post."""
+    type: Literal["video", "image", "text", "article"]
+    """What kind of post it is."""
+    title: Optional[str]
+    """Title, where the platform has one (videos, notes, articles)."""
+    text: str
+    """Caption, body or description as plain text; articles come as Markdown."""
+    lang: Optional[str]
+    """Language code, as reported or detected. (view=standard and up)"""
+    published_at: Optional[str]
+    """When it was published, ISO 8601 in UTC; null only where the source gives no time (wechat_mp.articles.metrics, wechat_channels.videos.metrics, youtube.channels.videos.list with type=short), then listed in meta.unavailable."""
+    author: AccountRef
+    """Who posted it."""
+    metrics: Metrics
+    """Counts at fetch time; a count the platform hides is null."""
+    images: Optional[List[str]]
+    """Image URLs for image posts and notes. (view=standard and up)"""
+    hashtags: Optional[List[str]]
+    """Hashtags or topics, without the # sign. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class Product(TypedDict, total=False):
+    id: str
+    """Product ID in the shop."""
+    url: str
+    """Product page."""
+    title: str
+    """Product title."""
+    price: Optional[float]
+    """Current price (the lowest variant), in the currency given."""
+    original_price: Optional[float]
+    """List price before discount, where shown. (view=standard and up)"""
+    currency: Optional[str]
+    """ISO 4217 currency code."""
+    sold: Optional[int]
+    """Units sold, as the shop shows it."""
+    rating: Optional[float]
+    """Average stars, 0 to 5."""
+    reviews: Optional[int]
+    """Number of reviews."""
+    images: Optional[List[str]]
+    """Product image URLs. (view=standard and up)"""
+    shop: ShopRef
+    """Who sells it."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class Rate(TypedDict, total=False):
+    type: Literal["integrated_video", "custom_video", "image_note", "video_note", "other"]
+    """Kind of sponsored work, normalised across platforms."""
+    name: str
+    """The platform's own name for it."""
+    price: Optional[float]
+    """Listed price, in the currency given; null when not published."""
+    currency: str
+    """ISO 4217 currency code."""
+    available: Optional[bool]
+    """Whether the creator takes this kind of order now."""
+    settlement: Optional[str]
+    """How it is settled, in the platform’s words."""
+
+
+class Review(TypedDict, total=False):
+    id: str
+    """Review ID."""
+    product_id: str
+    """ID of the product reviewed."""
+    rating: Optional[float]
+    """Stars, 1 to 5."""
+    text: str
+    """Review text; empty when the buyer left only stars."""
+    published_at: Optional[str]
+    """When it was posted, ISO 8601 in UTC (a day for platforms that show only the date)."""
+    author_name: Optional[str]
+    """Reviewer name as the shop shows it, often masked."""
+    variant: Optional[str]
+    """The variant bought. (view=standard and up)"""
+    images: Optional[List[str]]
+    """Photos attached to the review. (view=standard and up)"""
+    likes: Optional[int]
+    """Likes on the review. (view=standard and up)"""
+    verified_purchase: Optional[bool]
+    """Whether the shop marks it as a verified purchase. (view=standard and up)"""
+
+
+class SalesCategory(TypedDict, total=False):
+    name: str
+    """The category of goods, in the platform's words."""
+    share: Optional[float]
+    """The category's share, 0 to 1."""
+    sales_range: Optional[str]
+    """Band of the category's sales, in the platform's words."""
+
+
+class Segment(TypedDict, total=False):
+    start: float
+    """Start, in seconds from the beginning. (view=standard and up)"""
+    end: float
+    """End, in seconds from the beginning. (view=standard and up)"""
+    text: str
+    """What is said in this segment. (view=standard and up)"""
+
+
+class ShopRef(TypedDict, total=False):
+    id: Optional[str]
+    """Shop or seller ID."""
+    name: Optional[str]
+    """Shop name."""
+    url: Optional[str]
+    """Shop page. (view=standard and up)"""
+
+
+class Topic(TypedDict, total=False):
+    id: str
+    """ID; pass it as is to the endpoints that take one."""
+    name: str
+    """Name of the topic."""
+    url: Optional[str]
+    """Link to the topic page."""
+    description: Optional[str]
+    """What the topic page says it is about; null when it says nothing."""
+    metrics: TopicMetrics
+    """Counts at fetch time."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class TopicMetrics(TypedDict, total=False):
+    views: Optional[int]
+    """Views of the topic page."""
+    posts: Optional[int]
+    """Posts under the topic."""
+
+
+class Transcript(TypedDict, total=False):
+    video_id: str
+    """ID of the video."""
+    lang: str
+    """Language of this transcript."""
+    segments: List[Segment]
+    """Timed segments in order. (view=standard and up)"""
+    text: str
+    """All segments joined as plain text."""
+
+
+class Trend(TypedDict, total=False):
+    rank: int
+    """Position on the board, 1 is the top."""
+    name: str
+    """The topic or search term."""
+    heat: Optional[float]
+    """The heat score the platform shows; scales differ by platform."""
+    url: Optional[str]
+    """Link to the topic page, if there is one."""
+
+
+class XingtuCampaign(TypedDict, total=False):
+    id: str
+    """Campaign ID."""
+    name: str
+    """Name of the campaign."""
+    description: Optional[str]
+    """What the campaign is."""
+    category: Optional[Literal["platform_event", "ecommerce", "seasonal", "creative", "industry"]]
+    """Kind of campaign: platform event, e-commerce moment, seasonal moment, creative marketing or industry campaign."""
+    stage: Optional[Literal["preparing", "open", "live", "ended"]]
+    """Where it stands: being prepared, open for sign-up, live or ended."""
+    signup_starts_at: Optional[str]
+    """When sign-up opens."""
+    signup_ends_at: Optional[str]
+    """When sign-up closes."""
+    starts_at: Optional[str]
+    """When the campaign starts."""
+    ends_at: Optional[str]
+    """When the campaign ends."""
+    image_url: Optional[str]
+    """The campaign's main image. (view=standard and up)"""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuCreatorContentMix(TypedDict, total=False):
+    creator_id: str
+    """Xingtu creator ID."""
+    categories: List[ContentShare]
+    """One entry per content category."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuCreatorConversion(TypedDict, total=False):
+    creator_id: str
+    """Xingtu creator ID."""
+    videos: Optional[int]
+    """Videos counted: those that carry products."""
+    median_views: Optional[int]
+    """Median views of those videos."""
+    products: Optional[int]
+    """Products recommended."""
+    currency: Optional[str]
+    """Currency of the money bands (ISO 4217)."""
+    sales_range: Optional[str]
+    """Band of the average sales of a video, in the platform's words."""
+    gpm_range: Optional[str]
+    """Band of sales per thousand views (GPM), in the platform's words."""
+    product_price_range: Optional[str]
+    """Band of the prices of the products recommended, in the platform's words."""
+    click_cost_range: Optional[str]
+    """Band of the cost per click (CPC), in the platform's words."""
+    clicks_range: Optional[str]
+    """Band of clicks on a video's product link, in the platform's words."""
+    click_rate_range: Optional[str]
+    """Band of the click rate of a video's product link, in the platform's words."""
+    categories: Optional[List[SalesCategory]]
+    """One entry per category of goods sold."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuCreatorKeywords(TypedDict, total=False):
+    creator_id: str
+    """Xingtu creator ID."""
+    keywords: List[CreatorKeyword]
+    """One entry per keyword."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuCreatorMetrics(TypedDict, total=False):
+    creator_id: str
+    """Xingtu creator ID."""
+    videos: Optional[int]
+    """Videos in the period."""
+    median_views: Optional[int]
+    """Median views of a video."""
+    average_likes: Optional[int]
+    """Average likes of a video."""
+    average_comments: Optional[int]
+    """Average comments of a video."""
+    average_shares: Optional[int]
+    """Average shares of a video."""
+    engagement_rate: Optional[float]
+    """Interactions per view, 0 to 1."""
+    engagement_rate_percentile: Optional[float]
+    """Share of comparable creators this one beats on engagement rate, 0 to 1. (view=standard and up)"""
+    completion_rate: Optional[float]
+    """Share of views watched to the end, 0 to 1."""
+    completion_rate_percentile: Optional[float]
+    """Share of comparable creators this one beats on completion rate, 0 to 1. (view=standard and up)"""
+    currency: Optional[str]
+    """Currency of the costs below (ISO 4217)."""
+    cpm_integrated: Optional[float]
+    """Expected cost per thousand views of an integrated video (植入视频)."""
+    cpm_custom: Optional[float]
+    """Expected cost per thousand views of a custom video (定制视频)."""
+    cpe_integrated: Optional[float]
+    """Expected cost per interaction of an integrated video."""
+    cpe_custom: Optional[float]
+    """Expected cost per interaction of a custom video."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuCreatorPost(TypedDict, total=False):
+    id: str
+    """Video ID, the one the Douyin video endpoints take."""
+    url: Optional[str]
+    """Link to the video."""
+    title: Optional[str]
+    """The video's caption."""
+    published_at: Optional[str]
+    """When it was published."""
+    duration: Optional[float]
+    """Length in seconds. (view=standard and up)"""
+    metrics: XingtuPostMetrics
+    """The video's figures."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuCreatorScores(TypedDict, total=False):
+    creator_id: str
+    """Xingtu creator ID."""
+    overall: Optional[CreatorScore]
+    """The overall Xingtu score."""
+    reach: Optional[CreatorScore]
+    """Reach score."""
+    seeding: Optional[CreatorScore]
+    """Seeding score: how well the creator's videos raise interest in products."""
+    conversion: Optional[CreatorScore]
+    """Conversion score."""
+    cooperation: Optional[CreatorScore]
+    """Cooperation score."""
+    value_for_money: Optional[CreatorScore]
+    """Value-for-money score."""
+    ext: Dict[str, Any]
+    """Platform-specific extras. Only returned with view=full. (view=full and up)"""
+
+
+class XingtuPostMetrics(TypedDict, total=False):
+    views: Optional[int]
+    """Views."""
+    likes: Optional[int]
+    """Likes."""
+    comments: Optional[int]
+    """Comments."""
+    completion_rate: Optional[float]
+    """Share of views watched to the end, 0 to 1."""
+    engagement_rate: Optional[float]
+    """Interactions per view, 0 to 1."""
+