{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/","routeSlug":"/"},{"type":"link","label":"Core API Concepts","link":"/openapi","routeSlug":"/openapi"},{"type":"separator","label":"Creator Discovery"},{"type":"group","label":"Discovery API","link":"/openapi/discovery-api","routeSlug":"/openapi/discovery-api","items":[{"label":"Discovery API","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/discovery-api/public_v1_discovery_create","routeSlug":"/openapi/discovery-api/public_v1_discovery_create","metadata":{"seo":{"title":"Discovery API","description":"Search and discover creators across multiple platforms using advanced filtering and search."}},"httpPath":"/public/v1/discovery/"}]},{"type":"group","label":"Similar Creators","link":"/openapi/similar-creators","routeSlug":"/openapi/similar-creators","items":[{"label":"Similar Creators","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/similar-creators/public_v1_discovery_creators_similar_create","routeSlug":"/openapi/similar-creators/public_v1_discovery_creators_similar_create","metadata":{"seo":{"title":"Similar Creators","description":"Discover creators similar to a reference creator based on various similarity criteria."}},"httpPath":"/public/v1/discovery/creators/similar/"}]},{"type":"group","label":"Audience Overlap","link":"/openapi/audience-overlap","routeSlug":"/openapi/audience-overlap","items":[{"label":"Audience Overlap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/audience-overlap/public_v1_creators_audience_overlap_create","routeSlug":"/openapi/audience-overlap/public_v1_creators_audience_overlap_create","metadata":{"seo":{"title":"Audience Overlap","description":"Compare audience overlap between 2-10 creators on a given platform."}},"httpPath":"/public/v1/creators/audience/overlap/"}]},{"type":"group","label":"Exclusion lists","link":"/openapi/exclusion-lists","routeSlug":"/openapi/exclusion-lists","items":[{"label":"List exclusion lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_list","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_list","metadata":{"seo":{"title":"List exclusion lists","description":"Returns all exclusion lists available to your team, each scoped to a single platform. This includes both the auto-created default list per platform and any specific lists you have created. Adding handles to a list does not filter search on its own — apply a list to a search by passing exclude_list (list IDs), exclude_default_list, or exclude_all_lists in the Discovery or Similar Creators filters."}},"httpPath":"/public/v1/discovery/exclusion-lists/"},{"label":"Create exclusion list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_create","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_create","metadata":{"seo":{"title":"Create exclusion list","description":"Creates a new specific exclusion list for the given platform and returns its id. Use specific lists for handles you want to apply selectively; for a standing, always-on blocklist use the platform's default list instead. After creating a list, add handles via /exclusion-lists/{list_id}/entries/, then apply it to a search by passing its ID in exclude_list in the Discovery or Similar Creators filters. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/"},{"label":"Get default exclusion list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_retrieve","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_retrieve","metadata":{"seo":{"title":"Get default exclusion list","description":"Returns (and auto-creates if needed) the team's default exclusion list for the given platform. The default is your standing, always-on blocklist, addressed by platform rather than by ID, and cannot be deleted. Apply it to a search by passing exclude_default_list: true in the Discovery or Similar Creators filters."}},"httpPath":"/public/v1/discovery/exclusion-lists/default/{platform}/"},{"label":"List handles in the default exclusion list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_retrieve","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_retrieve","metadata":{"seo":{"title":"List handles in the default exclusion list","description":"Returns a paginated list of handles in the platform's default exclusion list. Defaults to the first 1,000 handles; use offset and limit to page through larger lists. Handles are returned in alphabetical order."}},"httpPath":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/"},{"label":"Add handles to the default exclusion list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_create","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_create","metadata":{"seo":{"title":"Add handles to the default exclusion list","description":"Appends handles to the platform's default exclusion list. Handles are normalised automatically (lowercased, @ stripped, full URLs reduced to just the handle). Adding handles does not filter search on its own — apply the default list to a search by passing exclude_default_list: true in the Discovery or Similar Creators filters. Returns the updated list object. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/"},{"label":"Remove handles from the default exclusion list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_delete","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_delete","metadata":{"seo":{"title":"Remove handles from the default exclusion list","description":"Removes handles from the platform's default exclusion list. Returns the updated list object. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/"},{"label":"Get a specific exclusion list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_retrieve","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_retrieve","metadata":{"seo":{"title":"Get a specific exclusion list","description":"Returns a single specific exclusion list by ID."}},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/"},{"label":"Rename a specific exclusion list","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_partial_update","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_partial_update","metadata":{"seo":{"title":"Rename a specific exclusion list","description":"Updates the name of a specific exclusion list. Returns the updated list object. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/"},{"label":"Delete a specific exclusion list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_delete","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_delete","metadata":{"seo":{"title":"Delete a specific exclusion list","description":"Permanently deletes a specific exclusion list and all its handles. The default list for a platform cannot be deleted. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/"},{"label":"List handles in a specific exclusion list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_entries_retrieve","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_entries_retrieve","metadata":{"seo":{"title":"List handles in a specific exclusion list","description":"Returns a paginated list of handles in the specific exclusion list. Defaults to the first 1,000 handles; use offset and limit to page through larger lists. Handles are returned in alphabetical order."}},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/entries/"},{"label":"Add handles to a specific exclusion list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_entries_create","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_entries_create","metadata":{"seo":{"title":"Add handles to a specific exclusion list","description":"Appends handles to the specific exclusion list. Handles are normalised automatically (lowercased, @ stripped, full URLs reduced to just the handle). Adding handles does not filter search on its own — apply the list to a search by passing its ID in exclude_list in the Discovery or Similar Creators filters. Returns the updated list object. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/entries/"},{"label":"Remove handles from a specific exclusion list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_entries_delete","routeSlug":"/openapi/exclusion-lists/public_v1_discovery_exclusion_lists_entries_delete","metadata":{"seo":{"title":"Remove handles from a specific exclusion list","description":"Removes handles from the specific exclusion list. Returns the updated list object. This operation is free — it does not consume credits."}},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/entries/"}]},{"type":"group","label":"Dictionary","link":"/openapi/dictionary","routeSlug":"/openapi/dictionary","items":[{"label":"Languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_languages_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_languages_list","metadata":{"seo":{"title":"Languages","description":"Retrieve a list of supported languages with their abbreviations for filtering creators by profile language or content language. Useful for discovering creators who create content in specific languages or target particular linguistic audiences."}},"httpPath":"/public/v1/discovery/classifier/languages/"},{"label":"Platform Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_locations_retrieve","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_locations_retrieve","metadata":{"seo":{"title":"Platform Locations","description":"Retrieve a list of location identifiers available for a specific platform."}},"httpPath":"/public/v1/discovery/classifier/locations/{platform}/"},{"label":"Brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_brands_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_brands_list","metadata":{"seo":{"title":"Brands","description":"Returns brands that can be used in the brands filter on the Discovery API, to find creators who have worked with a brand or mentioned it in their content. Each entry has the brand's username, display name (full_name) and a normalised name (cleaned)."}},"httpPath":"/public/v1/discovery/classifier/brands/"},{"label":"Youtube Topics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_yt_topics_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_yt_topics_list","metadata":{"seo":{"title":"Youtube Topics","description":"Retrieve a hierarchical list of YouTube topic categories and their subtopics."}},"httpPath":"/public/v1/discovery/classifier/yt-topics/"},{"label":"Twitch Games","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_games_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_games_list","metadata":{"seo":{"title":"Twitch Games","description":"Retrieve a list of video games available on Twitch that can be used for filtering creators. Returns game identifiers and metadata to help discover Twitch streamers who play specific games or have streamed particular titles."}},"httpPath":"/public/v1/discovery/classifier/games/"},{"label":"Audience Brand Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_audience_brand_categories_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_audience_brand_categories_list","metadata":{"seo":{"title":"Audience Brand Categories","description":"Returns a list of audience brand categories (e.g., Sports, Fashion, Technology) from Instagram creator audience data. Use these values in the audience.brand_categories filter on the Discovery API to search for Instagram creators (10k+ followers) whose audience follows brands in specific categories."}},"httpPath":"/public/v1/discovery/classifier/audience-brand-categories/"},{"label":"Audience Brand Names","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_audience_brand_names_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_audience_brand_names_list","metadata":{"seo":{"title":"Audience Brand Names","description":"Returns a list of audience brand names (e.g., Nike, Apple, Starbucks) from Instagram creator audience data. Use these values in the audience.brands filter on the Discovery API to search for Instagram creators (10k+ followers) whose audience follows specific brands."}},"httpPath":"/public/v1/discovery/classifier/audience-brand-names/"},{"label":"Audience Interests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_audience_interests_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_audience_interests_list","metadata":{"seo":{"title":"Audience Interests","description":"Returns a list of audience interest values from Instagram creator audience data. Use these values in the audience.interests filter on the Discovery API to search for Instagram creators (10k+ followers) whose audience has specific interests."}},"httpPath":"/public/v1/discovery/classifier/audience-interests/"},{"label":"Audience Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dictionary/public_v1_discovery_classifier_audience_locations_list","routeSlug":"/openapi/dictionary/public_v1_discovery_classifier_audience_locations_list","metadata":{"seo":{"title":"Audience Locations","description":"Returns a list of audience location values (countries, states, cities) from Instagram creator audience data. Use these values in the audience.location filter on the Discovery API to search for Instagram creators (10k+ followers) whose audience is in specific locations."}},"httpPath":"/public/v1/discovery/classifier/audience-locations/"}]},{"type":"separator","label":"Creator Enrichment"},{"type":"group","label":"Connected Socials","link":"/openapi/connected-socials","routeSlug":"/openapi/connected-socials","items":[{"label":"Connected Socials","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/connected-socials/public_v1_creators_socials_create","routeSlug":"/openapi/connected-socials/public_v1_creators_socials_create","metadata":{"seo":{"title":"Connected Socials","description":"Discover all verified social accounts connected to a creator, given a seed platform and handle."}},"httpPath":"/public/v1/creators/socials/"}]},{"type":"group","label":"Enrich by handle full","link":"/openapi/enrich-by-handle-full","routeSlug":"/openapi/enrich-by-handle-full","items":[{"label":"Enrich by handle full","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrich-by-handle-full/public_v1_creators_enrich_handle_full_create","routeSlug":"/openapi/enrich-by-handle-full/public_v1_creators_enrich_handle_full_create","metadata":{"seo":{"title":"Enrich by handle full","description":"Perform comprehensive enrichment of a creator profile using their social media handle."}},"httpPath":"/public/v1/creators/enrich/handle/full/"}]},{"type":"group","label":"Enrich by handle profile","link":"/openapi/enrich-by-handle-profile","routeSlug":"/openapi/enrich-by-handle-profile","items":[{"label":"Enrich by handle profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrich-by-handle-profile/public_v1_creators_enrich_handle_profile_create","routeSlug":"/openapi/enrich-by-handle-profile/public_v1_creators_enrich_handle_profile_create","metadata":{"seo":{"title":"Enrich by handle profile","description":"Enrich a creator profile with identity, contact, and vetting data using their social media handle."}},"httpPath":"/public/v1/creators/enrich/handle/profile/"}]},{"type":"group","label":"Enrich by handle analytics","link":"/openapi/enrich-by-handle-analytics","routeSlug":"/openapi/enrich-by-handle-analytics","items":[{"label":"Enrich by handle analytics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrich-by-handle-analytics/public_v1_creators_enrich_handle_analytics_create","routeSlug":"/openapi/enrich-by-handle-analytics/public_v1_creators_enrich_handle_analytics_create","metadata":{"seo":{"title":"Enrich by handle analytics","description":"Enrich a creator profile with performance analytics using their social media handle."}},"httpPath":"/public/v1/creators/enrich/handle/analytics/"}]},{"type":"group","label":"Enrich by handle raw","link":"/openapi/enrich-by-handle-raw","routeSlug":"/openapi/enrich-by-handle-raw","items":[{"label":"Enrich by handle raw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrich-by-handle-raw/public_v1_creators_enrich_handle_raw_create","routeSlug":"/openapi/enrich-by-handle-raw/public_v1_creators_enrich_handle_raw_create","metadata":{"seo":{"title":"Enrich by handle raw","description":"Retrieve raw platform data for a creator profile using their social media handle."}},"httpPath":"/public/v1/creators/enrich/handle/raw/"}]},{"type":"group","label":"Enrich by email","link":"/openapi/enrich-by-email","routeSlug":"/openapi/enrich-by-email","items":[{"label":"Enrich by email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/enrich-by-email/public_v1_creators_enrich_email_create","routeSlug":"/openapi/enrich-by-email/public_v1_creators_enrich_email_create","metadata":{"seo":{"title":"Enrich by email","description":"Perform basic enrichment of creator profiles using an email address."}},"httpPath":"/public/v1/creators/enrich/email/"}]},{"type":"group","label":"Batch enrichment","link":"/openapi/batch-enrichment","routeSlug":"/openapi/batch-enrichment","items":[{"label":"Create Batch Enrichment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batch-enrichment/public_v1_enrichment_batch_create","routeSlug":"/openapi/batch-enrichment/public_v1_enrichment_batch_create","metadata":{"seo":{"title":"Create Batch Enrichment","description":"Create a batch enrichment job by uploading a CSV."}},"httpPath":"/public/v1/enrichment/batch/"},{"label":"Get Batch Enrichment Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batch-enrichment/public_v1_enrichment_batch_status_retrieve","routeSlug":"/openapi/batch-enrichment/public_v1_enrichment_batch_status_retrieve","metadata":{"seo":{"title":"Get Batch Enrichment Status","description":"Check the current processing status of a batch enrichment job."}},"httpPath":"/public/v1/enrichment/batch/{batch_id}/status/"},{"label":"Resume Batch Enrichment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batch-enrichment/public_v1_enrichment_batch_resume_create","routeSlug":"/openapi/batch-enrichment/public_v1_enrichment_batch_resume_create","metadata":{"seo":{"title":"Resume Batch Enrichment","description":"Resume a paused or interrupted batch enrichment job."}},"httpPath":"/public/v1/enrichment/batch/{batch_id}/resume/"},{"label":"Download Batch Enrichment CSV (Recommended)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batch-enrichment/public_v1_enrichment_batch_download_retrieve","routeSlug":"/openapi/batch-enrichment/public_v1_enrichment_batch_download_retrieve","metadata":{"seo":{"title":"Download Batch Enrichment CSV (Recommended)","description":"Download the enriched CSV dataset via a temporary presigned URL. This is the recommended endpoint for downloading CSV results."}},"httpPath":"/public/v1/enrichment/batch/{batch_id}/download/"},{"label":"Download Batch Enrichment Results (Direct)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batch-enrichment/public_v1_enrichment_batch_retrieve","routeSlug":"/openapi/batch-enrichment/public_v1_enrichment_batch_retrieve","metadata":{"seo":{"title":"Download Batch Enrichment Results (Direct)","description":"Download the final enriched dataset after processing is complete."}},"httpPath":"/public/v1/enrichment/batch/{batch_id}/"}]},{"type":"separator","label":"Creator Monitoring"},{"type":"group","label":"Subscriptions","link":"/openapi/subscriptions","routeSlug":"/openapi/subscriptions","items":[{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_list","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_list","metadata":{"seo":{"title":"List subscriptions","description":"Return a paginated list of the client's social-listening subscriptions, optionally filtered by type. The response includes a summary block with aggregate counts. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/"},{"label":"Create subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_create","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_create","metadata":{"seo":{"title":"Create subscription","description":"Create a new social-listening subscription from handles and/or discovery lists. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/"},{"label":"Get subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_retrieve","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_retrieve","metadata":{"seo":{"title":"Get subscription","description":"Return the full detail representation of a subscription, including creators, daily cost, and (for campaign subscriptions) stats. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/"},{"label":"Update subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_partial_update","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_partial_update","metadata":{"seo":{"title":"Update subscription","description":"Partially update a subscription (name, endpoints, or creators). Status changes (pause/resume) on campaign-backed subscriptions are rejected; their lifecycle is driven by the campaign. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/"},{"label":"Delete subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_delete","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_delete","metadata":{"seo":{"title":"Delete subscription","description":"Delete a webhook subscription and all its related links. Campaign-backed subscriptions are rejected; archive the campaign instead (DELETE /campaign/<pk>/). Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/"},{"label":"List subscription creators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_creators_retrieve","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_creators_retrieve","metadata":{"seo":{"title":"List subscription creators","description":"Return a paginated list of creators in the subscription with follower and source metadata, optionally filtered by handle via the search query parameter. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/creators/"},{"label":"Add subscription creators","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_creators_create","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_creators_create","metadata":{"seo":{"title":"Add subscription creators","description":"Add creators to the subscription from handles, discovery lists, and/or a CSV file (a handle column is required). Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/creators/"},{"label":"Get subscription stats","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_details_retrieve","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_details_retrieve","metadata":{"seo":{"title":"Get subscription stats","description":"Return aggregated delivery stats for a campaign subscription. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/details/"},{"label":"Export subscription stats (CSV)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/public_v1_social_listening_subscription_details_export_retrieve","routeSlug":"/openapi/subscriptions/public_v1_social_listening_subscription_details_export_retrieve","metadata":{"seo":{"title":"Export subscription stats (CSV)","description":"Download the campaign subscription's aggregated stats as a CSV file. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/details/export/"}]},{"type":"group","label":"Campaigns","link":"/openapi/campaigns","routeSlug":"/openapi/campaigns","items":[{"label":"List campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_list","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_list","metadata":{"seo":{"title":"List campaigns","description":"Return a paginated list of the client's campaigns, optionally filtered by status and search, with a status_counts summary. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/"},{"label":"Create campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_create","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_create","metadata":{"seo":{"title":"Create campaign","description":"Create a campaign and its backing per-platform webhook subscriptions. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/"},{"label":"Get campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_retrieve","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_retrieve","metadata":{"seo":{"title":"Get campaign","description":"Return the detail representation of a single campaign by id. Team members can view campaigns within their client scope. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/"},{"label":"Update campaign","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_partial_update","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_partial_update","metadata":{"seo":{"title":"Update campaign","description":"Update a campaign's status, budget and/or content types. Setting status to paused or active pauses/resumes the campaign and cascades the same status to all its backing subscriptions; resuming runs a credit check. Editing content types re-derives and propagates the detection filters to the campaign's backing subscriptions. Archived or completed campaigns cannot be edited. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/"},{"label":"Archive campaign","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_delete","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_delete","metadata":{"seo":{"title":"Archive campaign","description":"Archive a campaign and disable all its backing subscriptions. This is a soft delete: rows are retained but detection is stopped. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/"},{"label":"List campaign creators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_creators_retrieve","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_creators_retrieve","metadata":{"seo":{"title":"List campaign creators","description":"Return a paginated list of the campaign's creators with per-creator metrics (posts, views, engagement, ER%, EMV, and a 7-day trend), searchable by handle/name and sortable by any metric column. Creators added but not yet posting are included with status awaiting_first_post. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/creators/"},{"label":"Add campaign creators","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_creators_create","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_creators_create","metadata":{"seo":{"title":"Add campaign creators","description":"Add creators to one of the campaign's platforms from handles, a discovery list, and/or a CSV file. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/creators/"},{"label":"Remove campaign creators","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_creators_delete","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_creators_delete","metadata":{"seo":{"title":"Remove campaign creators","description":"Remove creators from the campaign by creator id (the id field from the Creators list). The creators' links are deleted while the campaign and subscriptions are kept; detection stops for the removed creators. Idempotent: ids that aren't on the campaign are ignored. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/creators/"},{"label":"Get campaign overview","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_overview_retrieve","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_overview_retrieve","metadata":{"seo":{"title":"Get campaign overview","description":"Return the aggregated overview metrics for a single campaign, including total posts, views, engagement, EMV, and trends. Optionally filter by platform using the platform query parameter. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/overview/"},{"label":"List campaign content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_content_retrieve","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_content_retrieve","metadata":{"seo":{"title":"List campaign content","description":"Return a paginated feed of the campaign's posts (one per detected new_post event), optionally narrowed to a single platform and sorted by a metric column (defaults to most recent first). Each post carries its creator, metrics, per-post EMV and ER%, media, and a top flag for the highest-ER posts. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/content/"},{"label":"Get campaign AI report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_report_retrieve","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_report_retrieve","metadata":{"seo":{"title":"Get campaign AI report","description":"Return the campaign's most recent AI report. While the report is being generated its status is generating and report_data is empty — poll until status becomes ready (or failed). Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/report/"},{"label":"Generate campaign AI report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_report_create","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_report_create","metadata":{"seo":{"title":"Generate campaign AI report","description":"Start asynchronous generation of a new AI report for the campaign (also used to regenerate). Returns the pending report; poll the GET endpoint until its status is ready. If a generation is already in progress the pending report is returned instead of starting another one. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/report/"},{"label":"Export campaign report data (CSV)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/campaigns/public_v1_social_listening_campaign_report_export_retrieve","routeSlug":"/openapi/campaigns/public_v1_social_listening_campaign_report_export_retrieve","metadata":{"seo":{"title":"Export campaign report data (CSV)","description":"Download the campaign's raw post-level report data as a CSV file (one row per detected post with its metrics). Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/report/export/"}]},{"type":"group","label":"Events","link":"/openapi/events","routeSlug":"/openapi/events","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/events/public_v1_social_listening_events_list","routeSlug":"/openapi/events/public_v1_social_listening_events_list","metadata":{"seo":{"title":"List events","description":"Return a paginated list of the client's events, optionally filtered by subscription, event type, or creator. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/events/"},{"label":"Get event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/events/public_v1_social_listening_events_retrieve","routeSlug":"/openapi/events/public_v1_social_listening_events_retrieve","metadata":{"seo":{"title":"Get event","description":"Return a single event with its full payload and delivery history. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/events/{event_id}/"}]},{"type":"group","label":"Usage","link":"/openapi/usage","routeSlug":"/openapi/usage","items":[{"label":"Get usage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/usage/public_v1_social_listening_usage_list","routeSlug":"/openapi/usage/public_v1_social_listening_usage_list","metadata":{"seo":{"title":"Get usage","description":"Return current social-listening limits and active subscription counts for the client's scope. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits."}},"httpPath":"/public/v1/social/listening/usage/"}]},{"type":"separator","label":"Creator Content"},{"type":"group","label":"Creator Posts","link":"/openapi/creator-posts","routeSlug":"/openapi/creator-posts","items":[{"label":"Creator Posts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/creator-posts/public_v1_creators_content_posts_create","routeSlug":"/openapi/creator-posts/public_v1_creators_content_posts_create","metadata":{"seo":{"title":"Creator Posts","description":"Fetch recent posts for a creator on a given platform."}},"httpPath":"/public/v1/creators/content/posts/"}]},{"type":"group","label":"Post Details","link":"/openapi/post-details","routeSlug":"/openapi/post-details","items":[{"label":"Post Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/post-details/public_v1_creators_content_details_create","routeSlug":"/openapi/post-details/public_v1_creators_content_details_create","metadata":{"seo":{"title":"Post Details","description":"Retrieve detailed information about specific creator content."}},"httpPath":"/public/v1/creators/content/details/"}]},{"type":"separator","label":"Account & Authentication"},{"type":"group","label":"Account credits & usage","link":"/openapi/account-credits-and-usage","routeSlug":"/openapi/account-credits-and-usage","items":[{"label":"Check account credits and usage details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-credits-and-usage/account_credits_usage_retrieve","routeSlug":"/openapi/account-credits-and-usage/account_credits_usage_retrieve","metadata":{"seo":{"title":"Check account credits and usage details","description":"Use your API key to check your remaining credits and total credits used."}},"httpPath":"/public/v1/accounts/credits/"}]},{"type":"group","label":"API Keys","link":"/openapi/api-keys","routeSlug":"/openapi/api-keys","items":[{"label":"List API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-keys/public_v1_accounts_tokens_list","routeSlug":"/openapi/api-keys/public_v1_accounts_tokens_list","metadata":{"seo":{"title":"List API keys","description":"Returns all API keys for the authenticated user, including inactive ones. Each response object includes the raw token value and the active field indicating current status."}},"httpPath":"/public/v1/accounts/tokens/"},{"label":"Create API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-keys/public_v1_accounts_tokens_create","routeSlug":"/openapi/api-keys/public_v1_accounts_tokens_create","metadata":{"seo":{"title":"Create API key","description":"Creates a new API key. The token value is included in the response."}},"httpPath":"/public/v1/accounts/tokens/"},{"label":"Update API key","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-keys/public_v1_accounts_tokens_partial_update","routeSlug":"/openapi/api-keys/public_v1_accounts_tokens_partial_update","metadata":{"seo":{"title":"Update API key","description":"Update an API key's label, active status, expiration date, or scopes. Pass null for expires_at to remove expiration."}},"httpPath":"/public/v1/accounts/tokens/{token_id}/"},{"label":"Delete API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-keys/public_v1_accounts_tokens_delete","routeSlug":"/openapi/api-keys/public_v1_accounts_tokens_delete","metadata":{"seo":{"title":"Delete API key","description":"Delete API key"}},"httpPath":"/public/v1/accounts/tokens/{token_id}/"}]},{"type":"group","label":"OAuth","link":"/openapi/oauth","routeSlug":"/openapi/oauth","items":[{"label":"Register OAuth client (DCR)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oauth/public_v1_oauth_register_create","routeSlug":"/openapi/oauth/public_v1_oauth_register_create","metadata":{"seo":{"title":"Register OAuth client (DCR)","description":"Open endpoint — no authentication required. Desktop/CLI apps call this once to obtain a client_id they persist locally and reuse for all future authorize flows."}},"httpPath":"/public/v1/oauth/register/"},{"label":"Initiate OAuth authorization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oauth/public_v1_oauth_authorize_list","routeSlug":"/openapi/oauth/public_v1_oauth_authorize_list","metadata":{"seo":{"title":"Initiate OAuth authorization","description":"OAuth 2.1 authorization endpoint. The client opens the browser at this URL; valid requests are redirected to the frontend consent page where the user approves access."}},"httpPath":"/public/v1/oauth/authorize/"},{"label":"OAuth token endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oauth/public_v1_oauth_token_create","routeSlug":"/openapi/oauth/public_v1_oauth_token_create","metadata":{"seo":{"title":"OAuth token endpoint","description":"Accepts application/x-www-form-urlencoded or application/json."}},"httpPath":"/public/v1/oauth/token/"},{"label":"List connected OAuth apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oauth/public_v1_oauth_apps_list","routeSlug":"/openapi/oauth/public_v1_oauth_apps_list","metadata":{"seo":{"title":"List connected OAuth apps","description":"Returns all OAuth apps the authenticated user has authorized."}},"httpPath":"/public/v1/oauth/apps/"},{"label":"Disconnect OAuth app","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oauth/public_v1_oauth_apps_delete","routeSlug":"/openapi/oauth/public_v1_oauth_apps_delete","metadata":{"seo":{"title":"Disconnect OAuth app","description":"Revokes the user's authorization for the given app and deactivates all associated access tokens."}},"httpPath":"/public/v1/oauth/apps/{app_id}/"}]},{"type":"group","label":"Resources","items":[{"type":"link","fsPath":"guides/usage-limits.md","metadata":{"type":"markdown"},"label":"Usage and Limits","link":"/guides/usage-limits","routeSlug":"/guides/usage-limits"},{"type":"link","fsPath":"guides/faq.md","metadata":{"type":"markdown"},"label":"API FAQ","link":"/guides/faq","routeSlug":"/guides/faq"},{"type":"link","fsPath":"guides/error-handling.md","metadata":{"type":"markdown"},"label":"Error Handling","link":"/guides/error-handling","routeSlug":"/guides/error-handling"},{"type":"link","fsPath":"guides/mcp-server.md","metadata":{"type":"markdown"},"label":"MCP Server","link":"/guides/mcp-server","routeSlug":"/guides/mcp-server"},{"type":"link","fsPath":"guides/changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/guides/changelog","routeSlug":"/guides/changelog"}]}]}