# Growi Api Docs

## Docs

- [Create Tracking Event](https://growi.mintlify.app/api-reference/endpoint/create.md): Creates a new tracking event associated with a campaign creator
- [Create Affiliate Sale](https://growi.mintlify.app/api-reference/endpoint/create-affiliate-sale.md): Creates a website conversion and attributes it to a campaign affiliate. Idempotent: sending the same order_id returns the existing sale.
- [Get Ambassador Sales](https://growi.mintlify.app/api-reference/endpoint/get-ambassador-sales.md): Retrieves detailed ambassador sales data including order information, commission amounts, and program details within a specified date range
- [Get Ambassador Stats](https://growi.mintlify.app/api-reference/endpoint/get-ambassador-stats.md): Retrieves aggregated statistics for campaign ambassadors, grouped by individual affiliate. This endpoint provides performance metrics including revenue, commission, order counts, and clicks for ambassadors within a specified date range.
- [Get Ambassadors](https://growi.mintlify.app/api-reference/endpoint/get-ambassadors.md): Retrieves all ambassadors from ambassador program campaigns for the organization. Returns ambassador profile information including their social accounts, custom field answers from their application, and contact details.
- [Get Brands](https://growi.mintlify.app/api-reference/endpoint/get-brands.md): Retrieves a list of all available brands for your organization
- [Get Campaigns](https://growi.mintlify.app/api-reference/endpoint/get-campaigns.md): Retrieves a list of all available campaigns for your organization
- [Get Content 24h Data](https://growi.mintlify.app/api-reference/endpoint/get-content-24h-data.md): Retrieves 24-hour views and engagement metrics with comparison to previous period
- [Get Content Platform Composition](https://growi.mintlify.app/api-reference/endpoint/get-content-platform-composition.md): Retrieves a breakdown of content by platform within a specified date range
- [Get Creator Payouts](https://growi.mintlify.app/api-reference/endpoint/get-creator-payouts.md)
- [Get Creators 24h](https://growi.mintlify.app/api-reference/endpoint/get-creators-24h.md): Retrieves daily creator metrics tracking both new creators (who joined your database) and active creators (who made posts) with comparison to previous period
- [Get Snapshots](https://growi.mintlify.app/api-reference/endpoint/get-snapshots.md): Retrieves time-series data for content engagement metrics within a specified date range
- [Get TikTok Shop GMV 24h](https://growi.mintlify.app/api-reference/endpoint/get-tik-tok-shop-gmv-24h.md): Retrieves TikTok Shop Gross Merchandise Value (GMV) data with daily breakdown and comparison to previous period
- [Top TikTok Shop Products by GMV](https://growi.mintlify.app/api-reference/endpoint/get-tik-tok-shop-products.md): Retrieves TikTok Shop product-level Gross Merchandise Value (GMV) data with aggregated statistics
- [Get Top Connected Accounts By Engagement](https://growi.mintlify.app/api-reference/endpoint/get-top-connected-accounts-by-engagement.md): Retrieves your top-performing social accounts ranked by engagement within a specified date range
- [Get Top Creators By Engagement](https://growi.mintlify.app/api-reference/endpoint/get-top-creators.md): Retrieves your top-performing creators ranked by total engagement within a specified date range
- [Get Top Creators By GMV](https://growi.mintlify.app/api-reference/endpoint/get-top-creators-by-gmv.md): Retrieves your top-performing creators ranked by GMV within a specified date range
- [Get Top Creators By Posts](https://growi.mintlify.app/api-reference/endpoint/get-top-creators-by-posts.md): Retrieves your most active creators ranked by post count within a specified date range
- [Get Top Posts By Views](https://growi.mintlify.app/api-reference/endpoint/get-top-posts-by-views.md): Retrieves your top-performing posts ranked by views within a specified date range
- [Get Transactions](https://growi.mintlify.app/api-reference/endpoint/get-transactions.md): Retrieves transaction history including payments, payouts, deposits, withdrawals, and disputes with detailed financial information
- [Get User Contents](https://growi.mintlify.app/api-reference/endpoint/get-user-contents.md): Retrieves all user content creation data within a date range
- [List Affiliate Sales](https://growi.mintlify.app/api-reference/endpoint/list-affiliate-sales.md): Retrieves paginated affiliate sales (conversions) for the organization. For website conversions, use store_platform=website. For Shopify, use store_platform=shopify_store with store_id.
- [Mark Credit Payout](https://growi.mintlify.app/api-reference/endpoint/mark-credit-payout.md)
- [Refresh Data](https://growi.mintlify.app/api-reference/endpoint/refresh-data.md): Refreshes and re-syncs all creator social accounts data. This endpoint triggers a background job to update content snapshots and synchronize creator data across all connected platforms.
- [Update Affiliate Sale](https://growi.mintlify.app/api-reference/endpoint/update-affiliate-sale.md): Updates an existing affiliate sale that was created via the Public API (website platform). Only sales created through POST /affiliate_sales can be updated. Commission is automatically recalculated if total is updated without specifying commission.
- [Introduction](https://growi.mintlify.app/api-reference/introduction.md): Growi API documentation for showcasing endpoints and authentication methods
- [Campaign Creator Webhooks](https://growi.mintlify.app/essentials/campaign-creator-webhooks.md): Receive notifications when creators are added or removed from campaigns
- [Getting Stats](https://growi.mintlify.app/essentials/get-stats.md): Learn how to authenticate and access Growi statistics
- [Shopify Headless Integration](https://growi.mintlify.app/essentials/shopify-headless-integration.md): Learn how to set up Shopify Headless with Growi
- [Stripe Integration](https://growi.mintlify.app/essentials/stripe-integration.md): Learn how to set up Stripe with Growi
- [Introduction](https://growi.mintlify.app/introduction.md): Welcome to Growi Documentation

## OpenAPI Specs

- [openapi](https://growi.mintlify.app/api-reference/openapi.json)