API reference
Public API
128 operations at https://creator.growthdept.ai/api/public/v1, generated from our OpenAPI document. Authenticate with a bearer API key; see authentication.
Campaigns and creators (5)
- GET
/campaign_affiliatesThe organization's enrolled creators - PATCH
/campaign_affiliates/{id}Set a creator's default code (tag) to an exact string, unique in the organization - PATCH
/campaign_affiliates/bulkSet default codes for up to 300 creators; valid rows update when others fail - GET
/organizations/brandsThe organization's brands: the key's brand and its child brands - GET
/organizations/campaignsCampaigns of the organization and its child brands
Sales and tracking (4)
- GET
/affiliate_salesAffiliate sales (conversions) - POST
/affiliate_salesRecord a conversion for a campaign creator (website by default, or ios / android); idempotent on order_id and platform - PATCH
/affiliate_sales/{id}Update a sale created through the API - POST
/tracking_eventsCreate a tracking event for a campaign creator
Campaign applications (6)
- GET
/campaign_applicationsCreator applications to the organization's and its child brands' campaigns, newest first - POST
/campaign_applicationsSubmit an applicant from the brand's own form into a campaign (idempotent per email and campaign) - POST
/campaign_applications/{id}/approveAccept a pending application (an already accepted one answers changed: false) - POST
/campaign_applications/{id}/denyReject a pending application (an already rejected one answers changed: false) - POST
/campaign_applications/bulk_approveAccept up to 50 pending applications, each on its own - POST
/campaign_applications/bulk_denyReject up to 50 pending applications, each on its own
Sample requests (5)
- GET
/sample_requestsFree sample requests the brand fulfils itself, newest first, across child brands - GET
/sample_requests/{id}One sample request - PATCH
/sample_requests/{id}Report progress: approve or reject, mark shipped or delivered, save the order id, order number and tracking link - POST
/sample_requests/{id}/approveApprove a pending sample request (accepts the application it was picked in) - POST
/sample_requests/{id}/rejectReject a pending sample request (rejects the application it was picked in)
Content analytics (21)
- GET
/content/brand_progressEach child brand's views, engagements, posts, creators and campaigns - GET
/content/breakout_postsPosts gaining far faster than their own normal pace right now - GET
/content/creator_activityCreators who posted, new, retained, returning and churned per week or month, with monthly cohorts - GET
/content/data_healthHow many posts had a fresh reading each day, to tell a real dip from missing data - GET
/content/day_breakdownOne day's total against its normal level, the top posts and everyone else - GET
/content/filtersThe campaigns and platforms the content endpoints can filter by - GET
/content/new_creatorsCreators whose first enrollment was in the range, per day, with the previous range - GET
/content/per_post_seriesPer day, how many posts gained views and the views each gained on average, with the range before - GET
/content/post_seriesOne post's daily gains over the range, zeros filled - GET
/content/posting_countsDistinct posts, and creators who posted, with a post date in the range - GET
/content/posts_dailyPosts counted on their first tracked day, per day and platform, with the previous range - GET
/content/seriesViews and engagement gained per day, zeros filled - GET
/content/series_byThe daily series split into the top groups (creator, post, platform or campaign) and everyone else - GET
/content/spikesDays that gained well above the trailing median, each with the post that drove it most - GET
/content/summaryViews and engagement gained in a range against the range before, with active posts, creators and accounts - GET
/content/top_accountsCreator social accounts ranked by their posts' gains, or by posts - GET
/content/top_campaignsCampaigns, ambassador programs and contracts ranked by their posts' gains - GET
/content/top_creatorsCreators ranked by their posts' gains in the range, or by posts - GET
/content/top_platformsEach platform's posts, gains and share of views - GET
/content/top_postsPosts ranked by what they gained in the range - GET
/postsCreators who posted and creators who missed posting between two dates
Stores and Shopify (4)
- GET
/shopify/statsAmbassador revenue, commission, orders, page views, link clicks, creators added and sign-ins, with a daily series and top creators and products - GET
/shopify/store_creatorsOne row per creator enrollment on the Shopify or custom website store, with commission paid, unpaid and pending - GET
/shopify/store_creators/summaryCommission pending, unpaid and paid for the store creators filter - GET
/stores/overviewSales, commission and orders per store and blended, against the previous range
Payouts (3)
Meta ads (11)
- GET
/meta_adsMeta ads with their publish state, newest first; ids= polls the ads a bulk call created - GET
/meta_ads/{id}One Meta ad and its publish state - POST
/meta_ads/{id}/launchTurn a published ad on (an ad still publishing turns on when it publishes) - POST
/meta_ads/{id}/pausePause an ad on Meta (one not on Meta yet stays paused when it publishes) - POST
/meta_ads/bulkCreate up to 50 ads from creator content in existing ad sets; each row is checked and created on its own - GET
/meta_ads/creativesThe Meta ads table grouped by ad, ad set or product, with totals, quick view counts and histograms - GET
/meta_ads/creatorsThe Meta ads table grouped by creator with each creator's ads, totals, quick view counts and histograms - GET
/meta_ads/optionsAd accounts, identities, campaigns and ad sets, saved defaults and creators' Meta links for building ads - GET
/meta_ads/overviewEvery Meta ads metric for the range with the previous range, the change and a daily sparkline - GET
/meta_ads/sourcesCreator posts, TikTok Shop videos or approved submissions that can become a Meta ad - GET
/meta_ads/timeseriesOne metric per day, optionally against the previous range, split by top creators, or as running totals
Mobile apps (4)
- GET
/apps/android/analyticsThe Google Play app's creator funnel: clicks, store impressions and downloads, installs, retention and revenue - GET
/apps/android/creator_funnelOne row per creator with an install link for the Google Play app: code, link, clicks, store numbers, installs and revenue - GET
/apps/ios/analyticsThe App Store app's creator funnel: clicks, store impressions and downloads, installs, retention and revenue - GET
/apps/ios/creator_funnelOne row per creator with an install link for the App Store app: code, link, clicks, store numbers, installs and revenue
TikTok Shop (42)
- GET
/tik_tok_shop/affiliate/creator_activityActive, new, returning, retained and churned affiliate creators per week or month - GET
/tik_tok_shop/affiliate/creatorsThe shop's affiliate creators ranked by GMV over a date window - GET
/tik_tok_shop/affiliate/order_linesAffiliate order lines, one per order and SKU, newest first - GET
/tik_tok_shop/affiliate/summaryThe shop's affiliate totals over a date window - GET
/tik_tok_shop/analytics/channel_mixThe shop's GMV by sales channel: seller and affiliate video, LIVE and product card - GET
/tik_tok_shop/analytics/products/{productId}/performanceOne product's GMV, orders and items sold over time, by channel, with returns and ratings - GET
/tik_tok_shop/analytics/sku_performanceThe shop's SKUs with GMV, SKU orders and units sold for a window - GET
/tik_tok_shop/analytics/skus/{skuId}/performanceOne SKU's GMV, items sold and orders over time, by channel - GET
/tik_tok_shop/connection_healthWhether the shop is connected and its data is syncing, with the reasons when not - GET
/tik_tok_shop/conversations/group_countsHow many conversations sit in each of the shop's TikTok inbox groups - GET
/tik_tok_shop/creatorsOne row per creator with GMV, orders, commission and refunds for the range, by GMV - GET
/tik_tok_shop/creators/{openId}/marketplaceOne creator's Creator Marketplace profile for the last 30 days - POST
/tik_tok_shop/creators/discoverSearch TikTok's Creator Marketplace by filters, one page of creators - GET
/tik_tok_shop/creators/discover/filtersThe filters and sort orders Discover creators takes - POST
/tik_tok_shop/creators/lookupLook up to 200 creators by openId, oecId or username - GET
/tik_tok_shop/creators/profileOne creator as this shop sees them: ids, sales here, content, samples and showcase - GET
/tik_tok_shop/finance/orders/{orderId}/transactionsSettled revenue, fees, shipping and settlement for one order, per SKU - GET
/tik_tok_shop/finance/pnlProfit and loss for a date window from TikTok's settlement statements - GET
/tik_tok_shop/finance/reconciliationAffiliate orders in a window checked against what TikTok settled - GET
/tik_tok_shop/finance/statementsThe shop's daily settlement statements - GET
/tik_tok_shop/finance/statements/{statementId}/transactionsEvery transaction settled in one statement - GET
/tik_tok_shop/finance/unsettledOrders and adjustments TikTok has not settled yet - GET
/tik_tok_shop/finance/withdrawalsMoney moving in and out of the shop's TikTok balance - GET
/tik_tok_shop/livesOne row per LIVE with GMV and engagement for the range, by GMV - GET
/tik_tok_shop/outreach/recordsCreators the shop reached in TikTok's current outreach quota period - GET
/tik_tok_shop/product_creatorsOne row per creator with their GMV broken down by product for the range - GET
/tik_tok_shop/productsOne row per product, summed over tracked creators for the range, by GMV - GET
/tik_tok_shop/products/{productId}/contentsVideos and LIVEs that sold one product in a window, ranked by GMV - GET
/tik_tok_shop/products/catalogThe shop's products with SKUs, prices and inventory - GET
/tik_tok_shop/samples/funnelCounts per stage, conversion rates and time in stage for a cohort of sample requests - POST
/tik_tok_shop/samples/matchCheck pending sample requests against criteria (read only: nothing is approved) - GET
/tik_tok_shop/samples/outcomesWhere up to 100 sample applications ended up - GET
/tik_tok_shop/samples/vettingFacts for vetting up to 50 sample applicants: the application, marketplace facts and history with the shop - GET
/tik_tok_shop/shop_healthTikTok's Shop Performance Score overview - GET
/tik_tok_shop/shop_health/metricsEvery Shop Performance Score metric for the shop - GET
/tik_tok_shop/shop_health/metrics/{metricCode}TikTok's diagnosis of one Shop Performance Score metric - GET
/tik_tok_shop/shop_health/metrics/{metricCode}/problemsThe orders or chats that count against one Shop Performance Score metric - GET
/tik_tok_shop/shop_health/metrics/{metricCode}/top_itemsThe items behind one Shop Performance Score metric - GET
/tik_tok_shop/summary/weeklyOne week against the week before: GMV, orders, units, commission, creators, samples and content, with top movers - GET
/tik_tok_shop/target_collabsThe shop's target collaborations, one page per call - GET
/tik_tok_shop/target_collabs/{collaborationId}/promotion_detailsOne creator's results in one target collaboration, per product - GET
/tik_tok_shop/videosOne row per shoppable video with GMV, orders, views and refunds for the range, by GMV
Stats (older) (23)
- GET
/stats/ambassadorsAmbassadors of the brand's ambassador programs - GET
/stats/content_24h_dataDaily views and engagement against the previous period (deprecated) - GET
/stats/content_platform_compositionPosts by platform over a date range (deprecated) - GET
/stats/creator_payoutsWhat the brand owes or paid each creator, per period (deprecated) - GET
/stats/creators_24hNew and active creators per day against the previous period (deprecated) - GET
/stats/filtersCampaigns and platforms the stats endpoints filter by (deprecated: use /content/filters) (deprecated) - GET
/stats/manual_campaign_progressDeliverables posted against what campaigns require (deprecated) - POST
/stats/mark_credit_payoutMark a credit-only creator payout as paid outside the platform - GET
/stats/payouts_24hPayouts per day against the previous period (deprecated) - GET
/stats/query_ambassador_salesAmbassador sales with order and commission detail - GET
/stats/query_ambassadorsPer-ambassador revenue, commission, orders and clicks for one campaign - POST
/stats/refresh_dataQueue a refresh of creators' social data (deprecated: the content endpoints read live data) (deprecated) - GET
/stats/snapshotsDaily engagement over a date range (deprecated) - GET
/stats/tik_tok_shop_gmv_24hTikTok Shop GMV per day against the previous period (deprecated) - GET
/stats/tik_tok_shop_productsTikTok Shop products by GMV (deprecated) - GET
/stats/top_connected_accounts_by_engagementSocial accounts ranked by engagement gained (deprecated) - GET
/stats/top_creators_by_engagementCreators ranked by engagement gained (deprecated) - GET
/stats/top_creators_by_gmvCreators ranked by attributed sales (deprecated) - GET
/stats/top_creators_by_postsCreators ranked by posts (deprecated) - GET
/stats/top_earning_creatorsCreators ranked by what they earned (deprecated) - GET
/stats/top_posts_by_viewsPosts ranked by views gained (deprecated) - GET
/stats/transactionsPayments, payouts, deposits, withdrawals and disputes - GET
/stats/user_contentsCreator posts made within a date range (deprecated)