API reference / Connected sessions / Studio analytics overview

Studio analytics overview

Creator Studio post views, profile views, net followers and top posts.

GETapi.tikultra.com/v1/account/studio/overview20 credits

Upstream: /tiktok/v1/analytics/search_studio_card//tiktok/v1/creator/overview/
Access: Growth and up
Runs on: FullPool
Billing: Failed calls are free

Authorization & parameters

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Query parameters

account_idstringrequired

A connected account, from /dash/sessions or POST /v1/account/import. For example acc_7Hq2.

window_daysinteger

Analytics window in days (7, 28, or 60). For example 7.

Client and egress

Executes on the dedicated FullPool mobile context and city-level egress bound to account_id. See Connected sessions.

Response

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Response fields

Key top-level and nested fields decoded from the mobile upstream payload:

status_codeinteger

Upstream TikTok mobile status code (0 indicates success).

account_idstring

Connected session identifier bound to a dedicated FullPool mobile context.

window_daysinteger

Decoded window days value.

metricsobject

Structured metrics metadata.

metrics.post_viewsinteger

Decoded post views value.

metrics.profile_viewsinteger

Decoded profile views value.

metrics.likesinteger

Decoded likes value.

metrics.commentsinteger

Page of top-level or reply comment objects.

metrics.sharesinteger

Decoded shares value.

metrics.net_followersinteger

Decoded net followers value.

top_postsobject[]

List of top posts objects.

top_posts[].aweme_idstring

64-bit TikTok Snowflake post ID (top 32 bits encode UTC creation timestamp).

top_posts[].descstring

Post caption text including inline #hashtags and @mentions.

top_posts[].play_countinteger

Total play count.

top_posts[].avg_watch_secnumber

Unix timestamp (seconds) for avg watch.

top_posts[].completion_rate_pctnumber

Decoded completion rate pct value.

log_pbobject

Upstream request trace envelope from the mobile gateway.

log_pb.impr_idstring

Upstream TikTok impression / trace identifier.

Errors

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.

Accounts you own only. Connected sessions are for accounts you own or are authorized to operate. Available on Growth and Scale.

import os from tikultra import TikUltra with TikUltra(api_key=os.environ["TIKULTRA_KEY"]) as client: res = client.request("GET", "/v1/account/studio/overview", params={ "account_id": "acc_7Hq2", }) print(res.credits_cost, res.data)

{ "status_code": 0, "account_id": "acc_7Hq2", "window_days": 7, "metrics": { "post_views": 492810, "profile_views": 18420, "likes": 38910, "comments": 1940, "shares": 4120, "net_followers": 2840 }, "top_posts": [ { "aweme_id": "7705852133855161377", "desc": "Launch film, 1080p60 master #keyboards #desksetup", "play_count": 1482906, "avg_watch_sec": 24.6, "completion_rate_pct": 41.8 } ], "log_pb": { "impr_id": "202611120200419F8E7D6C5B4A3210" } }