{"items":[{"type":"link","label":"Core API Concepts","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Core API Concepts"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Core API Concepts (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every request is authenticated by a Bearer credential in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. There are two types of credential, each suited to a different use case:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — call the API as yourself (scripts, backend services). Create and revoke them in the dashboard or via the API; you can hold several and revoke any one independently."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for applications acting on behalf of other users (desktop or CLI tools), via OAuth 2.0 with PKCE."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each credential carries one or more scopes that control what it can access. Today every credential is issued with full access; scoped, least-privilege credentials are planned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify and evaluate creators using structured, platform-specific search criteria."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses are intentionally constrained to support ranking, filtering, and selection"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at scale rather than full profile hydration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrichment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve complete creator-level data once a candidate has been identified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrichment responses provide the depth required for analysis, activation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and downstream data workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execution modes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrichment is available in both synchronous and asynchronous forms."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single enrichment supports real-time use cases, while batch enrichment is optimized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for high-throughput, non-interactive processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typical usage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery and enrichment are designed as complementary stages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery narrows the candidate set; enrichment supplies detailed data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for creators that have already been qualified."},"children":[]}]}]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"separator","label":"Creator Discovery","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_create","name":"Discovery API","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discovery API","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and discover creators across multiple platforms using advanced filtering and search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated list of creator profiles with profile info, follower counts, engagement rates, and analytics. Instagram creators (10k+ followers) also include audience demographics and interest data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Instagram, YouTube, TikTok, Twitch, Twitter, and OnlyFans platforms."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform-specific filters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available filters depend on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you choose — switching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" changes the filter fields in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Dictionary endpoints to retrieve valid values for filters such as locations, languages, brands, audience interests, and audience locations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language search"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on their own. Sending an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nlp_search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" brief lets you describe who you're looking for in plain language instead of building filters by hand, and you can combine the two."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 200 response adds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (what the search actually ran with) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nlp_search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (what the AI inferred, and why anything was dropped)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.01 credits per creator returned"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — 0 creators, 0 credits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every request that returns creators is billed, even with identical filters. Monitoring your request volume and credit usage is your responsibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage is capped per billing period — see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#discovery-fair-use-cap"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how the cap works and what happens when you reach it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium: matched filter values"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return_filter_values=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — each returned creator includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"matched_filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object showing exactly which of your filter values it matched; see its schema in the 200 response for the shape of each field. 0.03 credits per creator instead of 0.01, and the unique-handle cap is unchanged. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/faq#can-i-see-which-filter-values-each-creator-matched"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the FAQ"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an example."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"discovery"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"return_filter_values","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include a matched_filters object on each returned creator."},"children":[]}]}]}]}],"pointer":"/paths/~1public~1v1~1discovery~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example"]},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1x-www-form-urlencoded/example"]},"multipart/form-data":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1public~1v1~1discovery~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/discovery/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"return_filter_values","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example"]},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1x-www-form-urlencoded/example"]},"multipart/form-data":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["200","400","401","403","422","429","503"],"pointer":"/public/v1/discovery/","href":"discovery-api/public_v1_discovery_create","openApiOperationId":"public_v1_discovery_create","summary":"Discovery API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example"]},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1x-www-form-urlencoded/example"]},"multipart/form-data":{"schemaId":"components/schemas/DiscoveryAPISearchInputRequest","exampleIds":["paths/~1public~1v1~1discovery~1/post/requestBody/content/multipart~1form-data/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscoverySearchResponse"}},"schemaId":"components/schemas/DiscoverySearchResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid or missing parameters. Also returned when an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nlp_search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" brief cannot be interpreted into filters (\"Your search couldn't be interpreted into filters\"), in which case nothing is charged."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Error — a downstream dependency failed. Safe to retry. Returned when the AI mapping service behind "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nlp_search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is temporarily unavailable."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DiscoverySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscoverySearchResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discovery-api/public_v1_discovery_create"}],"panels":[]}]},"httpPath":"/public/v1/discovery/"}],"content":{"contentType":"group","meta":{"name":"Discovery API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discovery API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/discovery/","summary":"Discovery API","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discovery-api/public_v1_discovery_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_creators_similar_create","name":"Similar Creators","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1creators~1similar~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Similar Creators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover creators similar to a reference creator based on various similarity criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of creator profiles that match the reference creator's characteristics, content style, audience, or other specified attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports filtering by URL, username, or ID, and allows additional filters to refine similarity matching."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for finding lookalike creators, competitors, or creators in the same niche."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.01 credits per creator returned"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no creators are returned, no credits are deducted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits are consumed on "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that returns creators, even if the filters are identical to a previous request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the client's responsibility to monitor request volume and credit usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Similar-creator results count against the same per-billing-period Discovery cap. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#discovery-fair-use-cap"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"similar"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"}},"schemaId":"components/schemas/EnrichSimilarCreatorsRequest","pointer":"/paths/~1public~1v1~1discovery~1creators~1similar~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/discovery/creators/similar/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/creators/similar/","href":"similar-creators/public_v1_discovery_creators_similar_create","openApiOperationId":"public_v1_discovery_creators_similar_create","summary":"Similar Creators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/EnrichSimilarCreatorsRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichSimilarCreatorsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscoveryAPIResponse"}},"schemaId":"components/schemas/DiscoveryAPIResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1creators~1similar~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DiscoveryAPIResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscoveryAPIResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/similar-creators/public_v1_discovery_creators_similar_create"}],"panels":[]}]},"httpPath":"/public/v1/discovery/creators/similar/"}],"content":{"contentType":"group","meta":{"name":"Similar Creators"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Similar Creators","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/discovery/creators/similar/","summary":"Similar Creators","prefix":{"name":"post","color":"post"},"badges":[],"link":"/similar-creators/public_v1_discovery_creators_similar_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_audience_overlap_create","name":"Audience Overlap","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1audience~1overlap~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience Overlap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare audience overlap between 2-10 creators on a given platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns per-creator audience overlap and unique audience percentages, plus report-level totals (total followers and total unique followers across all compared creators)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for evaluating creator partnerships, identifying audience duplication across campaigns, and optimizing influencer selection for maximum reach."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 credit per request, regardless of how many creators are compared."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"audience-overlap"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AudienceOverlapInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AudienceOverlapInput"},"multipart/form-data":{"schemaId":"components/schemas/AudienceOverlapInput"}},"schemaId":"components/schemas/AudienceOverlapInput","pointer":"/paths/~1public~1v1~1creators~1audience~1overlap~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/audience/overlap/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AudienceOverlapInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AudienceOverlapInput"},"multipart/form-data":{"schemaId":"components/schemas/AudienceOverlapInput"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/audience/overlap/","href":"audience-overlap/public_v1_creators_audience_overlap_create","openApiOperationId":"public_v1_creators_audience_overlap_create","summary":"Audience Overlap"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/AudienceOverlapInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AudienceOverlapInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AudienceOverlapInput"},"multipart/form-data":{"schemaId":"components/schemas/AudienceOverlapInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AudienceOverlapResponse"}},"schemaId":"components/schemas/AudienceOverlapResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1audience~1overlap~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AudienceOverlapResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AudienceOverlapResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audience-overlap/public_v1_creators_audience_overlap_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/audience/overlap/"}],"content":{"contentType":"group","meta":{"name":"Audience Overlap"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience Overlap","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/audience/overlap/","summary":"Audience Overlap","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audience-overlap/public_v1_creators_audience_overlap_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_list","name":"List exclusion lists","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List exclusion lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (list IDs), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_default_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_all_lists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Discovery or Similar Creators "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/exclusion-lists/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_list","openApiOperationId":"public_v1_discovery_exclusion_lists_list","summary":"List exclusion lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_create","name":"Create exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new specific exclusion list for the given platform and returns its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/exclusion-lists/{list_id}/entries/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then apply it to a search by passing its ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Discovery or Similar Creators "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This operation is free — it does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionListCreateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionListCreateRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionListCreateRequest"}},"schemaId":"components/schemas/ExclusionListCreateRequest","pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/discovery/exclusion-lists/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExclusionListCreateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionListCreateRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionListCreateRequest"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_create","openApiOperationId":"public_v1_discovery_exclusion_lists_create","summary":"Create exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ExclusionListCreateRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionListCreateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionListCreateRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionListCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_default_retrieve","name":"Get default exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get default exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_default_list: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Discovery or Similar Creators "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform","in":"path","schemaId":"schema_29","description":"The social media platform the exclusion list applies to.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/exclusion-lists/default/{platform}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"platform","in":"path","required":true,"schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/default/{platform}/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_default_retrieve","openApiOperationId":"public_v1_discovery_exclusion_lists_default_retrieve","summary":"Get default exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Invalid platform","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_default_entries_retrieve","name":"List handles in the default exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List handles in the default exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of handles in the platform's default exclusion list. Defaults to the first 1,000 handles; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to page through larger lists. Handles are returned in alphabetical order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform","in":"path","schemaId":"schema_29","description":"The social media platform the exclusion list applies to.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_30","description":"Number of handles to skip from the start of the list."},{"name":"limit","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of handles to return (1–10,000)."},"children":[]}]}]}]}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"platform","in":"path","required":true,"schemaId":"schema_29"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_30"},{"name":"limit","in":"query","required":false,"schemaId":"schema_31"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_retrieve","openApiOperationId":"public_v1_discovery_exclusion_lists_default_entries_retrieve","summary":"List handles in the default exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesResponse"}},"schemaId":"components/schemas/ExclusionEntriesResponse"},{"code":"400","description":"Invalid platform","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_default_entries_create","name":"Add handles to the default exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add handles to the default exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_default_list: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Discovery or Similar Creators "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns the updated list object. This operation is free — it does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform","in":"path","schemaId":"schema_29","description":"The social media platform the exclusion list applies to.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"schemaId":"components/schemas/ExclusionEntriesInputRequest","pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"platform","in":"path","required":true,"schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_create","openApiOperationId":"public_v1_discovery_exclusion_lists_default_entries_create","summary":"Add handles to the default exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ExclusionEntriesInputRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_default_entries_delete","name":"Remove handles from the default exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove handles from the default exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes handles from the platform's default exclusion list. Returns the updated list object. This operation is free — it does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform","in":"path","schemaId":"schema_29","description":"The social media platform the exclusion list applies to.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"schemaId":"components/schemas/ExclusionEntriesInputRequest","pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"platform","in":"path","required":true,"schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_delete","openApiOperationId":"public_v1_discovery_exclusion_lists_default_entries_delete","summary":"Remove handles from the default exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ExclusionEntriesInputRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1default~1{platform}~1entries~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_delete"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_retrieve","name":"Get a specific exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single specific exclusion list by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_32","description":"The exclusion list's unique identifier.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/exclusion-lists/{list_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/{list_id}/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_retrieve","openApiOperationId":"public_v1_discovery_exclusion_lists_retrieve","summary":"Get a specific exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_partial_update","name":"Rename a specific exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a specific exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the name of a specific exclusion list. Returns the updated list object. This operation is free — it does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_32","description":"The exclusion list's unique identifier.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionListUpdateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionListUpdateRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionListUpdateRequest"}},"schemaId":"components/schemas/ExclusionListUpdateRequest","pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/discovery/exclusion-lists/{list_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExclusionListUpdateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionListUpdateRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionListUpdateRequest"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/{list_id}/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_partial_update","openApiOperationId":"public_v1_discovery_exclusion_lists_partial_update","summary":"Rename a specific exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ExclusionListUpdateRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionListUpdateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionListUpdateRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionListUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_partial_update"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_delete","name":"Delete a specific exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a specific exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_32","description":"The exclusion list's unique identifier.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/discovery/exclusion-lists/{list_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/{list_id}/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_delete","openApiOperationId":"public_v1_discovery_exclusion_lists_delete","summary":"Delete a specific exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_delete"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_entries_retrieve","name":"List handles in a specific exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List handles in a specific exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of handles in the specific exclusion list. Defaults to the first 1,000 handles; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to page through larger lists. Handles are returned in alphabetical order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_32","description":"The exclusion list's unique identifier.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_30","description":"Number of handles to skip from the start of the list."},{"name":"limit","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of handles to return (1–10,000)."},"children":[]}]}]}]}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_30"},{"name":"limit","in":"query","required":false,"schemaId":"schema_31"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_entries_retrieve","openApiOperationId":"public_v1_discovery_exclusion_lists_entries_retrieve","summary":"List handles in a specific exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesResponse"}},"schemaId":"components/schemas/ExclusionEntriesResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_entries_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_entries_create","name":"Add handles to a specific exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add handles to a specific exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Discovery or Similar Creators "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns the updated list object. This operation is free — it does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_32","description":"The exclusion list's unique identifier.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"schemaId":"components/schemas/ExclusionEntriesInputRequest","pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_entries_create","openApiOperationId":"public_v1_discovery_exclusion_lists_entries_create","summary":"Add handles to a specific exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ExclusionEntriesInputRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_entries_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_exclusion_lists_entries_delete","name":"Remove handles from a specific exclusion list","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove handles from a specific exclusion list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes handles from the specific exclusion list. Returns the updated list object. This operation is free — it does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_32","description":"The exclusion list's unique identifier.","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"schemaId":"components/schemas/ExclusionEntriesInputRequest","pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","href":"exclusion-lists/public_v1_discovery_exclusion_lists_entries_delete","openApiOperationId":"public_v1_discovery_exclusion_lists_entries_delete","summary":"Remove handles from a specific exclusion list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ExclusionEntriesInputRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"},"multipart/form-data":{"schemaId":"components/schemas/ExclusionEntriesInputRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}},"schemaId":"components/schemas/ExclusionList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1exclusion-lists~1{list_id}~1entries~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusionList"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exclusion-lists/public_v1_discovery_exclusion_lists_entries_delete"}],"panels":[]}]},"httpPath":"/public/v1/discovery/exclusion-lists/{list_id}/entries/"}],"content":{"contentType":"group","meta":{"name":"Exclusion lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exclusion lists","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage lists of creator handles to exclude from Discovery and Similar Creators results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default vs specific lists."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Every team gets one "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list per platform (Instagram, TikTok, etc.). It is created automatically the first time you touch it, you address it by platform — e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /exclusion-lists/default/instagram/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — and it cannot be deleted; think of it as your standing blocklist. You can also create "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists when one list is not enough — e.g. \"Q4 campaign blocklist\", \"competitor handles\", \"do-not-contact\". Specific lists get an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and are managed via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/exclusion-lists/{list_id}/…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; you can rename or delete them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding handles alone does not filter search."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To actually filter Discovery or Similar Creators, pass one of these in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_list: [42, 57]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — apply those list IDs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_default_list: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — apply the platform's default list"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_all_lists: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — apply every list for that platform"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example flow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /exclusion-lists/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"name\": \"Competitors\", \"platform\": \"instagram\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id: 42"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /exclusion-lists/42/entries/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"handles\": [\"brand_x\", \"brand_y\"] }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /discovery/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters.exclude_list: [42]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brand_x"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brand_y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are now filtered out."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the default list, skip step 1: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /exclusion-lists/default/instagram/entries/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then search with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters.exclude_default_list: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/discovery/exclusion-lists/","summary":"List exclusion lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_list","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/","summary":"Create exclusion list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_create","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/default/{platform}/","summary":"Get default exclusion list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_retrieve","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","summary":"List handles in the default exclusion list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_retrieve","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","summary":"Add handles to the default exclusion list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_create","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/default/{platform}/entries/","summary":"Remove handles from the default exclusion list","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_default_entries_delete","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/{list_id}/","summary":"Get a specific exclusion list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_retrieve","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/{list_id}/","summary":"Rename a specific exclusion list","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_partial_update","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/{list_id}/","summary":"Delete a specific exclusion list","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_delete","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","summary":"List handles in a specific exclusion list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_entries_retrieve","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","summary":"Add handles to a specific exclusion list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_entries_create","deprecated":false},{"title":"/public/v1/discovery/exclusion-lists/{list_id}/entries/","summary":"Remove handles from a specific exclusion list","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exclusion-lists/public_v1_discovery_exclusion_lists_entries_delete","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_languages_list","name":"Languages","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1languages~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/languages/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/languages/","href":"dictionary/public_v1_discovery_classifier_languages_list","openApiOperationId":"public_v1_discovery_classifier_languages_list","summary":"Languages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1languages~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_languages_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_locations_retrieve","name":"Platform Locations","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1locations~1{platform}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Platform Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of location identifiers available for a specific platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns location strings that can be used to filter creators by geographic location in discovery searches."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform-specific location data helps target creators from specific regions, cities, or countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter for substring/prefix matching on location names (e.g. \"London\", \"United\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to paginate through results."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform","in":"path","schemaId":"schema_35","required":true}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1locations~1{platform}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_35","description":"Search string to filter results"},{"name":"offset","in":"query","schemaId":"schema_32","description":"Cursor offset for pagination"},{"name":"limit","in":"query","schemaId":"schema_32","description":"Number of results to return per page (1-100)"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1locations~1{platform}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/locations/{platform}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"platform","in":"path","required":true,"schemaId":"schema_35"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"offset","in":"query","required":false,"schemaId":"schema_32"},{"name":"limit","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/locations/{platform}/","href":"dictionary/public_v1_discovery_classifier_locations_retrieve","openApiOperationId":"public_v1_discovery_classifier_locations_retrieve","summary":"Platform Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of strings representing platform details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1locations~1{platform}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_locations_retrieve"}],"panels":[]}]},"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_brands_list","name":"Brands","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1brands~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brands","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns brands that can be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", display name ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a normalised name ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cleaned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results come in pages, not a complete list. Add your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page — the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", even if fewer come back, or you will get repeats. Short pages are normal, because duplicates and brands with a social network in the name are dropped after paging, so keep going until you get an empty response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter on the Discovery API. The filter matches against "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so sending a display name returns a 400."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches a brand's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exactly. Use it to confirm a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before filtering on it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exact=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match part of a brand's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cleaned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name instead — the normalised value returned with each entry, not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?search=kfc&exact=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns \"KFC UK & Ireland\", which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?search=kfc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on its own does not."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cleaned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" drops accents, punctuation and emoji, transliterates non-Latin scripts, and is often shorter than the display name: \"L'Oréal Professionnel Paris\" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Loreal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", \"Walt Disney World\" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disney"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Match against the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cleaned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values you get back, not the display name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is matched case-insensitively, and the wildcard characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_37","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The brand's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must match exactly unless you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exact=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"offset","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where to start in the results. Add your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_38","description":"How many brands to return per page."},{"name":"exact","in":"query","schemaId":"schema_39","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true (the default), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match a brand's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exactly. Set to false to match part of the brand's normalised "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cleaned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name instead, which is not the same as its display name."},"children":[]}]}]}]}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1brands~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/brands/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_37"},{"name":"offset","in":"query","required":false,"schemaId":"schema_30"},{"name":"limit","in":"query","required":false,"schemaId":"schema_38"},{"name":"exact","in":"query","required":false,"schemaId":"schema_39"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/brands/","href":"dictionary/public_v1_discovery_classifier_brands_list","openApiOperationId":"public_v1_discovery_classifier_brands_list","summary":"Brands"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1brands~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_brands_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_yt_topics_list","name":"Youtube Topics","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1yt-topics~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Youtube Topics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a hierarchical list of YouTube topic categories and their subtopics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns YouTube topic categories and their subtopics. When using YouTube Discovery, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_topic_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for finding creators in particular content verticals or subject areas."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/yt-topics/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/yt-topics/","href":"dictionary/public_v1_discovery_classifier_yt_topics_list","openApiOperationId":"public_v1_discovery_classifier_yt_topics_list","summary":"Youtube Topics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1yt-topics~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_yt_topics_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_games_list","name":"Twitch Games","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1games~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Twitch Games","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/games/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/games/","href":"dictionary/public_v1_discovery_classifier_games_list","openApiOperationId":"public_v1_discovery_classifier_games_list","summary":"Twitch Games"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1games~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_games_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_audience_brand_categories_list","name":"Audience Brand Categories","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-brand-categories~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience Brand Categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_35","description":"Search string to filter results"},{"name":"offset","in":"query","schemaId":"schema_32","description":"Cursor offset for pagination"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-brand-categories~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/audience-brand-categories/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"offset","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/audience-brand-categories/","href":"dictionary/public_v1_discovery_classifier_audience_brand_categories_list","openApiOperationId":"public_v1_discovery_classifier_audience_brand_categories_list","summary":"Audience Brand Categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-brand-categories~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_audience_brand_categories_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_audience_brand_names_list","name":"Audience Brand Names","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-brand-names~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience Brand Names","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_35","description":"Search string to filter results"},{"name":"offset","in":"query","schemaId":"schema_32","description":"Cursor offset for pagination"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-brand-names~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/audience-brand-names/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"offset","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/audience-brand-names/","href":"dictionary/public_v1_discovery_classifier_audience_brand_names_list","openApiOperationId":"public_v1_discovery_classifier_audience_brand_names_list","summary":"Audience Brand Names"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-brand-names~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_audience_brand_names_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_audience_interests_list","name":"Audience Interests","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-interests~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience Interests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_35","description":"Search string to filter results"},{"name":"offset","in":"query","schemaId":"schema_32","description":"Cursor offset for pagination"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-interests~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/audience-interests/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"offset","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/audience-interests/","href":"dictionary/public_v1_discovery_classifier_audience_interests_list","openApiOperationId":"public_v1_discovery_classifier_audience_interests_list","summary":"Audience Interests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-interests~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_audience_interests_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_discovery_classifier_audience_locations_list","name":"Audience Locations","isWebhook":false,"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-locations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits. This endpoint does not deduct credits."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_35","description":"Search string to filter results"},{"name":"offset","in":"query","schemaId":"schema_32","description":"Cursor offset for pagination"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-locations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/discovery/classifier/audience-locations/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"offset","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/discovery/classifier/audience-locations/","href":"dictionary/public_v1_discovery_classifier_audience_locations_list","openApiOperationId":"public_v1_discovery_classifier_audience_locations_list","summary":"Audience Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1discovery~1classifier~1audience-locations~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionary/public_v1_discovery_classifier_audience_locations_list"}],"panels":[]}]},"httpPath":"/public/v1/discovery/classifier/audience-locations/"}],"content":{"contentType":"group","meta":{"name":"Dictionary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dictionary","showPageActions":true},{"nodeType":"markdoc","content":"Provides the complete set of supported filter values used by the Discovery and Similar Creators endpoints.\n\nThese endpoints return all valid, platform-specific values (such as languages, locations, brands, YouTube topics, Twitch games, audience brand categories, audience brand names, audience interests, and audience locations) that can be used when constructing discovery queries.\n\nClients should retrieve dictionary values programmatically to ensure only supported values are sent in requests. Available values may vary by platform and can evolve over time."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/discovery/classifier/languages/","summary":"Languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_languages_list","deprecated":false},{"title":"/public/v1/discovery/classifier/locations/{platform}/","summary":"Platform Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_locations_retrieve","deprecated":false},{"title":"/public/v1/discovery/classifier/brands/","summary":"Brands","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_brands_list","deprecated":false},{"title":"/public/v1/discovery/classifier/yt-topics/","summary":"Youtube Topics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_yt_topics_list","deprecated":false},{"title":"/public/v1/discovery/classifier/games/","summary":"Twitch Games","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_games_list","deprecated":false},{"title":"/public/v1/discovery/classifier/audience-brand-categories/","summary":"Audience Brand Categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_audience_brand_categories_list","deprecated":false},{"title":"/public/v1/discovery/classifier/audience-brand-names/","summary":"Audience Brand Names","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_audience_brand_names_list","deprecated":false},{"title":"/public/v1/discovery/classifier/audience-interests/","summary":"Audience Interests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_audience_interests_list","deprecated":false},{"title":"/public/v1/discovery/classifier/audience-locations/","summary":"Audience Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionary/public_v1_discovery_classifier_audience_locations_list","deprecated":false}]}]}]}]}},{"type":"separator","label":"Creator Enrichment","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_socials_create","name":"Connected Socials","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1socials~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connected Socials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover all verified social accounts connected to a creator, given a seed platform and handle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an array of verified connected social accounts across platforms, including platform name, username, and follower count for each connected account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports 6 seed platforms: Instagram, YouTube, TikTok, OnlyFans, Twitter, and Twitch."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.5 credits per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"connected-socials"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectedSocialsQuery"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ConnectedSocialsQuery"},"multipart/form-data":{"schemaId":"components/schemas/ConnectedSocialsQuery"}},"schemaId":"components/schemas/ConnectedSocialsQuery","pointer":"/paths/~1public~1v1~1creators~1socials~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/socials/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectedSocialsQuery"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ConnectedSocialsQuery"},"multipart/form-data":{"schemaId":"components/schemas/ConnectedSocialsQuery"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/socials/","href":"connected-socials/public_v1_creators_socials_create","openApiOperationId":"public_v1_creators_socials_create","summary":"Connected Socials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/ConnectedSocialsQuery","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectedSocialsQuery"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/ConnectedSocialsQuery"},"multipart/form-data":{"schemaId":"components/schemas/ConnectedSocialsQuery"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedSocialsResponse"}},"schemaId":"components/schemas/ConnectedSocialsResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1socials~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectedSocialsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedSocialsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-socials/public_v1_creators_socials_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/socials/"}],"content":{"contentType":"group","meta":{"name":"Connected Socials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connected Socials","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/socials/","summary":"Connected Socials","prefix":{"name":"post","color":"post"},"badges":[],"link":"/connected-socials/public_v1_creators_socials_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_enrich_handle_full_create","name":"Enrich by handle full","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1full~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle full","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform comprehensive enrichment of a creator profile using their social media handle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns complete profile data including cross-platform presence, engagement analytics, follower growth metrics, content performance data, monetization indicators, niche classification, hashtags, income estimates, and optional lookalike creator recommendations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Instagram, YouTube, TikTok, OnlyFans, Twitter, Snapchat, Discord, Pinterest, Facebook, LinkedIn, and Twitch platforms."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional email requirement and lookalike inclusion settings available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Need only part of this? Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for identity and contact fields (0.2 credits) or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-analytics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle analytics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for performance data (0.8 credits)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 credit per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"handle-full"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichFullHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichFullHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichFullHandleRequest"}},"schemaId":"components/schemas/EnrichFullHandleRequest","pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1full~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/enrich/handle/full/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrichFullHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichFullHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichFullHandleRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/enrich/handle/full/","href":"enrich-by-handle-full/public_v1_creators_enrich_handle_full_create","openApiOperationId":"public_v1_creators_enrich_handle_full_create","summary":"Enrich by handle full"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/EnrichFullHandleRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichFullHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichFullHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichFullHandleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleFullPlatformResponse"}},"schemaId":"components/schemas/HandleFullPlatformResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1full~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HandleFullPlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleFullPlatformResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrich-by-handle-full/public_v1_creators_enrich_handle_full_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/enrich/handle/full/"}],"content":{"contentType":"group","meta":{"name":"Enrich by handle full"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle full","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/enrich/handle/full/","summary":"Enrich by handle full","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrich-by-handle-full/public_v1_creators_enrich_handle_full_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_enrich_handle_profile_create","name":"Enrich by handle profile","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1profile~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich a creator profile with identity, contact, and vetting data using their social media handle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the identity/contact/vetting subset of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-full"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle full"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response: validated email, name, gender, location, cross-platform presence, and core profile/vetting fields (verification, account type, follower/media counts, bio, niche classification)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No deeper performance data — no growth curves, medians, income estimates or audience demographics. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-analytics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle analytics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those. Instagram, YouTube, TikTok, OnlyFans and Twitter do include a headline "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"engagement_percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Works with all 11 platforms: Instagram, YouTube, TikTok, OnlyFans, Twitter, Twitch, Snapchat, Discord, Pinterest, Facebook and LinkedIn. Facebook, Pinterest, Snapchat, Discord and LinkedIn carry basic identity data only — there is no analytics counterpart for them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional email requirement setting available."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.2 credits per successful request. If no data is returned, no credits are deducted. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"must_have"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no valid email is found, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"handle-profile"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichProfileHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichProfileHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichProfileHandleRequest"}},"schemaId":"components/schemas/EnrichProfileHandleRequest","pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1profile~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/enrich/handle/profile/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrichProfileHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichProfileHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichProfileHandleRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/enrich/handle/profile/","href":"enrich-by-handle-profile/public_v1_creators_enrich_handle_profile_create","openApiOperationId":"public_v1_creators_enrich_handle_profile_create","summary":"Enrich by handle profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/EnrichProfileHandleRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichProfileHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichProfileHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichProfileHandleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleProfilePlatformResponse"}},"schemaId":"components/schemas/HandleProfilePlatformResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1profile~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HandleProfilePlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleProfilePlatformResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrich-by-handle-profile/public_v1_creators_enrich_handle_profile_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/enrich/handle/profile/"}],"content":{"contentType":"group","meta":{"name":"Enrich by handle profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle profile","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/enrich/handle/profile/","summary":"Enrich by handle profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrich-by-handle-profile/public_v1_creators_enrich_handle_profile_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_enrich_handle_analytics_create","name":"Enrich by handle analytics","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1analytics~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle analytics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich a creator profile with performance analytics using their social media handle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the performance-analytics subset of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-full"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle full"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response: engagement/growth detail, posting frequency, income estimates, audience data, and optional lookalike creator recommendations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No identity or contact fields, including email. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Works with Instagram, YouTube, TikTok, OnlyFans, Twitter and Twitch."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Facebook, Pinterest, Snapchat, Discord and LinkedIn have no analytics data and are rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/enrich-by-handle-profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enrich by handle profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional lookalike inclusion setting available."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.8 credits per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"handle-analytics"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"}},"schemaId":"components/schemas/EnrichAnalyticsHandleRequest","pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1analytics~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/enrich/handle/analytics/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/enrich/handle/analytics/","href":"enrich-by-handle-analytics/public_v1_creators_enrich_handle_analytics_create","openApiOperationId":"public_v1_creators_enrich_handle_analytics_create","summary":"Enrich by handle analytics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/EnrichAnalyticsHandleRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichAnalyticsHandleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleAnalyticsPlatformResponse"}},"schemaId":"components/schemas/HandleAnalyticsPlatformResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1analytics~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HandleAnalyticsPlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleAnalyticsPlatformResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrich-by-handle-analytics/public_v1_creators_enrich_handle_analytics_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/enrich/handle/analytics/"}],"content":{"contentType":"group","meta":{"name":"Enrich by handle analytics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle analytics","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/enrich/handle/analytics/","summary":"Enrich by handle analytics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrich-by-handle-analytics/public_v1_creators_enrich_handle_analytics_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_enrich_handle_raw_create","name":"Enrich by handle raw","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1raw~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle raw","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve raw platform data for a creator profile using their social media handle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns unprocessed platform-specific data directly from the source, including basic profile information, post data, media counts, and platform-native metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides the foundational data layer before any additional processing or enrichment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Instagram, YouTube, TikTok, OnlyFans, Twitter, Snapchat, Discord, Pinterest, Facebook, and LinkedIn platforms."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.03 credits per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"handle-raw"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichRawHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichRawHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichRawHandleRequest"}},"schemaId":"components/schemas/EnrichRawHandleRequest","pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1raw~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/enrich/handle/raw/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrichRawHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichRawHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichRawHandleRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/enrich/handle/raw/","href":"enrich-by-handle-raw/public_v1_creators_enrich_handle_raw_create","openApiOperationId":"public_v1_creators_enrich_handle_raw_create","summary":"Enrich by handle raw"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/EnrichRawHandleRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichRawHandleRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichRawHandleRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichRawHandleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleRawPlatformResponse"}},"schemaId":"components/schemas/HandleRawPlatformResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1enrich~1handle~1raw~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HandleRawPlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleRawPlatformResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrich-by-handle-raw/public_v1_creators_enrich_handle_raw_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/enrich/handle/raw/"}],"content":{"contentType":"group","meta":{"name":"Enrich by handle raw"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by handle raw","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/enrich/handle/raw/","summary":"Enrich by handle raw","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrich-by-handle-raw/public_v1_creators_enrich_handle_raw_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_enrich_email_create","name":"Enrich by email","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1enrich~1email~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform basic enrichment of creator profiles using an email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the creator's single strongest platform — the one with the highest follower count — with essential profile data: basic social media presence, contact details, and platform account identifiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ideal for quick profile lookups and initial creator identification across Instagram, YouTube, TikTok, Twitter, Twitch, and OnlyFans."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.05 credits per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"email"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichBasicEmailRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichBasicEmailRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichBasicEmailRequest"}},"schemaId":"components/schemas/EnrichBasicEmailRequest","pointer":"/paths/~1public~1v1~1creators~1enrich~1email~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/enrich/email/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrichBasicEmailRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichBasicEmailRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichBasicEmailRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/enrich/email/","href":"enrich-by-email/public_v1_creators_enrich_email_create","openApiOperationId":"public_v1_creators_enrich_email_create","summary":"Enrich by email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/EnrichBasicEmailRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrichBasicEmailRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EnrichBasicEmailRequest"},"multipart/form-data":{"schemaId":"components/schemas/EnrichBasicEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleEmailResponse"}},"schemaId":"components/schemas/HandleEmailResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1enrich~1email~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HandleEmailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HandleEmailResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enrich-by-email/public_v1_creators_enrich_email_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/enrich/email/"}],"content":{"contentType":"group","meta":{"name":"Enrich by email"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich by email","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/enrich/email/","summary":"Enrich by email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrich-by-email/public_v1_creators_enrich_email_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_enrichment_batch_create","name":"Create Batch Enrichment","isWebhook":false,"pointer":"/paths/~1public~1v1~1enrichment~1batch~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Batch Enrichment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a batch enrichment job by uploading a CSV."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file (one column: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"handle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choose the enrichment mode (handle: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"raw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", email: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check status and download results"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": CSV (max 10MB)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mode fields depend on whether you’re enriching by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"handle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits are deducted "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per successfully enriched record"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit rate follows the corresponding single-enrichment pricing (handle "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"raw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or email enrichment)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no data is returned for a record, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are deducted for that record"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking completion"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /public/v1/enrichment/batch/{batch_id}/status/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" every 30–60 seconds until the job finishes. Status values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — waiting to start"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — actively enriching records"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — all records done; download results via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /public/v1/enrichment/batch/{batch_id}/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — job failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused_insufficient_credits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — top up credits and call the resume endpoint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is polling-based. There are no webhooks or push notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"batch-create"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/BatchEnrichmentInput"}},"schemaId":"components/schemas/BatchEnrichmentInput","pointer":"/paths/~1public~1v1~1enrichment~1batch~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/enrichment/batch/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/BatchEnrichmentInput"}},"responseCodes":["200","400","401","403","409","422","429"],"pointer":"/public/v1/enrichment/batch/","href":"batch-enrichment/public_v1_enrichment_batch_create","openApiOperationId":"public_v1_enrichment_batch_create","summary":"Create Batch Enrichment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/BatchEnrichmentInput","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/BatchEnrichmentInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchEnrichmentResponse"}},"schemaId":"components/schemas/BatchEnrichmentResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict — total active-batch capacity reached."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1/post/responses/409/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchEnrichmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchEnrichmentResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1/post/responses/409/content/application~1json/example"]}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-enrichment/public_v1_enrichment_batch_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_enrichment_batch_status_retrieve","name":"Get Batch Enrichment Status","isWebhook":false,"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Batch Enrichment Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the current processing status of a batch enrichment job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state (e.g., queued/running/completed/failed)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Progress indicators (processed vs remaining), when available"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (status only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"batch-status"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batch_id","in":"path","schemaId":"schema_35","description":"Unique batch identifier returned when creating the enrichment batch","required":true}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/enrichment/batch/{batch_id}/status/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"batch_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/enrichment/batch/{batch_id}/status/","href":"batch-enrichment/public_v1_enrichment_batch_status_retrieve","openApiOperationId":"public_v1_enrichment_batch_status_retrieve","summary":"Get Batch Enrichment Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchEnrichmentStatusResponse"}},"schemaId":"components/schemas/BatchEnrichmentStatusResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Batch not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchEnrichmentStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchEnrichmentStatusResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses/404/content/application~1json/example"]}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-enrichment/public_v1_enrichment_batch_status_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_enrichment_batch_resume_create","name":"Resume Batch Enrichment","isWebhook":false,"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume Batch Enrichment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume a paused or interrupted batch enrichment job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a batch was paused or failed mid-run and needs to continue processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to resume (credits apply only to successfully enriched records)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"batch-resume"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batch_id","in":"path","schemaId":"schema_35","description":"Unique batch identifier returned when creating the enrichment batch","required":true}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/enrichment/batch/{batch_id}/resume/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"batch_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/enrichment/batch/{batch_id}/resume/","href":"batch-enrichment/public_v1_enrichment_batch_resume_create","openApiOperationId":"public_v1_enrichment_batch_resume_create","summary":"Resume Batch Enrichment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch resumed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — batch is not in a resumable state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — not enough credits to resume the remaining work."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Batch not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/404/content/application~1json/example"]}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-enrichment/public_v1_enrichment_batch_resume_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_enrichment_batch_download_retrieve","name":"Download Batch Enrichment CSV (Recommended)","isWebhook":false,"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Batch Enrichment CSV (Recommended)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the enriched CSV dataset via a temporary presigned URL. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the recommended endpoint for downloading CSV results."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compared to the direct download endpoint, this returns a short-lived URL that lets you download the file directly from storage — faster and more reliable for large files."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results file must have been generated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for JSON output, use the direct download endpoint ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /public/v1/enrichment/batch/{batch_id}/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?format=json"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — temporary URL (valid for a limited time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — seconds until the URL expires"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — expiration timestamp"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every error response shares the canonical shape "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"error\": <message>, \"error_code\": <slug>, ...}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Branch programmatically on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than parsing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"batch_not_ready\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — batch not completed yet; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the body"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"no_results\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — batch finished but produced no rows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"results_not_ready\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — batch finished but the results file is still being assembled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"batch_not_found\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — invalid batch ID or batch does not belong to client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503 Service Unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"feature_disabled\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — presigned-URL downloads are currently disabled; use the direct download endpoint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (download only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"batch-download-csv"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batch_id","in":"path","schemaId":"schema_35","description":"Unique batch identifier returned when creating the enrichment batch","required":true}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/enrichment/batch/{batch_id}/download/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"batch_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429","503"],"pointer":"/public/v1/enrichment/batch/{batch_id}/download/","href":"batch-enrichment/public_v1_enrichment_batch_download_retrieve","openApiOperationId":"public_v1_enrichment_batch_download_retrieve","summary":"Download Batch Enrichment CSV (Recommended)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchEnrichmentDownloadURL"}},"schemaId":"components/schemas/BatchEnrichmentDownloadURL"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — batch state prevents download."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Batch not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — the presigned-URL feature is currently disabled."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchEnrichmentDownloadURL","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchEnrichmentDownloadURL"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/404/content/application~1json/example"]}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-enrichment/public_v1_enrichment_batch_download_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_enrichment_batch_retrieve","name":"Download Batch Enrichment Results (Direct)","isWebhook":false,"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Batch Enrichment Results (Direct)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the final enriched dataset after processing is complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CSV downloads, consider using the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /public/v1/enrichment/batch/{batch_id}/download/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead — it returns a presigned URL for faster, more reliable downloads. Use this endpoint if you need "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" output or as a fallback."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results file must have been generated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output formats"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) — omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?format=csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?format=json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive a JSON array where each object has:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"input_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the original input (handle or email)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — enrichment status for that record"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enrichment_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the enriched creator data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every error response shares the canonical shape "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"error\": <message>, \"error_code\": <slug>, ...}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Branch programmatically on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than parsing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"batch_not_ready\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — batch not completed yet; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the body"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"no_results\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — batch finished but produced no rows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"results_not_ready\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — batch finished but the results file is still being assembled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"batch_not_found\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — invalid batch ID or batch does not belong to client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500 Server Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: \"service_error\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — results file could not be retrieved from storage; safe to retry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (download only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"batch-download"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batch_id","in":"path","schemaId":"schema_35","description":"Unique batch identifier returned when creating the enrichment batch","required":true}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"format","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output format. Omit or pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) to receive a CSV file. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive a JSON array of objects with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"input_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enrichment_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"example":"csv"}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/enrichment/batch/{batch_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"batch_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[{"name":"format","in":"query","required":false,"example":"csv","schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/public/v1/enrichment/batch/{batch_id}/","href":"batch-enrichment/public_v1_enrichment_batch_retrieve","openApiOperationId":"public_v1_enrichment_batch_retrieve","summary":"Download Batch Enrichment Results (Direct)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV or JSON file with enriched results depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv","application/json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_43"},"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_43"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — batch state prevents download."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Batch not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/404/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Server Error — results file could not be retrieved from storage."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["text/csv","application/json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_43"},"application/json":{"schemaId":"schema_44"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/404/content/application~1json/example"]}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-enrichment/public_v1_enrichment_batch_retrieve"}],"panels":[]}]},"httpPath":"/public/v1/enrichment/batch/{batch_id}/"}],"content":{"contentType":"group","meta":{"name":"Batch enrichment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch enrichment","showPageActions":true},{"nodeType":"markdoc","content":"Bulk enrichment jobs: create, check status, resume, and download results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/enrichment/batch/","summary":"Create Batch Enrichment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-enrichment/public_v1_enrichment_batch_create","deprecated":false},{"title":"/public/v1/enrichment/batch/{batch_id}/status/","summary":"Get Batch Enrichment Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-enrichment/public_v1_enrichment_batch_status_retrieve","deprecated":false},{"title":"/public/v1/enrichment/batch/{batch_id}/resume/","summary":"Resume Batch Enrichment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-enrichment/public_v1_enrichment_batch_resume_create","deprecated":false},{"title":"/public/v1/enrichment/batch/{batch_id}/download/","summary":"Download Batch Enrichment CSV (Recommended)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-enrichment/public_v1_enrichment_batch_download_retrieve","deprecated":false},{"title":"/public/v1/enrichment/batch/{batch_id}/","summary":"Download Batch Enrichment Results (Direct)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-enrichment/public_v1_enrichment_batch_retrieve","deprecated":false}]}]}]}]}},{"type":"separator","label":"Creator Monitoring","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_list","name":"List subscriptions","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return a paginated list of the client's social-listening subscriptions, optionally filtered by type. The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" block with aggregate counts. Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_32","description":"Page number (1-based) for the paginated result."},{"name":"page_size","in":"query","schemaId":"schema_32","description":"Number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/subscription/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_32"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/social/listening/subscription/","href":"subscriptions/public_v1_social_listening_subscription_list","openApiOperationId":"public_v1_social_listening_subscription_list","summary":"List subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionListResponse"}},"schemaId":"components/schemas/SubscriptionListResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_create","name":"Create subscription","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreateSubscriptionInput"},"multipart/form-data":{"schemaId":"components/schemas/CreateSubscriptionInput"}},"schemaId":"components/schemas/CreateSubscriptionInput","pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/social/listening/subscription/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreateSubscriptionInput"},"multipart/form-data":{"schemaId":"components/schemas/CreateSubscriptionInput"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/public/v1/social/listening/subscription/","href":"subscriptions/public_v1_social_listening_subscription_create","openApiOperationId":"public_v1_social_listening_subscription_create","summary":"Create subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/CreateSubscriptionInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreateSubscriptionInput"},"multipart/form-data":{"schemaId":"components/schemas/CreateSubscriptionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}},"schemaId":"components/schemas/SubscriptionResponse"},{"code":"400","description":"Validation error or limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_retrieve","name":"Get subscription","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/subscription/{subscription_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/","href":"subscriptions/public_v1_social_listening_subscription_retrieve","openApiOperationId":"public_v1_social_listening_subscription_retrieve","summary":"Get subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}},"schemaId":"components/schemas/SubscriptionResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_partial_update","name":"Update subscription","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/UpdateSubscriptionInput"},"multipart/form-data":{"schemaId":"components/schemas/UpdateSubscriptionInput"}},"schemaId":"components/schemas/UpdateSubscriptionInput","pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/social/listening/subscription/{subscription_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/UpdateSubscriptionInput"},"multipart/form-data":{"schemaId":"components/schemas/UpdateSubscriptionInput"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/","href":"subscriptions/public_v1_social_listening_subscription_partial_update","openApiOperationId":"public_v1_social_listening_subscription_partial_update","summary":"Update subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/UpdateSubscriptionInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/UpdateSubscriptionInput"},"multipart/form-data":{"schemaId":"components/schemas/UpdateSubscriptionInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}},"schemaId":"components/schemas/SubscriptionResponse"},{"code":"400","description":"Validation error, insufficient credits, or campaign-managed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_partial_update"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_delete","name":"Delete subscription","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a webhook subscription and all its related links. Campaign-backed subscriptions are rejected; archive the campaign instead ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /campaign/<pk>/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/social/listening/subscription/{subscription_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/","href":"subscriptions/public_v1_social_listening_subscription_delete","openApiOperationId":"public_v1_social_listening_subscription_delete","summary":"Delete subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":"Campaign-managed subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_delete"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_creators_retrieve","name":"List subscription creators","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscription creators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return a paginated list of creators in the subscription with follower and source metadata, optionally filtered by handle via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_32","description":"Page number (1-based) for the paginated result."},{"name":"search","in":"query","schemaId":"schema_35","description":"Filter creators by handle (case-insensitive substring match)."},{"name":"page_size","in":"query","schemaId":"schema_45","description":"Number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/subscription/{subscription_id}/creators/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_32"},{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/creators/","href":"subscriptions/public_v1_social_listening_subscription_creators_retrieve","openApiOperationId":"public_v1_social_listening_subscription_creators_retrieve","summary":"List subscription creators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCreatorListPage"}},"schemaId":"components/schemas/SubscriptionCreatorListPage"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionCreatorListPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCreatorListPage"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_creators_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_creators_create","name":"Add subscription creators","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add subscription creators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add creators to the subscription from handles, discovery lists, and/or a CSV file (a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"handle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column is required). Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"}},"schemaId":"components/schemas/AddSubscriptionCreatorsInput","pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/social/listening/subscription/{subscription_id}/creators/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"}},"responseCodes":["201","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/creators/","href":"subscriptions/public_v1_social_listening_subscription_creators_create","openApiOperationId":"public_v1_social_listening_subscription_creators_create","summary":"Add subscription creators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/AddSubscriptionCreatorsInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/AddSubscriptionCreatorsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Creators added","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":"Validation error or insufficient credits","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1creators~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_creators_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_details_retrieve","name":"Get subscription stats","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1details~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscription stats","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return aggregated delivery stats for a campaign subscription. Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1details~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/subscription/{subscription_id}/details/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/details/","href":"subscriptions/public_v1_social_listening_subscription_details_retrieve","openApiOperationId":"public_v1_social_listening_subscription_details_retrieve","summary":"Get subscription stats"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Stats counters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1details~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_details_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_subscription_details_export_retrieve","name":"Export subscription stats (CSV)","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1details~1export~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export subscription stats (CSV)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1details~1export~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/subscription/{subscription_id}/details/export/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/subscription/{subscription_id}/details/export/","href":"subscriptions/public_v1_social_listening_subscription_details_export_retrieve","openApiOperationId":"public_v1_social_listening_subscription_details_export_retrieve","summary":"Export subscription stats (CSV)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CSV file download","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_46"}},"schemaId":"schema_46"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1subscription~1{subscription_id}~1details~1export~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_46"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/public_v1_social_listening_subscription_details_export_retrieve"}],"panels":[]}]},"httpPath":"/public/v1/social/listening/subscription/{subscription_id}/details/export/"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and manage social-listening subscriptions — the monitoring configs that watch a set of creators (by handle or discovery list) and deliver matching activity to your notify endpoints (e.g. a webhook URL). Covers listing, retrieving, updating and deleting subscriptions, and managing their creators, details and exports."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/social/listening/subscription/","summary":"List subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_list","deprecated":false},{"title":"/public/v1/social/listening/subscription/","summary":"Create subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_create","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/","summary":"Get subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_retrieve","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/","summary":"Update subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_partial_update","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/","summary":"Delete subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_delete","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/creators/","summary":"List subscription creators","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_creators_retrieve","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/creators/","summary":"Add subscription creators","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_creators_create","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/details/","summary":"Get subscription stats","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_details_retrieve","deprecated":false},{"title":"/public/v1/social/listening/subscription/{subscription_id}/details/export/","summary":"Export subscription stats (CSV)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/public_v1_social_listening_subscription_details_export_retrieve","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_list","name":"List campaigns","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List campaigns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return a paginated list of the client's campaigns, optionally filtered by status and search, with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" summary. Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_32","description":"Page number (1-based) for the paginated result."},{"name":"status","in":"query","schemaId":"schema_35","description":"Filter campaigns by lifecycle status. Omit to return all statuses."},{"name":"search","in":"query","schemaId":"schema_35","description":"Filter campaigns by name (case-insensitive substring match)."},{"name":"ordering","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field; prefix with '-' for descending. Defaults to newest first ('-created_at')."},"children":[]}]}]}]},{"name":"page_size","in":"query","schemaId":"schema_45","description":"Number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_32"},{"name":"status","in":"query","required":false,"schemaId":"schema_35"},{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"ordering","in":"query","required":false,"schemaId":"schema_47"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/social/listening/campaign/","href":"campaigns/public_v1_social_listening_campaign_list","openApiOperationId":"public_v1_social_listening_campaign_list","summary":"List campaigns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignListPage"}},"schemaId":"components/schemas/CampaignListPage"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CampaignListPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignListPage"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_create","name":"Create campaign","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCampaignInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreateCampaignInput"},"multipart/form-data":{"schemaId":"components/schemas/CreateCampaignInput"}},"schemaId":"components/schemas/CreateCampaignInput","pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/social/listening/campaign/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCampaignInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreateCampaignInput"},"multipart/form-data":{"schemaId":"components/schemas/CreateCampaignInput"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/public/v1/social/listening/campaign/","href":"campaigns/public_v1_social_listening_campaign_create","openApiOperationId":"public_v1_social_listening_campaign_create","summary":"Create campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/CreateCampaignInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCampaignInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreateCampaignInput"},"multipart/form-data":{"schemaId":"components/schemas/CreateCampaignInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignResponse"}},"schemaId":"components/schemas/CampaignResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CampaignResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_retrieve","name":"Get campaign","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/{campaign_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/","href":"campaigns/public_v1_social_listening_campaign_retrieve","openApiOperationId":"public_v1_social_listening_campaign_retrieve","summary":"Get campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignResponse"}},"schemaId":"components/schemas/CampaignResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CampaignResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_partial_update","name":"Update campaign","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a campaign's status, budget and/or content types. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCampaignInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/UpdateCampaignInput"},"multipart/form-data":{"schemaId":"components/schemas/UpdateCampaignInput"}},"schemaId":"components/schemas/UpdateCampaignInput","pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/social/listening/campaign/{campaign_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCampaignInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/UpdateCampaignInput"},"multipart/form-data":{"schemaId":"components/schemas/UpdateCampaignInput"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/","href":"campaigns/public_v1_social_listening_campaign_partial_update","openApiOperationId":"public_v1_social_listening_campaign_partial_update","summary":"Update campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/UpdateCampaignInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCampaignInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/UpdateCampaignInput"},"multipart/form-data":{"schemaId":"components/schemas/UpdateCampaignInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignResponse"}},"schemaId":"components/schemas/CampaignResponse"},{"code":"400","description":"Validation error, insufficient credits, or non-editable campaign status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CampaignResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_partial_update"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_delete","name":"Archive campaign","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/social/listening/campaign/{campaign_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/","href":"campaigns/public_v1_social_listening_campaign_delete","openApiOperationId":"public_v1_social_listening_campaign_delete","summary":"Archive campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Campaign archived","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_delete"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_creators_retrieve","name":"List campaign creators","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List campaign creators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_first_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_32","description":"Page number (1-based) for the paginated result."},{"name":"platform","in":"query","schemaId":"schema_35","description":"The creator's social media platform."},{"name":"search","in":"query","schemaId":"schema_35","description":"Filter creators by handle or display name (case-insensitive substring match)."},{"name":"ordering","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field; prefix with '-' for descending. Defaults to attachment order ('added_at')."},"children":[]}]}]}]},{"name":"page_size","in":"query","schemaId":"schema_45","description":"Number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/{campaign_id}/creators/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_32"},{"name":"platform","in":"query","required":false,"schemaId":"schema_35"},{"name":"search","in":"query","required":false,"schemaId":"schema_35"},{"name":"ordering","in":"query","required":false,"schemaId":"schema_48"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/creators/","href":"campaigns/public_v1_social_listening_campaign_creators_retrieve","openApiOperationId":"public_v1_social_listening_campaign_creators_retrieve","summary":"List campaign creators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignCreatorListPage"}},"schemaId":"components/schemas/CampaignCreatorListPage"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CampaignCreatorListPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignCreatorListPage"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_creators_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_creators_create","name":"Add campaign creators","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add campaign creators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCampaignCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AddCampaignCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/AddCampaignCreatorsInput"}},"schemaId":"components/schemas/AddCampaignCreatorsInput","pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/social/listening/campaign/{campaign_id}/creators/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddCampaignCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AddCampaignCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/AddCampaignCreatorsInput"}},"responseCodes":["201","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/creators/","href":"campaigns/public_v1_social_listening_campaign_creators_create","openApiOperationId":"public_v1_social_listening_campaign_creators_create","summary":"Add campaign creators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/AddCampaignCreatorsInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCampaignCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AddCampaignCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/AddCampaignCreatorsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Creators added","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":"Validation error or insufficient credits","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_creators_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_creators_delete","name":"Remove campaign creators","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove campaign creators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove creators from the campaign by creator id (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"}},"schemaId":"components/schemas/RemoveCampaignCreatorsInput","pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/social/listening/campaign/{campaign_id}/creators/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/creators/","href":"campaigns/public_v1_social_listening_campaign_creators_delete","openApiOperationId":"public_v1_social_listening_campaign_creators_delete","summary":"Remove campaign creators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/RemoveCampaignCreatorsInput","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"},"multipart/form-data":{"schemaId":"components/schemas/RemoveCampaignCreatorsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Creators removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1creators~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_creators_delete"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_overview_retrieve","name":"Get campaign overview","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1overview~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign overview","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the aggregated overview metrics for a single campaign, including total posts, views, engagement, EMV, and trends. Optionally filter by platform using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1overview~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"platform","in":"query","schemaId":"schema_35","description":"The creator's social media platform."}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1overview~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/{campaign_id}/overview/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[{"name":"platform","in":"query","required":false,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/overview/","href":"campaigns/public_v1_social_listening_campaign_overview_retrieve","openApiOperationId":"public_v1_social_listening_campaign_overview_retrieve","summary":"Get campaign overview"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Campaign overview metrics","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1overview~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_overview_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_content_retrieve","name":"List campaign content","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1content~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List campaign content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return a paginated feed of the campaign's posts (one per detected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag for the highest-ER posts. Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1content~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_32","description":"Page number (1-based) for the paginated result."},{"name":"platform","in":"query","schemaId":"schema_35","description":"The creator's social media platform."},{"name":"ordering","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field; prefix with '-' for descending. Defaults to most recent first ('-posted_at')."},"children":[]}]}]}]},{"name":"page_size","in":"query","schemaId":"schema_45","description":"Number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1content~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/{campaign_id}/content/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_32"},{"name":"platform","in":"query","required":false,"schemaId":"schema_35"},{"name":"ordering","in":"query","required":false,"schemaId":"schema_49"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/content/","href":"campaigns/public_v1_social_listening_campaign_content_retrieve","openApiOperationId":"public_v1_social_listening_campaign_content_retrieve","summary":"List campaign content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignContentListPage"}},"schemaId":"components/schemas/CampaignContentListPage"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1content~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CampaignContentListPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignContentListPage"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_content_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_report_retrieve","name":"Get campaign AI report","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign AI report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the campaign's most recent AI report. While the report is being generated its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty — poll until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Monitoring is billed per creator, per day — API calls are included in that price. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/{campaign_id}/report/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/report/","href":"campaigns/public_v1_social_listening_campaign_report_retrieve","openApiOperationId":"public_v1_social_listening_campaign_report_retrieve","summary":"Get campaign AI report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignReport"}},"schemaId":"components/schemas/CampaignReport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found, or no report generated yet","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CampaignReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignReport"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_report_retrieve"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_report_create","name":"Generate campaign AI report","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate campaign AI report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/social/listening/campaign/{campaign_id}/report/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["202","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/report/","href":"campaigns/public_v1_social_listening_campaign_report_create","openApiOperationId":"public_v1_social_listening_campaign_report_create","summary":"Generate campaign AI report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignReport"}},"schemaId":"components/schemas/CampaignReport"},{"code":"400","description":"Campaign has not started yet","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/CampaignReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CampaignReport"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_report_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_campaign_report_export_retrieve","name":"Export campaign report data (CSV)","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1export~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export campaign report data (CSV)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1export~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/campaign/{campaign_id}/report/export/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/campaign/{campaign_id}/report/export/","href":"campaigns/public_v1_social_listening_campaign_report_export_retrieve","openApiOperationId":"public_v1_social_listening_campaign_report_export_retrieve","summary":"Export campaign report data (CSV)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CSV file download","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_46"}},"schemaId":"schema_46"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1campaign~1{campaign_id}~1report~1export~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_46"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/public_v1_social_listening_campaign_report_export_retrieve"}],"panels":[]}]},"httpPath":"/public/v1/social/listening/campaign/{campaign_id}/report/export/"}],"content":{"contentType":"group","meta":{"name":"Campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Higher-level monitoring campaigns that provision and manage the backing per-platform webhook subscriptions for you, and expose aggregated delivery stats — for monitoring across platforms under a single construct."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/social/listening/campaign/","summary":"List campaigns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_list","deprecated":false},{"title":"/public/v1/social/listening/campaign/","summary":"Create campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_create","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/","summary":"Get campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_retrieve","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/","summary":"Update campaign","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_partial_update","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/","summary":"Archive campaign","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_delete","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/creators/","summary":"List campaign creators","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_creators_retrieve","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/creators/","summary":"Add campaign creators","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_creators_create","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/creators/","summary":"Remove campaign creators","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_creators_delete","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/overview/","summary":"Get campaign overview","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_overview_retrieve","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/content/","summary":"List campaign content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_content_retrieve","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/report/","summary":"Get campaign AI report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_report_retrieve","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/report/","summary":"Generate campaign AI report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_report_create","deprecated":false},{"title":"/public/v1/social/listening/campaign/{campaign_id}/report/export/","summary":"Export campaign report data (CSV)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/public_v1_social_listening_campaign_report_export_retrieve","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_events_list","name":"List events","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1events~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_32","description":"Page number (1-based) for the paginated result."},{"name":"subscription_id","in":"query","schemaId":"schema_32","description":"Return only events belonging to this subscription."},{"name":"event_type","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter events by type (e.g. 'new_post', 'bio_change')."},"children":[]}]}]}]},{"name":"creator","in":"query","schemaId":"schema_35","description":"Filter events by creator handle (exact match)."},{"name":"page_size","in":"query","schemaId":"schema_45","description":"Number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1public~1v1~1social~1listening~1events~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/events/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_32"},{"name":"subscription_id","in":"query","required":false,"schemaId":"schema_32"},{"name":"event_type","in":"query","required":false,"schemaId":"schema_35"},{"name":"creator","in":"query","required":false,"schemaId":"schema_35"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/social/listening/events/","href":"events/public_v1_social_listening_events_list","openApiOperationId":"public_v1_social_listening_events_list","summary":"List events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventListPage"}},"schemaId":"components/schemas/EventListPage"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1events~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventListPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventListPage"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/public_v1_social_listening_events_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_events_retrieve","name":"Get event","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1events~1{event_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event_id","in":"path","schemaId":"schema_32","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1public~1v1~1social~1listening~1events~1{event_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/events/{event_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"event_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/social/listening/events/{event_id}/","href":"events/public_v1_social_listening_events_retrieve","openApiOperationId":"public_v1_social_listening_events_retrieve","summary":"Get event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventDetail"}},"schemaId":"components/schemas/EventDetail"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Event not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1events~1{event_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventDetail"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/public_v1_social_listening_events_retrieve"}],"panels":[]}]},"httpPath":"/public/v1/social/listening/events/{event_id}/"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity detected on monitored creators — events such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bio_change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"follower_threshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — with the full payload and per-endpoint delivery history and status (pending / sending / sent / failed / retrying). List events or fetch a single event."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/social/listening/events/","summary":"List events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/public_v1_social_listening_events_list","deprecated":false},{"title":"/public/v1/social/listening/events/{event_id}/","summary":"Get event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/public_v1_social_listening_events_retrieve","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_social_listening_usage_list","name":"Get usage","isWebhook":false,"pointer":"/paths/~1public~1v1~1social~1listening~1usage~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get usage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/usage-limits#social-listening-monitoring"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage, pricing & limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/social/listening/usage/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/social/listening/usage/","href":"usage/public_v1_social_listening_usage_list","openApiOperationId":"public_v1_social_listening_usage_list","summary":"Get usage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage and limits","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1social~1listening~1usage~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/public_v1_social_listening_usage_list"}],"panels":[]}]},"httpPath":"/public/v1/social/listening/usage/"}],"content":{"contentType":"group","meta":{"name":"Usage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Usage","showPageActions":true},{"nodeType":"markdoc","content":"Current social-listening limits and active subscription counts for the account's scope, so a client can see how much of its monitoring quota is in use."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/social/listening/usage/","summary":"Get usage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usage/public_v1_social_listening_usage_list","deprecated":false}]}]}]}]}},{"type":"separator","label":"Creator Content","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_content_posts_create","name":"Creator Posts","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1content~1posts~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creator Posts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch recent posts for a creator on a given platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of recent posts with metadata including post ID, URL, caption, media URLs, timestamps, and engagement metrics (likes, comments, views, shares)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Instagram, TikTok, and YouTube platforms."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses cursor-based pagination via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fetching additional pages of results."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page sizes are platform-specific:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instagram"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — fixed at 12 posts per page (not configurable)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TikTok"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — default 30, max 35."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YouTube"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — default 30, max 50."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.03 credits per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"creator-posts"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatorPostsQuery"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreatorPostsQuery"},"multipart/form-data":{"schemaId":"components/schemas/CreatorPostsQuery"}},"schemaId":"components/schemas/CreatorPostsQuery","pointer":"/paths/~1public~1v1~1creators~1content~1posts~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/content/posts/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatorPostsQuery"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreatorPostsQuery"},"multipart/form-data":{"schemaId":"components/schemas/CreatorPostsQuery"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/content/posts/","href":"creator-posts/public_v1_creators_content_posts_create","openApiOperationId":"public_v1_creators_content_posts_create","summary":"Creator Posts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/CreatorPostsQuery","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatorPostsQuery"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreatorPostsQuery"},"multipart/form-data":{"schemaId":"components/schemas/CreatorPostsQuery"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatorPostsResponse"}},"schemaId":"components/schemas/CreatorPostsResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1content~1posts~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatorPostsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatorPostsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/creator-posts/public_v1_creators_content_posts_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/content/posts/"}],"content":{"contentType":"group","meta":{"name":"Creator Posts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creator Posts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/content/posts/","summary":"Creator Posts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/creator-posts/public_v1_creators_content_posts_create","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_creators_content_details_create","name":"Post Details","isWebhook":false,"pointer":"/paths/~1public~1v1~1creators~1content~1details~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve detailed information about specific creator content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you get"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Instagram, TikTok, and YouTube platforms."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns platform-specific content metadata and engagement data in a structured format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported content types per platform"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instagram"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transcript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audio"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TikTok"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transcript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audio"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YouTube"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transcript"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0.03 credits per successful request. If no data is returned, no credits are deducted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you have a specific post ID and need to go deeper than profile-level data. Typical use cases: brand safety review, transcript extraction for content analysis, pulling comment threads, and engagement deep-dives on individual posts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returns a platform-specific object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — post metadata and engagement stats (likes, views, shares)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — paginated comment list; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch the next page"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transcript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — spoken text extracted from the video"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — audio resource reference (Instagram and TikTok only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"post-details"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatorContentDetails"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreatorContentDetails"},"multipart/form-data":{"schemaId":"components/schemas/CreatorContentDetails"}},"schemaId":"components/schemas/CreatorContentDetails","pointer":"/paths/~1public~1v1~1creators~1content~1details~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/creators/content/details/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatorContentDetails"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreatorContentDetails"},"multipart/form-data":{"schemaId":"components/schemas/CreatorContentDetails"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/creators/content/details/","href":"post-details/public_v1_creators_content_details_create","openApiOperationId":"public_v1_creators_content_details_create","summary":"Post Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/CreatorContentDetails","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatorContentDetails"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/CreatorContentDetails"},"multipart/form-data":{"schemaId":"components/schemas/CreatorContentDetails"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatorContentDetailsResponse"}},"schemaId":"components/schemas/CreatorContentDetailsResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1creators~1content~1details~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatorContentDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatorContentDetailsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/post-details/public_v1_creators_content_details_create"}],"panels":[]}]},"httpPath":"/public/v1/creators/content/details/"}],"content":{"contentType":"group","meta":{"name":"Post Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post Details","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/creators/content/details/","summary":"Post Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/post-details/public_v1_creators_content_details_create","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account & Authentication","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account_credits_usage_retrieve","name":"Check account credits and usage details","isWebhook":false,"pointer":"/paths/~1public~1v1~1accounts~1credits~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check account credits and usage details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your API key to check your remaining credits and total credits used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credits_available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — remaining credits"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credits_used"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — total credits consumed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 credits"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"ic-ai-prompt-root","data-endpoint":"account-credits"}},"children":[]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/accounts/credits/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/accounts/credits/","href":"account-credits-and-usage/account_credits_usage_retrieve","openApiOperationId":"account_credits_usage_retrieve","summary":"Check account credits and usage details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1public~1v1~1accounts~1credits~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1public~1v1~1accounts~1credits~1/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1accounts~1credits~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_50","exampleIds":["paths/~1public~1v1~1accounts~1credits~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1public~1v1~1accounts~1credits~1/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-credits-and-usage/account_credits_usage_retrieve"}],"panels":[]}]},"httpPath":"/public/v1/accounts/credits/"}],"content":{"contentType":"group","meta":{"name":"Account credits & usage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account credits & usage","showPageActions":true},{"nodeType":"markdoc","content":"Account-level endpoints (credits, usage)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/accounts/credits/","summary":"Check account credits and usage details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-credits-and-usage/account_credits_usage_retrieve","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_accounts_tokens_list","name":"List API keys","isWebhook":false,"pointer":"/paths/~1public~1v1~1accounts~1tokens~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all API keys for the authenticated user, including inactive ones. Each response object includes the raw token value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicating current status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/accounts/tokens/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/accounts/tokens/","href":"api-keys/public_v1_accounts_tokens_list","openApiOperationId":"public_v1_accounts_tokens_list","summary":"List API keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1accounts~1tokens~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/public_v1_accounts_tokens_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_accounts_tokens_create","name":"Create API key","isWebhook":false,"pointer":"/paths/~1public~1v1~1accounts~1tokens~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new API key. The token value is included in the response."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TokenCreateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenCreateRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenCreateRequest"}},"schemaId":"components/schemas/TokenCreateRequest","pointer":"/paths/~1public~1v1~1accounts~1tokens~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/accounts/tokens/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TokenCreateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenCreateRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenCreateRequest"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/public/v1/accounts/tokens/","href":"api-keys/public_v1_accounts_tokens_create","openApiOperationId":"public_v1_accounts_tokens_create","summary":"Create API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/TokenCreateRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TokenCreateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenCreateRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token"}},"schemaId":"components/schemas/Token"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1accounts~1tokens~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Token","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/public_v1_accounts_tokens_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_accounts_tokens_partial_update","name":"Update API key","isWebhook":false,"pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an API key's label, active status, expiration date, or scopes. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove expiration."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_id","in":"path","schemaId":"schema_32","required":true}],"pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TokenUpdateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenUpdateRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenUpdateRequest"}},"schemaId":"components/schemas/TokenUpdateRequest","pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/public/v1/accounts/tokens/{token_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"token_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TokenUpdateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenUpdateRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenUpdateRequest"}},"responseCodes":["200","400","401","403","404","422","429"],"pointer":"/public/v1/accounts/tokens/{token_id}/","href":"api-keys/public_v1_accounts_tokens_partial_update","openApiOperationId":"public_v1_accounts_tokens_partial_update","summary":"Update API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/TokenUpdateRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TokenUpdateRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenUpdateRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token"}},"schemaId":"components/schemas/Token"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Token not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Token","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/public_v1_accounts_tokens_partial_update"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_accounts_tokens_delete","name":"Delete API key","isWebhook":false,"pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token_id","in":"path","schemaId":"schema_32","required":true}],"pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/accounts/tokens/{token_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"token_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","429"],"pointer":"/public/v1/accounts/tokens/{token_id}/","href":"api-keys/public_v1_accounts_tokens_delete","openApiOperationId":"public_v1_accounts_tokens_delete","summary":"Delete API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"API key deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Token not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1accounts~1tokens~1{token_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/public_v1_accounts_tokens_delete"}],"panels":[]}]},"httpPath":"/public/v1/accounts/tokens/{token_id}/"}],"content":{"contentType":"group","meta":{"name":"API Keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Keys","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys are the Bearer credentials used to authenticate requests to the public API. They are the preferred method for machine-to-machine integrations — scripts, backend services, and direct server-to-server calls where no user interaction is needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can hold multiple active API keys simultaneously — useful for separating credentials across environments or applications. Each key can be revoked individually without affecting the others."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <YOUR_API_KEY>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/accounts/tokens/","summary":"List API keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-keys/public_v1_accounts_tokens_list","deprecated":false},{"title":"/public/v1/accounts/tokens/","summary":"Create API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-keys/public_v1_accounts_tokens_create","deprecated":false},{"title":"/public/v1/accounts/tokens/{token_id}/","summary":"Update API key","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-keys/public_v1_accounts_tokens_partial_update","deprecated":false},{"title":"/public/v1/accounts/tokens/{token_id}/","summary":"Delete API key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-keys/public_v1_accounts_tokens_delete","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_oauth_register_create","name":"Register OAuth client (DCR)","isWebhook":false,"pointer":"/paths/~1public~1v1~1oauth~1register~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register OAuth client (DCR)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegisterClientRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/RegisterClientRequest"},"multipart/form-data":{"schemaId":"components/schemas/RegisterClientRequest"}},"schemaId":"components/schemas/RegisterClientRequest","pointer":"/paths/~1public~1v1~1oauth~1register~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/oauth/register/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/RegisterClientRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/RegisterClientRequest"},"multipart/form-data":{"schemaId":"components/schemas/RegisterClientRequest"}},"responseCodes":["201","400","401","403","422","429"],"pointer":"/public/v1/oauth/register/","href":"oauth/public_v1_oauth_register_create","openApiOperationId":"public_v1_oauth_register_create","summary":"Register OAuth client (DCR)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/RegisterClientRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegisterClientRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/RegisterClientRequest"},"multipart/form-data":{"schemaId":"components/schemas/RegisterClientRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegisterClientResponse"}},"schemaId":"components/schemas/RegisterClientResponse"},{"code":"400","description":"Invalid client metadata","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1oauth~1register~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/RegisterClientResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegisterClientResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/public_v1_oauth_register_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_oauth_authorize_list","name":"Initiate OAuth authorization","isWebhook":false,"pointer":"/paths/~1public~1v1~1oauth~1authorize~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate OAuth authorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client_id returned during client registration."},"children":[]}]}]}],"required":true},{"name":"redirect_uri","in":"query","schemaId":"schema_35","description":"The URI to redirect to after authorization. Must match one of the registered redirect URIs.","required":true},{"name":"response_type","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"code_challenge","in":"query","schemaId":"schema_35","description":"PKCE code challenge. Base64url-encoded SHA-256 hash of the code verifier.","required":true},{"name":"code_challenge_method","in":"query","schemaId":"schema_52","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKCE method. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if omitted."},"children":[]}]}]}]},{"name":"scope","in":"query","schemaId":"schema_37","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Space-separated list of requested scopes. Available value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the full set of scopes granted during registration if omitted."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_37","description":"Opaque value to maintain state between the request and the callback. Returned unchanged in the redirect."},{"name":"resource","in":"query","schemaId":"schema_37","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 8707 resource indicator — the canonical URI of the API this token will be used against. Forwarded through consent and bound to the issued token."},"children":[]}]}]}]}],"pointer":"/paths/~1public~1v1~1oauth~1authorize~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/oauth/authorize/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":true,"schemaId":"schema_35"},{"name":"redirect_uri","in":"query","required":true,"schemaId":"schema_35"},{"name":"response_type","in":"query","required":true,"schemaId":"schema_35"},{"name":"code_challenge","in":"query","required":true,"schemaId":"schema_35"},{"name":"code_challenge_method","in":"query","required":false,"schemaId":"schema_52"},{"name":"scope","in":"query","required":false,"schemaId":"schema_37"},{"name":"state","in":"query","required":false,"schemaId":"schema_37"},{"name":"resource","in":"query","required":false,"schemaId":"schema_37"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","400","401","403","422","429"],"pointer":"/public/v1/oauth/authorize/","href":"oauth/public_v1_oauth_authorize_list","openApiOperationId":"public_v1_oauth_authorize_list","summary":"Initiate OAuth authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect to the consent page","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown client_id"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1oauth~1authorize~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/public_v1_oauth_authorize_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_oauth_token_create","name":"OAuth token endpoint","isWebhook":false,"pointer":"/paths/~1public~1v1~1oauth~1token~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth token endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-www-form-urlencoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code_verifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refresh_token grant:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TokenRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenRequest"}},"schemaId":"components/schemas/TokenRequest","pointer":"/paths/~1public~1v1~1oauth~1token~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/public/v1/oauth/token/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TokenRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenRequest"}},"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/oauth/token/","href":"oauth/public_v1_oauth_token_create","openApiOperationId":"public_v1_oauth_token_create","summary":"OAuth token endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"schemaId":"components/schemas/TokenRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TokenRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/TokenRequest"},"multipart/form-data":{"schemaId":"components/schemas/TokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}},"schemaId":"components/schemas/TokenResponse"},{"code":"400","description":"Invalid grant or request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Invalid client","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1oauth~1token~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/public_v1_oauth_token_create"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_oauth_apps_list","name":"List connected OAuth apps","isWebhook":false,"pointer":"/paths/~1public~1v1~1oauth~1apps~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List connected OAuth apps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all OAuth apps the authenticated user has authorized."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/public/v1/oauth/apps/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429"],"pointer":"/public/v1/oauth/apps/","href":"oauth/public_v1_oauth_apps_list","openApiOperationId":"public_v1_oauth_apps_list","summary":"List connected OAuth apps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1oauth~1apps~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/public_v1_oauth_apps_list"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"public_v1_oauth_apps_delete","name":"Disconnect OAuth app","isWebhook":false,"pointer":"/paths/~1public~1v1~1oauth~1apps~1{app_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disconnect OAuth app","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revokes the user's authorization for the given app and deactivates all associated access tokens."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API_KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"app_id","in":"path","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the authorization to revoke, as returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the connected apps list."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1public~1v1~1oauth~1apps~1{app_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/public/v1/oauth/apps/{app_id}/","servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"parameters":{"path":[{"name":"app_id","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","429"],"pointer":"/public/v1/oauth/apps/{app_id}/","href":"oauth/public_v1_oauth_apps_delete","openApiOperationId":"public_v1_oauth_apps_delete","summary":"Disconnect OAuth app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Authorization revoked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request — invalid input or unsupported state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid API key."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — caller is not permitted to perform this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"App not found or not authorized by this user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity — validation failed."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate or capacity limit exceeded. Inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body field for the wait time in seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1public~1v1~1oauth~1apps~1{app_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422"},{"code":"429","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/public_v1_oauth_apps_delete"}],"panels":[]}]},"httpPath":"/public/v1/oauth/apps/{app_id}/"}],"content":{"contentType":"group","meta":{"name":"OAuth"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Authorization Code flow with PKCE, the recommended approach for connecting apps and services that act on behalf of a user. Desktop and CLI applications use this flow to obtain a token tied to a specific user's account without ever handling their password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/register/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — obtain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (one-time, no auth required)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /oauth/authorize/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — open the browser to the consent URL. The user approves the consent screen in the dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — exchange the authorization code + PKCE verifier for an access token."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access token is used as a Bearer credential in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the same way as an API key."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/public/v1/oauth/register/","summary":"Register OAuth client (DCR)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth/public_v1_oauth_register_create","deprecated":false},{"title":"/public/v1/oauth/authorize/","summary":"Initiate OAuth authorization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/oauth/public_v1_oauth_authorize_list","deprecated":false},{"title":"/public/v1/oauth/token/","summary":"OAuth token endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth/public_v1_oauth_token_create","deprecated":false},{"title":"/public/v1/oauth/apps/","summary":"List connected OAuth apps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/oauth/public_v1_oauth_apps_list","deprecated":false},{"title":"/public/v1/oauth/apps/{app_id}/","summary":"Disconnect OAuth app","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/oauth/public_v1_oauth_apps_delete","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccountCreditsUsageResponse":{"id":"components/schemas/AccountCreditsUsageResponse","kind":"json-schema","title":"AccountCreditsUsageResponse","data":{"type":"object","x-expandLevel":2,"properties":{"credits_available":{"type":"number","description":"Remaining credits available for the account."},"credits_used":{"type":"number","description":"Credits used by the account."}},"required":["credits_available","credits_used"]}},"components/schemas/AccountProfile":{"id":"components/schemas/AccountProfile","kind":"json-schema","title":"AccountProfile","data":{"type":"object","properties":{"full_name":{"type":"string"},"username":{"type":"string","description":"The creator's username on the platform."},"picture":{"type":"string","format":"uri","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires."},"followers":{"type":"integer"},"engagement_percent":{"type":"number","format":"double"}},"required":["full_name","username","picture","followers","engagement_percent"]}},"components/schemas/AccountResponse":{"id":"components/schemas/AccountResponse","kind":"json-schema","title":"AccountResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier."},"profile":{"$ref":"#/components/schemas/AccountProfile"},"similarity_score":{"type":"number","format":"double","description":"How closely this creator matches your reference. Higher values indicate a stronger match."},"matched_filters":{"$ref":"#/components/schemas/MatchedFilters","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only present when return_filter_values=true."},"children":[]}]}]}]}},"required":["user_id","profile"]}},"components/schemas/AddCampaignCreatorsInput":{"id":"components/schemas/AddCampaignCreatorsInput","kind":"json-schema","title":"AddCampaignCreatorsInput","data":{"type":"object","properties":{"platform":{"type":"string","description":"Platform to add the creators under. Must be one of the campaign's platforms."},"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator handles to add. Provide at least one of handles, list_ids, or csv_file."},"children":[]}]}]}]},"list_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of discovery lists whose creators are added. Each list's platform must match."},"csv_file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV upload of creator handles (see handle_column)."},"children":[]}]}]}]},"handle_column":{"type":"string","description":"Name of the CSV column holding creator handles. Matched case-insensitively; defaults to 'handle'.","default":"handle"}},"required":["platform"]}},"components/schemas/AddCampaignCreatorsInputRequest":{"id":"components/schemas/AddCampaignCreatorsInputRequest","kind":"json-schema","title":"AddCampaignCreatorsInputRequest","data":{"type":"object","properties":{"platform":{"type":"string","description":"Platform to add the creators under. Must be one of the campaign's platforms."},"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator handles to add. Provide at least one of handles, list_ids, or csv_file."},"children":[]}]}]}]},"list_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of discovery lists whose creators are added. Each list's platform must match."},"csv_file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV upload of creator handles (see handle_column)."},"children":[]}]}]}]},"handle_column":{"type":"string","description":"Name of the CSV column holding creator handles. Matched case-insensitively; defaults to 'handle'.","default":"handle"}},"required":["platform"]}},"components/schemas/AddSubscriptionCreatorsInput":{"id":"components/schemas/AddSubscriptionCreatorsInput","kind":"json-schema","title":"AddSubscriptionCreatorsInput","data":{"type":"object","properties":{"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator handles to add. Provide at least one of handles, list_ids, or csv_file."},"children":[]}]}]}]},"list_ids":{"type":"array","items":{"type":"integer"},"description":"Discovery list IDs whose creators are added. Each list's platform must match the subscription's platform."},"csv_file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV upload of creator handles (see handle_column)."},"children":[]}]}]}]},"handle_column":{"type":"string","description":"Name of the CSV column holding creator handles. Matched case-insensitively; defaults to 'handle'.","default":"handle"}}}},"components/schemas/AddSubscriptionCreatorsInputRequest":{"id":"components/schemas/AddSubscriptionCreatorsInputRequest","kind":"json-schema","title":"AddSubscriptionCreatorsInputRequest","data":{"type":"object","properties":{"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator handles to add. Provide at least one of handles, list_ids, or csv_file."},"children":[]}]}]}]},"list_ids":{"type":"array","items":{"type":"integer"},"description":"Discovery list IDs whose creators are added. Each list's platform must match the subscription's platform."},"csv_file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV upload of creator handles (see handle_column)."},"children":[]}]}]}]},"handle_column":{"type":"string","description":"Name of the CSV column holding creator handles. Matched case-insensitively; defaults to 'handle'.","default":"handle"}}}},"components/schemas/AudienceAge":{"id":"components/schemas/AudienceAge","kind":"json-schema","title":"AudienceAge","data":{"type":"object","properties":{"range":{"type":"string","enum":["13-17","18-24","25-34","35-44","45-64","65-","65+"],"nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceAgeFilterRequest":{"id":"components/schemas/AudienceAgeFilterRequest","kind":"json-schema","title":"AudienceAgeFilterRequest","data":{"type":"object","properties":{"range":{"type":"string","enum":["13-17","18-24","25-34","35-44","45-64","65-","65+"],"nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceDataResponse":{"id":"components/schemas/AudienceDataResponse","kind":"json-schema","title":"AudienceDataResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audience insights returned when include_audience_data is enabled. Contains demographic breakdowns for followers, commenters, and likers."},"children":[]}]}]}],"properties":{"audience_followers":{"type":"object","nullable":true,"description":"Demographic breakdown of the creator's followers. Includes geo, languages, ages, genders, interests, brand affinities, credibility score, and reachability.","additionalProperties":true},"audience_commenters":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Demographic breakdown of the creator's commenters. Same structure as audience_followers."},"children":[]}]}]}],"additionalProperties":true},"audience_likers":{"type":"object","nullable":true,"description":"Demographic breakdown of the creator's likers. Includes credibility score and credibility class.","additionalProperties":true},"audience_credibility_followers_histogram":{"type":"array","nullable":true,"description":"Distribution of follower credibility scores as a histogram.","items":{"type":"object","additionalProperties":true}},"audience_credibility_likers_histogram":{"type":"array","nullable":true,"description":"Distribution of liker credibility scores as a histogram.","items":{"type":"object","additionalProperties":true}}}}},"components/schemas/AudienceFilterRequest":{"id":"components/schemas/AudienceFilterRequest","kind":"json-schema","title":"AudienceFilterRequest","data":{"type":"object","properties":{"location":{"type":"array","items":{"$ref":"#/components/schemas/AudienceLocationFilterRequest"},"nullable":true},"gender":{"allOf":[{"$ref":"#/components/schemas/AudienceGenderFilterRequest"}],"nullable":true},"language":{"type":"array","items":{"$ref":"#/components/schemas/AudienceLanguageFilterRequest"},"nullable":true},"age":{"type":"array","items":{"$ref":"#/components/schemas/AudienceAgeFilterRequest"},"nullable":true},"interests":{"type":"array","items":{"$ref":"#/components/schemas/AudienceInterestFilterRequest"},"nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"brand_categories":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"credibility":{"type":"string","enum":["bad","low","normal","good","high","best"],"nullable":true}}}},"components/schemas/AudienceGender":{"id":"components/schemas/AudienceGender","kind":"json-schema","title":"AudienceGender","data":{"type":"object","properties":{"type":{"type":"string"},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceGenderFilterRequest":{"id":"components/schemas/AudienceGenderFilterRequest","kind":"json-schema","title":"AudienceGenderFilterRequest","data":{"type":"object","properties":{"type":{"type":"string"},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceInterest":{"id":"components/schemas/AudienceInterest","kind":"json-schema","title":"AudienceInterest","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceInterestFilterRequest":{"id":"components/schemas/AudienceInterestFilterRequest","kind":"json-schema","title":"AudienceInterestFilterRequest","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceLanguage":{"id":"components/schemas/AudienceLanguage","kind":"json-schema","title":"AudienceLanguage","data":{"type":"object","properties":{"language_abbr":{"type":"string","nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceLanguageFilterRequest":{"id":"components/schemas/AudienceLanguageFilterRequest","kind":"json-schema","title":"AudienceLanguageFilterRequest","data":{"type":"object","properties":{"language_abbr":{"type":"string","nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceLocation":{"id":"components/schemas/AudienceLocation","kind":"json-schema","title":"AudienceLocation","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["country","state","city"],"nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceLocationFilterRequest":{"id":"components/schemas/AudienceLocationFilterRequest","kind":"json-schema","title":"AudienceLocationFilterRequest","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["country","state","city"],"nullable":true},"min_pct":{"type":"number","format":"double","nullable":true}}}},"components/schemas/AudienceOverlapInput":{"id":"components/schemas/AudienceOverlapInput","kind":"json-schema","title":"AudienceOverlapInput","data":{"type":"object","properties":{"platform":{"type":"string"},"creators":{"type":"array","items":{"type":"string"}}},"required":["platform","creators"],"example":{"platform":"instagram","creators":["creator_handle_1","creator_handle_2"]}}},"components/schemas/AudienceOverlapResponse":{"id":"components/schemas/AudienceOverlapResponse","kind":"json-schema","title":"AudienceOverlapResponse","data":{"type":"object","properties":{"credits_cost":{"type":"number","format":"double","nullable":true,"example":1},"credits_left":{"type":"number","format":"double","nullable":true},"status":{"type":"boolean","nullable":true},"success":{"type":"boolean","nullable":true},"basics":{"allOf":[{"$ref":"#/components/schemas/ReportInfo"}],"nullable":true},"details":{"type":"array","items":{"$ref":"#/components/schemas/OverlapDataItem"}}}}},"components/schemas/BatchEnrichmentDownloadURL":{"id":"components/schemas/BatchEnrichmentDownloadURL","kind":"json-schema","title":"BatchEnrichmentDownloadURL","data":{"type":"object","properties":{"download_url":{"type":"string","format":"uri","description":"Temporary presigned S3 download URL"},"filename":{"type":"string","description":"Suggested filename for the download"},"expires_in":{"type":"integer","description":"URL expiration time in seconds"},"expires_at":{"type":"string","description":"ISO 8601 timestamp when the URL expires"},"batch_id":{"type":"string","description":"Unique identifier for the batch enrichment job"},"total_results":{"type":"integer","description":"Number of enriched results in the file"},"invalid_records":{"type":"integer","description":"Number of invalid records in the batch"}},"required":["download_url","filename","expires_in","expires_at","batch_id","total_results","invalid_records"]}},"components/schemas/BatchEnrichmentInput":{"id":"components/schemas/BatchEnrichmentInput","kind":"json-schema","title":"BatchEnrichmentInput","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"CSV file containing creators to enrich (max 10MB, single column: handle or email)"},"platform":{"type":"string","enum":["instagram","youtube","tiktok","twitter","twitch","onlyfans"],"description":"Social media platform (required for handle-based enrichment)"},"enrichment_mode":{"type":"string","enum":["raw","full","basic"],"description":"Enrichment mode: 'raw' or 'full' for handle-based, 'basic' or 'advanced' for email-based"},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional metadata as JSON object (e.g., {\"campaign\": \"Q4 Outreach\"})"},"children":[]}]}]}],"nullable":true,"additionalProperties":{}},"email_required":{"type":"string","enum":["must_have","preferred"],"description":"Email requirement for handle-based full enrichment. Default: \"preferred\""},"include_lookalikes":{"type":"boolean","description":"Include lookalike creators for handle-based full enrichment. Default: false","default":false},"include_audience_data":{"type":"boolean","description":"Include audience data for handle-based full enrichment. Default: true","default":true},"exclude_platforms":{"type":"string","enum":["instagram","youtube","tiktok","twitter","twitch","onlyfans"],"description":"Platforms to exclude from response"},"min_followers":{"type":"integer"}},"required":["file","enrichment_mode"],"example":{"file":"(binary)","platform":"instagram","enrichment_mode":"full","metadata":{"campaign":"Q4 Outreach"},"email_required":"preferred","include_lookalikes":false,"include_audience_data":true,"exclude_platforms":"twitter","min_followers":1000}}},"components/schemas/BatchEnrichmentInputRequest":{"id":"components/schemas/BatchEnrichmentInputRequest","kind":"json-schema","title":"BatchEnrichmentInputRequest","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"CSV file containing creators to enrich (max 10MB, single column: handle or email)"},"platform":{"type":"string","enum":["instagram","youtube","tiktok","twitter","twitch","onlyfans"],"description":"Social media platform (required for handle-based enrichment)"},"enrichment_mode":{"type":"string","enum":["raw","full","basic"],"description":"Enrichment mode: 'raw' or 'full' for handle-based, 'basic' or 'advanced' for email-based"},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional metadata as JSON object (e.g., {\"campaign\": \"Q4 Outreach\"})"},"children":[]}]}]}],"nullable":true,"additionalProperties":{}},"email_required":{"type":"string","enum":["must_have","preferred"],"description":"Email requirement for handle-based full enrichment. Default: \"preferred\""},"include_lookalikes":{"type":"boolean","description":"Include lookalike creators for handle-based full enrichment. Default: false","default":false},"include_audience_data":{"type":"boolean","description":"Include audience data for handle-based full enrichment. Default: true","default":true},"exclude_platforms":{"type":"string","enum":["instagram","youtube","tiktok","twitter","twitch","onlyfans"],"description":"Platforms to exclude from response"},"min_followers":{"type":"integer"}},"required":["file","enrichment_mode"],"example":{"file":"(binary)","platform":"instagram","enrichment_mode":"full","metadata":{"campaign":"Q4 Outreach"},"email_required":"preferred","include_lookalikes":false,"include_audience_data":true,"exclude_platforms":"twitter","min_followers":1000}}},"components/schemas/BatchEnrichmentResponse":{"id":"components/schemas/BatchEnrichmentResponse","kind":"json-schema","title":"BatchEnrichmentResponse","data":{"type":"object","properties":{"batch_id":{"type":"string","description":"Unique identifier for the batch enrichment job"},"status":{"type":"string","description":"Current status of the batch job (processing, finished, failed, validating)"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the batch was created"},"platform":{"type":"string","description":"Platform used for enrichment (for handle-based enrichment)","nullable":true},"metadata":{"type":"object","description":"Metadata provided with the batch","nullable":true,"additionalProperties":{}},"og_input_number":{"type":"integer","description":"Total number of records in the input file"},"type_report":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of enrichment: ENRICH_BY_HANDLE or ENRICH_BY_EMAIL"},"children":[]}]}]}]},"enrichment_mode":{"type":"string","description":"Enrichment mode: raw, full, basic","nullable":true},"message":{"type":"string","description":"Human-readable message about the batch status"}},"required":["batch_id","status","created_at","og_input_number","type_report","message"],"x-expandLevel":2}},"components/schemas/BatchEnrichmentStatusResponse":{"id":"components/schemas/BatchEnrichmentStatusResponse","kind":"json-schema","title":"BatchEnrichmentStatusResponse","data":{"type":"object","properties":{"batch_id":{"type":"string","description":"Unique identifier for the batch enrichment job"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the batch job (processing, finished, failed, queued, paused_insufficient_credits)"},"children":[]}]}]}]},"total_rows":{"type":"integer","description":"Total number of records submitted in the batch"},"processed_rows":{"type":"integer","description":"Total number of records that have finished processing"},"success_count":{"type":"integer","description":"Number of records processed successfully"},"failed_count":{"type":"integer","description":"Number of records that failed or could not be processed"},"started_at":{"type":"string","format":"date-time","description":"Timestamp when the batch was created"},"metadata":{"type":"object","description":"Metadata provided with the batch","additionalProperties":{}},"credits_used":{"type":"string","format":"decimal","description":"Total number of credits used in the batch","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$"},"estimated_completion":{"type":"string","format":"date-time","description":"Estimated completion timestamp based on current progress (null if unavailable)","nullable":true},"status_message":{"type":"string","description":"Human-readable message about the batch status (only present when paused)","nullable":true}},"required":["batch_id","status","total_rows","processed_rows","success_count","failed_count","started_at","metadata","credits_used"],"x-expandLevel":2}},"components/schemas/Brand":{"id":"components/schemas/Brand","kind":"json-schema","title":"Brand","data":{"type":"object","properties":{"full_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name, e.g. \"L'Oréal Professionnel Paris\"."},"children":[]}]}]}]},"cleaned":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normalised name, without accents, punctuation or emoji and often shorter than the display name, e.g. \"Loreal\". This is what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exact=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" searches."},"children":[]}]}]}]},"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to use in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter on the Discovery API."},"children":[]}]}]}]}},"required":["full_name","cleaned","username"]}},"components/schemas/BrandAffinityResponse":{"id":"components/schemas/BrandAffinityResponse","kind":"json-schema","title":"BrandAffinityResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the brand.","nullable":true},"interest":{"type":"array","items":{"type":"string"},"description":"Interest categories associated with the brand."}}}},"components/schemas/CampaignContent":{"id":"components/schemas/CampaignContent","kind":"json-schema","title":"CampaignContent","data":{"type":"object","properties":{"platform":{"type":"string","description":"Platform the post was published on."},"post_type":{"type":"string","description":"Display post type (e.g. 'post', 'reel', 'video', 'story')."},"creator":{"$ref":"#/components/schemas/CampaignContentCreator","description":"The post's creator."},"caption":{"type":"string","description":"Post caption; empty string when unavailable."},"url":{"type":"string","description":"Permalink to the post; empty string when unavailable."},"media":{"type":"object","description":"Normalized media payload (cover image, video URL, etc.); shape varies by platform, null when unavailable.","nullable":true,"additionalProperties":{}},"posted_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post timestamp: the post's own taken_at (a unix timestamp or ISO 8601 string) when present, else the detection time (ISO 8601)."},"children":[]}]}]}]},"metrics_live":{"type":"boolean","description":"True when the metrics come from the creator's latest scrape (post still in the recent-posts window); false when they are the stored values, refreshed daily for active campaigns."},"metrics_note":{"type":"string","description":"Explanation of the metrics source when not live; null when live.","nullable":true},"post_unavailable":{"type":"boolean","description":"True when the post was found deleted/unavailable at rescrape; the metrics shown are the last values captured before removal."},"last_metrics_update":{"type":"string","format":"date-time","description":"When the post's metrics were last captured (ISO 8601)."},"views":{"type":"integer","description":"View count, or null when unavailable.","nullable":true},"likes":{"type":"integer","description":"Like count, or null when unavailable.","nullable":true},"comments":{"type":"integer","description":"Comment count, or null when unavailable.","nullable":true},"engagement":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Likes + comments, or null when unavailable."},"children":[]}]}]}],"nullable":true},"er":{"type":"number","format":"double","description":"Engagement rate as a percentage, or null when unavailable.","nullable":true},"emv":{"type":"integer","description":"Earned Media Value for the post, rounded to the nearest 100, or null when unavailable.","nullable":true},"is_top":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True when the post ranks in the top 10% by engagement rate."},"children":[]}]}]}]}},"required":["platform","post_type","creator","posted_at","metrics_live","post_unavailable","last_metrics_update","is_top"]}},"components/schemas/CampaignContentCreator":{"id":"components/schemas/CampaignContentCreator","kind":"json-schema","title":"CampaignContentCreator","data":{"type":"object","properties":{"handle":{"type":"string","description":"The creator's handle on the platform."},"name":{"type":"string","description":"The creator's display name."},"avatar":{"type":"string","format":"uri","description":"Signed profile-picture URL, or null.","nullable":true}},"required":["handle","name"]}},"components/schemas/CampaignContentListPage":{"id":"components/schemas/CampaignContentListPage","kind":"json-schema","title":"CampaignContentListPage","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of posts matching the filter."},"next":{"type":"string","format":"uri","description":"URL of the next page, or null on the last page.","nullable":true},"previous":{"type":"string","format":"uri","description":"URL of the previous page, or null on the first page.","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CampaignContent"},"description":"Posts on the current page."}},"required":["count","results"]}},"components/schemas/CampaignCreator":{"id":"components/schemas/CampaignCreator","kind":"json-schema","title":"CampaignCreator","data":{"type":"object","properties":{"id":{"type":"integer","description":"Creator link identifier."},"platform":{"type":"string","description":"The creator's platform for this campaign."},"handle":{"type":"string","description":"The creator's handle on the platform."},"name":{"type":"string","description":"The creator's display name."},"avatar":{"type":"string","format":"uri","description":"Signed profile-picture URL, or null.","nullable":true},"posts":{"type":"integer","description":"Campaign posts detected for the creator."},"views":{"type":"integer","description":"Blended impressions estimate summed across the creator's posts."},"engagement":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total engagement (likes + comments) across the creator's posts."},"children":[]}]}]}]},"er":{"type":"number","format":"double","description":"Average engagement rate as a percentage, or null when the follower count is unknown.","nullable":true},"emv":{"type":"integer","description":"Earned Media Value for the creator, rounded to the nearest 100."},"trend":{"type":"array","items":{"$ref":"#/components/schemas/CampaignCreatorTrendPoint"},"description":"Daily engagement/post trend for the last 7 days."},"status":{"type":"string","enum":["posting","awaiting_first_post"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'posting' once the creator has campaign posts; 'awaiting_first_post' if added but not yet posting."},"children":[]}]}]}]},"added_at":{"type":"string","format":"date-time","description":"When the creator was added to the campaign."}},"required":["id","platform","handle","name","posts","views","engagement","emv","trend","status","added_at"]}},"components/schemas/CampaignCreatorListPage":{"id":"components/schemas/CampaignCreatorListPage","kind":"json-schema","title":"CampaignCreatorListPage","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of creators matching the filter."},"next":{"type":"string","format":"uri","description":"URL of the next page, or null on the last page.","nullable":true},"previous":{"type":"string","format":"uri","description":"URL of the previous page, or null on the first page.","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CampaignCreator"},"description":"Creators on the current page."}},"required":["count","results"]}},"components/schemas/CampaignCreatorTrendPoint":{"id":"components/schemas/CampaignCreatorTrendPoint","kind":"json-schema","title":"CampaignCreatorTrendPoint","data":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Calendar day (ISO 8601) in the account timezone."},"engagement":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Likes + comments detected that day."},"children":[]}]}]}]},"posts":{"type":"integer","description":"Posts detected that day."}},"required":["date","engagement","posts"]}},"components/schemas/CampaignListPage":{"id":"components/schemas/CampaignListPage","kind":"json-schema","title":"CampaignListPage","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of campaigns matching the filter."},"next":{"type":"string","format":"uri","description":"URL of the next page, or null on the last page.","nullable":true},"previous":{"type":"string","format":"uri","description":"URL of the previous page, or null on the first page.","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CampaignListResponse"},"description":"Campaigns on the current page."},"status_counts":{"$ref":"#/components/schemas/CampaignStatusCounts","description":"Counts of the client's campaigns by status. Computed across all campaigns in scope, ignoring the status filter."}},"required":["count","results","status_counts"]}},"components/schemas/CampaignListResponse":{"id":"components/schemas/CampaignListResponse","kind":"json-schema","title":"CampaignListResponse","data":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"platforms":{"type":"object","additionalProperties":{}},"status":{"type":"string"},"content_types":{"type":"object","nullable":true,"additionalProperties":{}},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"budget":{"type":"string","format":"decimal","nullable":true},"creator_count":{"type":"string","description":"Number of creators tracked across the campaign's subscriptions."},"sample_creators":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 5 sampled creators (handle + avatar) across the campaign's subscriptions."},"children":[]}]}]}]},"total_posts":{"type":"string","description":"Total detected posts summed across the campaign's subscriptions."},"engagement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total engagement (likes + comments) across the campaign's subscriptions."},"children":[]}]}]}]},"emv":{"type":"string","description":"Earned Media Value for the campaign, computed per-platform and summed."},"seven_day_trend":{"type":"string","description":"Daily engagement/post trend for the last 7 days."},"created_at":{"type":"string","format":"date-time"}},"required":["id","name","platforms","status","start_date","end_date","created_at"]}},"components/schemas/CampaignReport":{"id":"components/schemas/CampaignReport","kind":"json-schema","title":"CampaignReport","data":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string","description":"Generation status: 'generating', 'ready', or 'failed'."},"report_data":{"type":"object","description":"Structured report content the dashboard renders; empty until status is 'ready'.","additionalProperties":{}},"model_used":{"type":"string","description":"Identifier of the AI model that generated the report."},"error_message":{"type":"string","description":"Error detail when status is 'failed'; empty otherwise."},"generated_at":{"type":"string","format":"date-time","description":"When generation completed; null until the report is ready.","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","status","created_at","updated_at"]}},"components/schemas/CampaignResponse":{"id":"components/schemas/CampaignResponse","kind":"json-schema","title":"CampaignResponse","data":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"platforms":{"type":"object","additionalProperties":{}},"status":{"type":"string"},"brief":{"type":"string"},"content_types":{"type":"object","nullable":true,"additionalProperties":{}},"tracking_keywords":{"type":"object","nullable":true,"additionalProperties":{}},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"budget":{"type":"string","format":"decimal","nullable":true},"creator_count":{"type":"string","description":"Number of live creator links across the campaign's subscriptions."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","platforms","status","start_date","end_date","created_at","updated_at"]}},"components/schemas/CampaignStatusCounts":{"id":"components/schemas/CampaignStatusCounts","kind":"json-schema","title":"CampaignStatusCounts","data":{"type":"object","properties":{"draft":{"type":"integer","description":"Number of draft campaigns."},"active":{"type":"integer","description":"Number of active campaigns."},"paused":{"type":"integer","description":"Number of paused campaigns."},"completed":{"type":"integer","description":"Number of completed campaigns."}},"required":["draft","active","paused","completed"]}},"components/schemas/ConnectedApp":{"id":"components/schemas/ConnectedApp","kind":"json-schema","title":"ConnectedApp","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the authorization, used to disconnect the app."},"name":{"type":"string","description":"Display name of the connected application."},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth client_id of the connected application."},"children":[]}]}]}]},"granted_scopes":{"type":"array","items":{"type":"string"},"description":"Scopes the user granted to this application."},"created_at":{"type":"string","format":"date-time","description":"When the application was first authorized."}},"required":["id","name","client_id","granted_scopes","created_at"]}},"components/schemas/ConnectedSocial":{"id":"components/schemas/ConnectedSocial","kind":"json-schema","title":"ConnectedSocial","data":{"type":"object","properties":{"platform":{"type":"string","description":"The creator's social media platform."},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"url":{"type":"string","description":"The creator's profile URL.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"fullname":{"type":"string","nullable":true},"picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"followers":{"type":"integer","nullable":true}},"required":["platform"]}},"components/schemas/ConnectedSocialsQuery":{"id":"components/schemas/ConnectedSocialsQuery","kind":"json-schema","title":"ConnectedSocialsQuery","data":{"type":"object","properties":{"platform":{"type":"string","enum":["instagram","youtube","tiktok","onlyfans","twitter","twitch"]},"handle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator identifier — username, profile URL, or YouTube channel ID (UC...)."},"children":[]}]}]}]}},"required":["platform","handle"],"example":{"platform":"instagram","handle":"creator_handle"}}},"components/schemas/ConnectedSocialsResponse":{"id":"components/schemas/ConnectedSocialsResponse","kind":"json-schema","title":"ConnectedSocialsResponse","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ConnectedSocial"}},"credits_cost":{"type":"number","format":"double","example":0.5},"response_meta":{"type":"object","additionalProperties":{}}},"required":["result","credits_cost","response_meta"]}},"components/schemas/CreateCampaignInput":{"id":"components/schemas/CreateCampaignInput","kind":"json-schema","title":"CreateCampaignInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Campaign name. Must be unique among the client's non-archived campaigns."},"tracking_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords whose presence in a creator's posts marks the post as campaign content. Optional."},"brief":{"type":"string","description":"Free-text campaign brief.","default":""},"platforms":{"type":"array","items":{"type":"string"},"description":"Platforms the campaign tracks. One subscription is created per platform; duplicates are rejected."},"content_types":{"type":"array","items":{"type":"string"},"description":"Post types counted as campaign content (e.g. 'post', 'reel', 'video', 'story')."},"start_date":{"type":"string","format":"date","description":"Date the campaign begins tracking (ISO 8601). Cannot be in the past."},"end_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the campaign stops tracking (ISO 8601). Must be after start_date."},"children":[]}]}]}]},"budget":{"type":"string","format":"decimal","description":"Optional campaign budget.","nullable":true,"pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"}},"required":["name","platforms","content_types","start_date","end_date"]}},"components/schemas/CreateCampaignInputRequest":{"id":"components/schemas/CreateCampaignInputRequest","kind":"json-schema","title":"CreateCampaignInputRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"Campaign name. Must be unique among the client's non-archived campaigns."},"tracking_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords whose presence in a creator's posts marks the post as campaign content. Optional."},"brief":{"type":"string","description":"Free-text campaign brief.","default":""},"platforms":{"type":"array","items":{"type":"string"},"description":"Platforms the campaign tracks. One subscription is created per platform; duplicates are rejected."},"content_types":{"type":"array","items":{"type":"string"},"description":"Post types counted as campaign content (e.g. 'post', 'reel', 'video', 'story')."},"start_date":{"type":"string","format":"date","description":"Date the campaign begins tracking (ISO 8601). Cannot be in the past."},"end_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the campaign stops tracking (ISO 8601). Must be after start_date."},"children":[]}]}]}]},"budget":{"type":"string","format":"decimal","description":"Optional campaign budget.","nullable":true,"pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"}},"required":["name","platforms","content_types","start_date","end_date"]}},"components/schemas/CreateSubscriptionInput":{"id":"components/schemas/CreateSubscriptionInput","kind":"json-schema","title":"CreateSubscriptionInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Optional subscription name."},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform to monitor. Optional when it can be derived from list_ids; required otherwise. Exactly one platform per subscription."},"children":[]}]}]}]},"event_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event that triggers a notification (e.g. 'new_post', 'bio_change', 'follower_threshold')."},"children":[]}]}]}]},"filters":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event-type-specific filter object. Required for 'follower_threshold'; shape is validated against the chosen event_type."},"children":[]}]}]}],"additionalProperties":{}},"list_ids":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery list IDs whose creators are monitored. Provide handles and/or list_ids."},"children":[]}]}]}]},"notify_endpoints":{"type":"array","items":{"$ref":"#/components/schemas/NotifyEndpointInput"},"description":"Where matching events are delivered. At least one is required."},"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator handles to monitor. Provide handles and/or list_ids."},"children":[]}]}]}]}},"required":["event_type","notify_endpoints"]}},"components/schemas/CreateSubscriptionInputRequest":{"id":"components/schemas/CreateSubscriptionInputRequest","kind":"json-schema","title":"CreateSubscriptionInputRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"Optional subscription name."},"platform":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform to monitor. Optional when it can be derived from list_ids; required otherwise. Exactly one platform per subscription."},"children":[]}]}]}]},"event_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event that triggers a notification (e.g. 'new_post', 'bio_change', 'follower_threshold')."},"children":[]}]}]}]},"filters":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event-type-specific filter object. Required for 'follower_threshold'; shape is validated against the chosen event_type."},"children":[]}]}]}],"additionalProperties":{}},"list_ids":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery list IDs whose creators are monitored. Provide handles and/or list_ids."},"children":[]}]}]}]},"notify_endpoints":{"type":"array","items":{"$ref":"#/components/schemas/NotifyEndpointInput"},"description":"Where matching events are delivered. At least one is required."},"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator handles to monitor. Provide handles and/or list_ids."},"children":[]}]}]}]}},"required":["event_type","notify_endpoints"]}},"components/schemas/CreatorContentDetails":{"id":"components/schemas/CreatorContentDetails","kind":"json-schema","title":"CreatorContentDetails","data":{"type":"object","properties":{"platform":{"type":"string","description":"Social media platform. Allowed: instagram, tiktok, youtube."},"content_type":{"type":"string","description":"Type of content to fetch. Platform-specific."},"post_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the post, e.g., '3702042988674165349_1541770582'."},"children":[]}]}]}]},"pagination_token":{"type":"string","description":"Pagination token, optional."}},"required":["platform","content_type","post_id"],"example":{"platform":"instagram","content_type":"data","post_id":"3702042988674165349_1541770582","pagination_token":""}}},"components/schemas/CreatorContentDetailsRequest":{"id":"components/schemas/CreatorContentDetailsRequest","kind":"json-schema","title":"CreatorContentDetailsRequest","data":{"type":"object","properties":{"platform":{"type":"string","description":"Social media platform. Allowed: instagram, tiktok, youtube."},"content_type":{"type":"string","description":"Type of content to fetch. Platform-specific."},"post_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the post, e.g., '3702042988674165349_1541770582'."},"children":[]}]}]}]},"pagination_token":{"type":"string","description":"Pagination token, optional."}},"required":["platform","content_type","post_id"],"example":{"platform":"instagram","content_type":"data","post_id":"3702042988674165349_1541770582","pagination_token":""}}},"components/schemas/CreatorContentDetailsResponse":{"id":"components/schemas/CreatorContentDetailsResponse","kind":"json-schema","title":"CreatorContentDetailsResponse","data":{"type":"object","properties":{"credits_cost":{"type":"number","format":"double","nullable":true,"example":0.03},"result":{"type":"object","description":"A dictionary of arbitrary key-value pairs.","additionalProperties":{}}},"x-expandLevel":2}},"components/schemas/CreatorHas":{"id":"components/schemas/CreatorHas","kind":"json-schema","title":"CreatorHas","data":{"type":"object","properties":{"has_amazonaffiliates":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_applemusic":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_bandcamp":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_behance":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_buymeacoffee":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_cameo":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_canva":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_clubhouse":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_discord":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_dribbble":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_etsy":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_facebook":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_fiverr":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_github":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_gofundme":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_goodreads":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_instagram":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_kakao":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_kickstarter":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_kofi":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_linkedin":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_linktree":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_medium":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_onlyfans":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_patreon":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_personal_website":{"type":"boolean","description":"Only true is meaningful. Filters for creators with a website on their Instagram, TikTok or YouTube profile. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_phone":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_pinterest":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_podcast":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_redbubble":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_shopify":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_shopltk":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_snapchat":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_spotify":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_spring":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_streamlabs":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_substack":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_telegram":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_tiktok":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_tumblr":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_twitch":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_twitter":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_udemy":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_viber":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_vimeo":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_vk":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_weebly":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_whatsApp":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_youtube":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_wix":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_anchor":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_soundcloud":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_community":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false}}}},"components/schemas/CreatorHasRequest":{"id":"components/schemas/CreatorHasRequest","kind":"json-schema","title":"CreatorHasRequest","data":{"type":"object","properties":{"has_amazonaffiliates":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_applemusic":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_bandcamp":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_behance":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_buymeacoffee":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_cameo":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_canva":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_clubhouse":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_discord":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_dribbble":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_etsy":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_facebook":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_fiverr":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_github":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_gofundme":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_goodreads":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_instagram":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_kakao":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_kickstarter":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_kofi":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_linkedin":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_linktree":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_medium":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_onlyfans":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_patreon":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_personal_website":{"type":"boolean","description":"Only true is meaningful. Filters for creators with a website on their Instagram, TikTok or YouTube profile. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_phone":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_pinterest":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_podcast":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_redbubble":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_shopify":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_shopltk":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_snapchat":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_spotify":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_spring":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_streamlabs":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_substack":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_telegram":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_tiktok":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_tumblr":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_twitch":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_twitter":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_udemy":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_viber":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_vimeo":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_vk":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_weebly":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_whatsApp":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_youtube":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_wix":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_anchor":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_soundcloud":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_community":{"type":"boolean","description":"Only true is meaningful. Filters for creators who have this platform/link. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false}}}},"components/schemas/CreatorPostsQuery":{"id":"components/schemas/CreatorPostsQuery","kind":"json-schema","title":"CreatorPostsQuery","data":{"type":"object","properties":{"count":{"type":"integer","description":"Number of posts to fetch per page. Clamped to platform-specific limits."},"pagination_token":{"type":"string","description":"Cursor for fetching the next page of results."},"platform":{"type":"string","description":"Social media platform. Allowed: instagram, tiktok, youtube."},"handle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator identifier — username, profile URL, or YouTube channel ID (UC...)."},"children":[]}]}]}]}},"required":["platform","handle"],"example":{"platform":"instagram","handle":"creator_handle","count":12,"pagination_token":""}}},"components/schemas/CreatorPostsResponse":{"id":"components/schemas/CreatorPostsResponse","kind":"json-schema","title":"CreatorPostsResponse","data":{"type":"object","properties":{"credits_cost":{"type":"number","format":"double","nullable":true,"example":0.03},"result":{"$ref":"#/components/schemas/CreatorPostsResult"}},"required":["result"]}},"components/schemas/CreatorPostsResult":{"id":"components/schemas/CreatorPostsResult","kind":"json-schema","title":"CreatorPostsResult","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PostItemModel"}},"num_results":{"type":"integer"},"more_available":{"type":"boolean"},"next_token":{"type":"string","nullable":true},"status":{"type":"string","default":"ok"}},"required":["items","num_results","more_available"]}},"components/schemas/DiscoveryAPIResponse":{"id":"components/schemas/DiscoveryAPIResponse","kind":"json-schema","title":"DiscoveryAPIResponse","data":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"credits_left":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountResponse"}}},"required":["total","limit","credits_left"]}},"components/schemas/DiscoveryAPISearchInputRequest":{"id":"components/schemas/DiscoveryAPISearchInputRequest","kind":"json-schema","title":"DiscoveryAPISearchInputRequest","data":{"oneOf":[{"$ref":"#/components/schemas/DiscoveryInstagramRequest"},{"$ref":"#/components/schemas/DiscoveryYouTubeRequest"},{"$ref":"#/components/schemas/DiscoveryTikTokRequest"},{"$ref":"#/components/schemas/DiscoveryTwitterRequest"},{"$ref":"#/components/schemas/DiscoveryTwitchRequest"},{"$ref":"#/components/schemas/DiscoveryOnlyFansRequest"}],"discriminator":{"propertyName":"platform","mapping":{"instagram":"#/components/schemas/DiscoveryInstagramRequest","youtube":"#/components/schemas/DiscoveryYouTubeRequest","tiktok":"#/components/schemas/DiscoveryTikTokRequest","twitter":"#/components/schemas/DiscoveryTwitterRequest","twitch":"#/components/schemas/DiscoveryTwitchRequest","onlyfans":"#/components/schemas/DiscoveryOnlyFansRequest"}}}},"components/schemas/DiscoveryFiltersRequest":{"id":"components/schemas/DiscoveryFiltersRequest","kind":"json-schema","title":"DiscoveryFiltersRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery filters are platform-dependent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API accepts a superset of all filters across platforms, but only a subset is applied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"depending on the selected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We annotate fields with \"Supported platforms\" in the OpenAPI schema so users can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"understand what applies where (Redocly cannot dynamically change the form based on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the selected platform)."},"children":[]}]}]}],"properties":{"location":{"type":"array","items":{"type":"string","nullable":true},"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"type":{"type":"string","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitter"},"gender":{"type":"string","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"profile_language":{"type":"array","items":{"type":"string","nullable":true},"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"ai_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}]},"creator_has":{"allOf":[{"$ref":"#/components/schemas/CreatorHasRequest"}],"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"exclude_handles":{"type":"array","items":{"type":"string"},"nullable":true,"maxItems":10000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of handles to exclude from search results. Supports up to 10,000 entries. Values are normalized automatically (lowercased, @ stripped, URLs parsed to extract handle). Replaces the deprecated exclude_all parameter."},"children":[]}]}]}]},"exclude_list":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of exclusion lists to apply. Create and manage these via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Exclusion-lists"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclusion lists"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints, then pass their IDs here. Only lists for this platform are applied. Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"children":[]}]}]}]},"exclude_default_list":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, applies the team's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Exclusion-lists"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default exclusion list"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this platform. Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"children":[]}]}]}]},"exclude_all_lists":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, applies every "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Exclusion-lists"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exclusion list"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this platform — both the default list and all specific lists. Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"children":[]}]}]}]},"number_of_followers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter"},"posting_frequency":{"type":"number","format":"double","nullable":true,"description":"Supported platforms: Instagram, TikTok, YouTube"},"follower_growth":{"allOf":[{"$ref":"#/components/schemas/GrowthRequest"}],"nullable":true,"description":"Supported platforms: Instagram, TikTok"},"average_likes":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter"},"average_comments":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram, TikTok"},"average_views":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: TikTok"},"average_video_downloads":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: TikTok"},"has_tik_tok_shop":{"type":"boolean","nullable":true,"description":"Supported platforms: TikTok"},"exclude_private_profile":{"type":"boolean","nullable":true,"description":"Supported platforms: Instagram, TikTok"},"is_verified":{"type":"boolean","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"has_link_in_bio":{"type":"boolean","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"has_done_brand_deals":{"type":"boolean","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"promotes_affiliate_links":{"type":"boolean","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"does_live_streaming":{"type":"boolean","nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter"},"keywords_in_tweets":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Twitter"},"keywords_not_in_tweets":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Twitter"},"number_of_tweets":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"last_post":{"oneOf":[{"type":"string"},{"type":"integer"}],"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter"},"last_upload_long_video":{"oneOf":[{"type":"string"},{"type":"integer"}],"nullable":true,"description":"Supported platforms: YouTube"},"last_upload_short_video":{"oneOf":[{"type":"string"},{"type":"integer"}],"nullable":true,"description":"Supported platforms: YouTube"},"most_recent_stream_date":{"oneOf":[{"type":"string"},{"type":"integer"}],"nullable":true,"description":"Supported platforms: Twitch"},"last_active":{"oneOf":[{"type":"string"},{"type":"integer"}],"nullable":true,"description":"Supported platforms: OnlyFans"},"income":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram, YouTube"},"number_of_subscribers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"topics":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"keywords_in_video_titles":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"keywords_not_in_video_titles":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"keywords_in_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube, Twitch"},"keywords_not_in_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"keywords_in_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"keywords_not_in_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"exclude_keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter"},"keywords_in_captions":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram"},"keywords_not_in_captions":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram"},"link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter, Twitch"},"not_link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter, Twitch"},"links_from_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"links_from_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: YouTube"},"hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter, YouTube"},"not_hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter, YouTube"},"not_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: TikTok"},"video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: TikTok"},"tweets":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"subscriber_growth":{"allOf":[{"$ref":"#/components/schemas/GrowthRequest"}],"nullable":true,"default":{"growth_percentage":null,"time_range_months":3},"description":"Supported platforms: YouTube"},"has_shorts":{"type":"boolean","nullable":true,"description":"Supported platforms: YouTube"},"has_podcast":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: YouTube"},"has_videos":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: Instagram, OnlyFans"},"has_free_account":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: OnlyFans"},"has_live_streams":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: OnlyFans"},"has_courses":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: YouTube"},"has_membership":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: YouTube"},"has_live_videos":{"type":"boolean","nullable":true,"default":false},"shorts_percentage":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"has_community_posts":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: YouTube"},"streams_live":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: YouTube"},"has_merch":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: Instagram, YouTube, TikTok, Twitch, Twitter, OnlyFans"},"average_views_on_long_videos":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"description":"Supported platforms: YouTube"},"median_views_long":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_views_on_shorts":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"number_of_videos":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"video_count":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: TikTok"},"tweets_count":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitter"},"is_monetizing":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: YouTube"},"long_video_duration":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"average_stream_views":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"average_stream_duration":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: YouTube"},"last_stream_upload":{"oneOf":[{"type":"string"},{"type":"integer"}],"nullable":true,"description":"Supported platforms: YouTube"},"number_of_posts":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram"},"reels_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram"},"average_views_for_reels":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram"},"subscription_price":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: OnlyFans"},"number_of_photos":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: OnlyFans"},"number_of_likes":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: OnlyFans"},"followers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitch"},"active_subscribers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitch"},"streamed_hours_last_30_days":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitch"},"total_hours_streamed":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitch"},"maximum_views_count":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitch"},"avg_views_last_30_days":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"description":"Supported platforms: Twitch"},"streams_count_last_30_days":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Twitch"},"games_played":{"type":"array","items":{"type":"string","nullable":true},"nullable":true,"description":"Supported platforms: Twitch"},"is_twitch_partner":{"type":"boolean","nullable":true,"default":false,"description":"Supported platforms: Twitch"},"engagement_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true,"description":"Supported platforms: Instagram, TikTok, Twitter, YouTube"}}}},"components/schemas/DiscoveryInstagramRequest":{"id":"components/schemas/DiscoveryInstagramRequest","kind":"json-schema","title":"DiscoveryInstagramRequest","data":{"type":"object","required":["platform","paging","filters"],"properties":{"platform":{"type":"string","enum":["instagram"]},"nlp_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language brief describing who you're looking for (e.g. \"fitness creators in New York with over 100k followers\"). It's mapped to discovery filters by AI to fill in fields you didn't set — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" take precedence. The search always runs on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send; if the brief names another platform it's ignored."},"children":[]}]}]}]},"paging":{"$ref":"#/components/schemas/PagingRequest"},"sort":{"$ref":"#/components/schemas/SortRequest"},"filters":{"$ref":"#/components/schemas/InstagramDiscoveryFilters"}}}},"components/schemas/DiscoveryOnlyFansRequest":{"id":"components/schemas/DiscoveryOnlyFansRequest","kind":"json-schema","title":"DiscoveryOnlyFansRequest","data":{"type":"object","required":["platform","paging","filters"],"properties":{"platform":{"type":"string","enum":["onlyfans"]},"nlp_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language brief describing who you're looking for (e.g. \"fitness creators in New York with over 100k followers\"). It's mapped to discovery filters by AI to fill in fields you didn't set — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" take precedence. The search always runs on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send; if the brief names another platform it's ignored."},"children":[]}]}]}]},"paging":{"$ref":"#/components/schemas/PagingRequest"},"sort":{"$ref":"#/components/schemas/SortRequest"},"filters":{"$ref":"#/components/schemas/OnlyFansDiscoveryFilters"}}}},"components/schemas/DiscoverySearchResponse":{"id":"components/schemas/DiscoverySearchResponse","kind":"json-schema","title":"DiscoverySearchResponse","data":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"credits_left":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountResponse"}},"applied_filters":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective filter set the search ran with — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" layered over anything the AI inferred."},"children":[]}]}]}],"additionalProperties":{}},"nlp_search":{"$ref":"#/components/schemas/NlpSearchEcho","description":"What the AI inferred from the brief, what you overrode, and why anything was dropped."}},"required":["total","limit","credits_left"]}},"components/schemas/DiscoveryTikTokRequest":{"id":"components/schemas/DiscoveryTikTokRequest","kind":"json-schema","title":"DiscoveryTikTokRequest","data":{"type":"object","required":["platform","paging","filters"],"properties":{"platform":{"type":"string","enum":["tiktok"]},"nlp_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language brief describing who you're looking for (e.g. \"fitness creators in New York with over 100k followers\"). It's mapped to discovery filters by AI to fill in fields you didn't set — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" take precedence. The search always runs on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send; if the brief names another platform it's ignored."},"children":[]}]}]}]},"paging":{"$ref":"#/components/schemas/PagingRequest"},"sort":{"$ref":"#/components/schemas/SortRequest"},"filters":{"$ref":"#/components/schemas/TikTokDiscoveryFilters"}}}},"components/schemas/DiscoveryTwitchRequest":{"id":"components/schemas/DiscoveryTwitchRequest","kind":"json-schema","title":"DiscoveryTwitchRequest","data":{"type":"object","required":["platform","paging","filters"],"properties":{"platform":{"type":"string","enum":["twitch"]},"nlp_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language brief describing who you're looking for (e.g. \"fitness creators in New York with over 100k followers\"). It's mapped to discovery filters by AI to fill in fields you didn't set — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" take precedence. The search always runs on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send; if the brief names another platform it's ignored."},"children":[]}]}]}]},"paging":{"$ref":"#/components/schemas/PagingRequest"},"sort":{"$ref":"#/components/schemas/SortRequest"},"filters":{"$ref":"#/components/schemas/TwitchDiscoveryFilters"}}}},"components/schemas/DiscoveryTwitterRequest":{"id":"components/schemas/DiscoveryTwitterRequest","kind":"json-schema","title":"DiscoveryTwitterRequest","data":{"type":"object","required":["platform","paging","filters"],"properties":{"platform":{"type":"string","enum":["twitter"]},"nlp_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language brief describing who you're looking for (e.g. \"fitness creators in New York with over 100k followers\"). It's mapped to discovery filters by AI to fill in fields you didn't set — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" take precedence. The search always runs on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send; if the brief names another platform it's ignored."},"children":[]}]}]}]},"paging":{"$ref":"#/components/schemas/PagingRequest"},"sort":{"$ref":"#/components/schemas/SortRequest"},"filters":{"$ref":"#/components/schemas/TwitterDiscoveryFilters"}}}},"components/schemas/DiscoveryYouTubeRequest":{"id":"components/schemas/DiscoveryYouTubeRequest","kind":"json-schema","title":"DiscoveryYouTubeRequest","data":{"type":"object","required":["platform","paging","filters"],"properties":{"platform":{"type":"string","enum":["youtube"]},"nlp_search":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Natural-language brief describing who you're looking for (e.g. \"fitness creators in New York with over 100k followers\"). It's mapped to discovery filters by AI to fill in fields you didn't set — your explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" take precedence. The search always runs on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send; if the brief names another platform it's ignored."},"children":[]}]}]}]},"paging":{"$ref":"#/components/schemas/PagingRequest"},"sort":{"$ref":"#/components/schemas/SortRequest"},"filters":{"$ref":"#/components/schemas/YouTubeDiscoveryFilters"}}}},"components/schemas/EngagementModel":{"id":"components/schemas/EngagementModel","kind":"json-schema","title":"EngagementModel","data":{"type":"object","properties":{"likes":{"type":"integer","nullable":true},"comments":{"type":"integer","nullable":true},"views":{"type":"integer","nullable":true}}}},"components/schemas/EnrichAnalyticsHandleRequest":{"id":"components/schemas/EnrichAnalyticsHandleRequest","kind":"json-schema","title":"EnrichAnalyticsHandleRequest","data":{"type":"object","properties":{"handle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator identifier — username, profile URL, or YouTube channel ID (UC...)."},"children":[]}]}]}]},"platform":{"type":"string","enum":["instagram","onlyfans","tiktok","twitch","twitter","youtube"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform to enrich from — only platforms with analytics data are accepted."},"children":[]}]}]}]},"include_lookalikes":{"type":"boolean","description":"Whether to include lookalike creator recommendations in the response.","nullable":true,"default":false}},"required":["handle","platform"]}},"components/schemas/EnrichBasicEmailRequest":{"id":"components/schemas/EnrichBasicEmailRequest","kind":"json-schema","title":"EnrichBasicEmailRequest","data":{"type":"object","properties":{"email":{"type":"string","description":"The creator's email address."}},"required":["email"],"example":{"email":"creator@example.com"}}},"components/schemas/EnrichFullHandleRequest":{"id":"components/schemas/EnrichFullHandleRequest","kind":"json-schema","title":"EnrichFullHandleRequest","data":{"type":"object","properties":{"handle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator identifier — username, profile URL, or YouTube channel ID (UC...)."},"children":[]}]}]}]},"platform":{"type":"string","enum":["instagram","youtube","tiktok","onlyfans","twitter","snapchat","discord","pinterest","facebook","linkedin","twitch"],"description":"Platform to enrich from (e.g., instagram, youtube)."},"email_required":{"type":"string","enum":["must_have","preferred"],"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a validated email is required: 'must_have' rejects the match if no valid email is found (no credits charged), 'preferred' returns the match regardless. Defaults to 'preferred'."},"children":[]}]}]}],"default":"preferred"},"include_lookalikes":{"type":"boolean","description":"Whether to include lookalike creator recommendations in the response.","nullable":true,"default":false},"include_audience_data":{"type":"boolean","description":"Whether to include audience demographic data in the response.","nullable":true,"default":true}},"required":["handle","platform"],"example":{"handle":"creator_handle","platform":"instagram","email_required":"preferred","include_lookalikes":false,"include_audience_data":true}}},"components/schemas/EnrichProfileHandleRequest":{"id":"components/schemas/EnrichProfileHandleRequest","kind":"json-schema","title":"EnrichProfileHandleRequest","data":{"type":"object","properties":{"handle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator identifier — username, profile URL, or YouTube channel ID (UC...)."},"children":[]}]}]}]},"platform":{"type":"string","enum":["instagram","youtube","tiktok","onlyfans","twitter","snapchat","discord","pinterest","facebook","linkedin","twitch"],"description":"Platform to enrich from (e.g., instagram, youtube)."},"email_required":{"type":"string","enum":["must_have","preferred"],"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a validated email is required: 'must_have' rejects the match if no valid email is found (no credits charged), 'preferred' returns the match regardless. Defaults to 'preferred'."},"children":[]}]}]}],"default":"preferred"}},"required":["handle","platform"]}},"components/schemas/EnrichRawHandleRequest":{"id":"components/schemas/EnrichRawHandleRequest","kind":"json-schema","title":"EnrichRawHandleRequest","data":{"type":"object","properties":{"handle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator identifier — username, profile URL, or YouTube channel ID (UC...)."},"children":[]}]}]}]},"platform":{"type":"string","enum":["instagram","youtube","tiktok","onlyfans","twitter","snapchat","discord","pinterest","facebook","linkedin","twitch"],"description":"Platform to enrich from (e.g., instagram, youtube)."}},"required":["handle","platform"],"example":{"handle":"creator_handle","platform":"instagram"}}},"components/schemas/EnrichSimilarCreatorsRequest":{"id":"components/schemas/EnrichSimilarCreatorsRequest","kind":"json-schema","title":"EnrichSimilarCreatorsRequest","data":{"oneOf":[{"$ref":"#/components/schemas/SimilarCreatorsInstagramRequest"},{"$ref":"#/components/schemas/SimilarCreatorsYouTubeRequest"},{"$ref":"#/components/schemas/SimilarCreatorsTikTokRequest"},{"$ref":"#/components/schemas/SimilarCreatorsTwitterRequest"},{"$ref":"#/components/schemas/SimilarCreatorsTwitchRequest"},{"$ref":"#/components/schemas/SimilarCreatorsOnlyFansRequest"}],"discriminator":{"propertyName":"platform","mapping":{"instagram":"#/components/schemas/SimilarCreatorsInstagramRequest","youtube":"#/components/schemas/SimilarCreatorsYouTubeRequest","tiktok":"#/components/schemas/SimilarCreatorsTikTokRequest","twitter":"#/components/schemas/SimilarCreatorsTwitterRequest","twitch":"#/components/schemas/SimilarCreatorsTwitchRequest","onlyfans":"#/components/schemas/SimilarCreatorsOnlyFansRequest"}},"example":{"platform":"instagram","filter_key":"username","filter_value":"creator_handle","paging":{"page":0,"limit":10}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","title":"ErrorResponse","required":["error_code"],"properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true},{"type":"array","items":{}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable description of what went wrong. Shape varies per endpoint: string on most paths, DRF field-error object on validation paths of creators_api enrich/* and enrichment_batch_api create, list of strings on discovery filter validation. See the per-endpoint example response."},"children":[]}]}]}],"example":"Insufficient credits."},"error_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable snake_case slug identifying the error class. Stable across API versions; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the only field guaranteed present on every public-API error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use for programmatic branching instead of parsing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"insufficient_credits"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional long-form detail sibling to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Present on endpoints that historically returned both a short label and a long explanation (rate limits, polling, batch state, insufficient_credits on resume)."},"children":[]}]}]}],"example":"Poll every 30-60 seconds. Excessive polling results in rate limiting."},"retry_after":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seconds the caller should wait before retrying. Present on 429s where the OLD endpoint set it; mirrored in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header."},"children":[]}]}]}],"example":60},"response_meta":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echo of request metadata on a few unwrapped endpoints (notably download_batch_enrichment_csv: batch_id, batch_status). Internal-only on wrapped endpoints; stripped before reaching the client."},"children":[]}]}]}],"additionalProperties":true},"available_credits":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credits currently available. Present on the 403 insufficient_credits response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /public/v1/enrichment/batch/{id}/resume/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"required_minimum":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum credits needed. Pairs with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available_credits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"current_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current resource state. Present on 400 responses where the operation requires a different state (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch_not_ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch_not_resumable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"active_batches":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active batch count when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code: batch_limit_reached"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"max_allowed":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-client batch ceiling. Pairs with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loose union of every public-API error body. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is guaranteed present; everything else varies per endpoint. See public_api/ERROR_HANDLING.md for the error_code taxonomy and per-endpoint shape notes."},"children":[]}]}]}]}},"components/schemas/EventCreator":{"id":"components/schemas/EventCreator","kind":"json-schema","title":"EventCreator","data":{"type":"object","properties":{"platform":{"type":"string","description":"The creator's social media platform."},"platform_id":{"type":"string","description":"The creator's handle on the platform."}},"required":["platform","platform_id"]}},"components/schemas/EventDelivery":{"id":"components/schemas/EventDelivery","kind":"json-schema","title":"EventDelivery","data":{"type":"object","properties":{"id":{"type":"integer"},"endpoint":{"$ref":"#/components/schemas/NotifyEndpoint","description":"The notify endpoint this delivery was sent to."},"status":{"type":"string"},"retries":{"type":"integer"},"status_code":{"type":"integer","nullable":true},"response_time":{"type":"number","format":"double","nullable":true},"sent_date":{"type":"string","format":"date-time","nullable":true},"redeliver_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","endpoint","status","retries","created_at","updated_at"]}},"components/schemas/EventDetail":{"id":"components/schemas/EventDetail","kind":"json-schema","title":"EventDetail","data":{"type":"object","properties":{"payload":{"type":"string","description":"The webhook payload exactly as it was sent to the endpoint."},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/EventDelivery"},"description":"Full delivery history for the event."}},"required":["deliveries"]}},"components/schemas/EventListPage":{"id":"components/schemas/EventListPage","kind":"json-schema","title":"EventListPage","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of events matching the filter."},"next":{"type":"string","format":"uri","description":"URL of the next page, or null on the last page.","nullable":true},"previous":{"type":"string","format":"uri","description":"URL of the previous page, or null on the first page.","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/EventResponse"},"description":"Events on the current page."}},"required":["count","results"]}},"components/schemas/EventResponse":{"id":"components/schemas/EventResponse","kind":"json-schema","title":"EventResponse","data":{"type":"object","properties":{"id":{"type":"integer"},"event_type":{"type":"string"},"event_value":{"type":"object","nullable":true,"additionalProperties":{}},"creator":{"$ref":"#/components/schemas/EventCreator","description":"The creator the event fired for."},"date_occurance":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"delivery_status":{"type":"string","description":"Delivery status of the event (pending/sending/sent/failed/retrying)."},"latency_seconds":{"type":"string","description":"Response time of the first successful delivery, in seconds."},"retries":{"type":"string","description":"Total retry count across all delivery attempts."}},"required":["id","event_type","creator","date_occurance","created_at"]}},"components/schemas/ExclusionEntriesInputRequest":{"id":"components/schemas/ExclusionEntriesInputRequest","kind":"json-schema","title":"ExclusionEntriesInputRequest","data":{"type":"object","properties":{"handles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handles to add to or remove from the list. Normalized automatically (lowercased, @ stripped, URLs parsed to extract the handle)."},"children":[]}]}]}]}},"required":["handles"]}},"components/schemas/ExclusionEntriesResponse":{"id":"components/schemas/ExclusionEntriesResponse","kind":"json-schema","title":"ExclusionEntriesResponse","data":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of handles in the list."},"offset":{"type":"integer","description":"Offset applied to this page of handles."},"limit":{"type":"integer","description":"Limit applied to this page of handles."},"handles":{"type":"array","items":{"type":"string"},"description":"The requested page of handles, sorted alphabetically."}},"required":["total","offset","limit","handles"],"example":{"total":3,"offset":0,"limit":1000,"handles":["creator_one","creator_three","creator_two"]}}},"components/schemas/ExclusionList":{"id":"components/schemas/ExclusionList","kind":"json-schema","title":"ExclusionList","data":{"type":"object","properties":{"id":{"type":"integer","description":"The exclusion list's unique identifier."},"name":{"type":"string","description":"Human-readable name of the exclusion list."},"platform":{"type":"string","description":"The social media platform this list applies to."},"is_default":{"type":"boolean","description":"Whether this is the team's default list for the platform."},"handle_count":{"type":"integer","description":"Number of handles currently in the list."},"created_at":{"type":"string","format":"date-time","description":"When the list was created."},"updated_at":{"type":"string","format":"date-time","description":"When the list was last modified."}},"required":["id","name","platform","is_default","handle_count","created_at","updated_at"],"example":{"id":42,"name":"Blocklist Q4","platform":"instagram","is_default":false,"handle_count":3,"created_at":"2026-01-15T09:30:00Z","updated_at":"2026-01-20T14:05:00Z"}}},"components/schemas/ExclusionListCreateRequest":{"id":"components/schemas/ExclusionListCreateRequest","kind":"json-schema","title":"ExclusionListCreateRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable name for the new exclusion list."},"platform":{"type":"string","enum":["instagram","youtube","tiktok","twitch","twitter","onlyfans"],"description":"The social media platform this list applies to."}},"required":["name","platform"]}},"components/schemas/ExclusionListUpdateRequest":{"id":"components/schemas/ExclusionListUpdateRequest","kind":"json-schema","title":"ExclusionListUpdateRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"New name for the exclusion list."}},"required":["name"]}},"components/schemas/Growth":{"id":"components/schemas/Growth","kind":"json-schema","title":"Growth","data":{"type":"object","properties":{"growth_percentage":{"type":"number","format":"double","nullable":true},"time_range_months":{"type":"integer","nullable":true,"default":3}}}},"components/schemas/GrowthRequest":{"id":"components/schemas/GrowthRequest","kind":"json-schema","title":"GrowthRequest","data":{"type":"object","properties":{"growth_percentage":{"type":"number","format":"double","nullable":true},"time_range_months":{"type":"integer","nullable":true,"default":3}}}},"components/schemas/HandleAnalyticsInstagramResponse":{"id":"components/schemas/HandleAnalyticsInstagramResponse","kind":"json-schema","title":"HandleAnalyticsInstagramResponse","data":{"type":"object","properties":{"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceDataResponse"}],"nullable":true},"brand_affinity":{"type":"array","items":{"$ref":"#/components/schemas/BrandAffinityResponse"}},"brands_found":{"type":"array","items":{"type":"object","additionalProperties":{}}},"comments_median":{"type":"number","format":"double","nullable":true},"creator_follower_growth":{"type":"object","nullable":true,"additionalProperties":{}},"has_merch":{"type":"boolean"},"hashtags":{"type":"array","items":{"type":"string"}},"hashtags_count":{"type":"array","items":{"type":"object","additionalProperties":{}}},"income":{"type":"object","nullable":true,"additionalProperties":{}},"likes_median":{"type":"number","format":"double","nullable":true},"locations":{"type":"array","items":{"type":"string"}},"niche_sub_class":{"type":"array","items":{"type":"string"}},"past_sponsors":{"type":"array","items":{"$ref":"#/components/schemas/PastSponsorResponse"}},"posting_frequency_recent_months":{"type":"number","format":"double","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"reels":{"type":"object","nullable":true,"additionalProperties":{}},"reels_percentage_last_12_posts":{"type":"number","format":"double","nullable":true},"sponsored_posts":{"type":"array","items":{"$ref":"#/components/schemas/SponsoredPostResponse"}},"tagged":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"components/schemas/HandleAnalyticsOnlyfansResponse":{"id":"components/schemas/HandleAnalyticsOnlyfansResponse","kind":"json-schema","title":"HandleAnalyticsOnlyfansResponse","data":{"type":"object","properties":{"archived_posts_count":{"type":"integer","nullable":true},"audios_count":{"type":"integer","nullable":true},"avg_durations":{"type":"number","format":"double","nullable":true},"comments_median":{"type":"number","format":"double","nullable":true},"finished_streams_count":{"type":"integer","nullable":true},"has_merch":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"is_spotify_connected":{"type":"boolean"},"likes_median":{"type":"number","format":"double","nullable":true},"photos_count":{"type":"integer","nullable":true},"post_dates":{"type":"array","items":{"type":"string"}},"post_durations":{"type":"array","items":{"type":"number","format":"double"}},"posts_count":{"type":"integer","nullable":true},"private_archived_posts_count":{"type":"integer","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"referal_bonus_sum_for_referer":{"type":"integer","nullable":true},"tips_enabled":{"type":"boolean"},"tips_max":{"type":"integer","nullable":true},"tips_min":{"type":"integer","nullable":true},"tips_min_internal":{"type":"integer","nullable":true},"tips_text_enabled":{"type":"boolean"},"total_likes":{"type":"integer","nullable":true},"videos_count":{"type":"integer","nullable":true}}}},"components/schemas/HandleAnalyticsPlatformResponse":{"id":"components/schemas/HandleAnalyticsPlatformResponse","kind":"json-schema","title":"HandleAnalyticsPlatformResponse","data":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/HandleAnalyticsResultResponse"},"credits_cost":{"type":"number","format":"double","nullable":true,"example":0.8}}}},"components/schemas/HandleAnalyticsResultResponse":{"id":"components/schemas/HandleAnalyticsResultResponse","kind":"json-schema","title":"HandleAnalyticsResultResponse","data":{"type":"object","properties":{"audience_interests":{"type":"array","items":{"type":"object","additionalProperties":{}}},"lookalikes":{"type":"array","items":{"type":"object","additionalProperties":{}}},"instagram":{"$ref":"#/components/schemas/HandleAnalyticsInstagramResponse"},"youtube":{"$ref":"#/components/schemas/HandleAnalyticsYoutubeResponse"},"tiktok":{"$ref":"#/components/schemas/HandleAnalyticsTiktokResponse"},"onlyfans":{"$ref":"#/components/schemas/HandleAnalyticsOnlyfansResponse"},"twitter":{"$ref":"#/components/schemas/HandleAnalyticsTwitterResponse"},"twitch":{"$ref":"#/components/schemas/HandleAnalyticsTwitchResponse"}}}},"components/schemas/HandleAnalyticsTiktokResponse":{"id":"components/schemas/HandleAnalyticsTiktokResponse","kind":"json-schema","title":"HandleAnalyticsTiktokResponse","data":{"type":"object","properties":{"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceDataResponse"}],"nullable":true},"brands_found":{"type":"array","items":{"type":"string"}},"challenges_list":{"type":"array","items":{"type":"string"}},"comment_count_avg":{"type":"number","format":"double","nullable":true},"comments_median":{"type":"number","format":"double","nullable":true},"creator_follower_growth":{"type":"object","nullable":true,"additionalProperties":{}},"duration_avg":{"type":"number","format":"double","nullable":true},"has_merch":{"type":"boolean"},"hashtags":{"type":"array","items":{"type":"string"}},"likes_median":{"type":"number","format":"double","nullable":true},"niche_sub_class":{"type":"array","items":{"type":"string"}},"play_count_avg":{"type":"number","format":"double","nullable":true},"play_count_median":{"type":"number","format":"double","nullable":true},"posting_frequency":{"type":"integer","nullable":true},"posting_frequency_recent_months":{"type":"number","format":"double","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"reach_score":{"type":"number","format":"double","nullable":true},"reach_score_list":{"type":"array","items":{"type":"number","format":"double"}},"saves_count_list":{"type":"array","items":{"type":"integer"}},"saves_median":{"type":"number","format":"double","nullable":true},"shares_median":{"type":"number","format":"double","nullable":true},"tagged":{"type":"array","items":{"type":"string"}},"total_likes":{"type":"integer","nullable":true},"total_saves":{"type":"integer","nullable":true},"total_shares":{"type":"integer","nullable":true}}}},"components/schemas/HandleAnalyticsTwitchResponse":{"id":"components/schemas/HandleAnalyticsTwitchResponse","kind":"json-schema","title":"HandleAnalyticsTwitchResponse","data":{"type":"object","properties":{"avg_views":{"type":"number","format":"double","nullable":true},"has_merch":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"last_broadcast_game":{"type":"string","nullable":true},"last_broadcast_id":{"type":"string","nullable":true},"last_streamed":{"type":"string","nullable":true},"primary_team_display_name":{"type":"string","nullable":true},"primary_team_name":{"type":"string","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"streamed_hours_last_30_days":{"type":"number","format":"double","nullable":true},"streams_count_last_30_days":{"type":"integer","nullable":true}}}},"components/schemas/HandleAnalyticsTwitterResponse":{"id":"components/schemas/HandleAnalyticsTwitterResponse","kind":"json-schema","title":"HandleAnalyticsTwitterResponse","data":{"type":"object","properties":{"avg_quotes":{"type":"number","format":"double","nullable":true},"avg_reply":{"type":"number","format":"double","nullable":true},"avg_retweet":{"type":"number","format":"double","nullable":true},"avg_views":{"type":"number","format":"double","nullable":true},"creator_favorite_count":{"type":"integer","nullable":true},"has_merch":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"hashtags":{"type":"array","items":{"type":"string"}},"languages_tweet":{"type":"array","items":{"type":"string"}},"platforms":{"type":"object","nullable":true,"additionalProperties":{}},"promotes_affiliate_links":{"type":"boolean"},"recommended_users":{"type":"array","items":{"type":"string"}},"retweet_users":{"type":"array","items":{"type":"string"}},"retweets_count":{"type":"array","items":{"type":"string"}},"tagged":{"type":"array","items":{"type":"string"}},"tagged_usernames":{"type":"array","items":{"type":"string"}},"tweets_count":{"type":"integer","nullable":true},"tweets_frequency_recent_months":{"type":"number","format":"double","nullable":true},"tweets_type":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleAnalyticsYoutubeResponse":{"id":"components/schemas/HandleAnalyticsYoutubeResponse","kind":"json-schema","title":"HandleAnalyticsYoutubeResponse","data":{"type":"object","properties":{"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceDataResponse"}],"nullable":true},"avg_views_long":{"type":"number","format":"double","nullable":true},"avg_views_shorts":{"type":"number","format":"double","nullable":true},"engagement_by_comments_and_views_long":{"type":"number","format":"double","nullable":true},"engagement_by_comments_and_views_shorts":{"type":"number","format":"double","nullable":true},"engagement_by_likes_and_views_long":{"type":"number","format":"double","nullable":true},"engagement_by_likes_and_views_shorts":{"type":"number","format":"double","nullable":true},"engagement_by_views_and_subs_long":{"type":"number","format":"double","nullable":true},"engagement_by_views_and_subs_shorts":{"type":"number","format":"double","nullable":true},"engagement_percent_long":{"type":"number","format":"double","nullable":true},"engagement_percent_shorts":{"type":"number","format":"double","nullable":true},"hashtags_count":{"type":"array","items":{"type":"object","additionalProperties":{}}},"income":{"type":"object","nullable":true,"additionalProperties":{}},"keywords":{"type":"array","items":{"type":"string"}},"last_long_video_upload_date":{"type":"string","nullable":true},"last_short_video_upload_date":{"type":"string","nullable":true},"least_views":{"type":"integer","nullable":true},"median_views_long":{"type":"number","format":"double","nullable":true},"niche_sub_class":{"type":"array","items":{"type":"string"}},"posting_frequency":{"type":"number","format":"double","nullable":true},"posting_frequency_long":{"type":"number","format":"double","nullable":true},"posting_frequency_recent_months":{"type":"number","format":"double","nullable":true},"posting_frequency_shorts":{"type":"number","format":"double","nullable":true},"posts_per_month":{"type":"object","nullable":true,"additionalProperties":{}},"promotes_affiliate_links":{"type":"boolean"},"shorts_percentage":{"type":"number","format":"double","nullable":true},"topic_details":{"type":"array","items":{"type":"string"}},"total_comments_last_50":{"type":"integer","nullable":true},"video_categories":{"type":"array","items":{"type":"string"}},"video_hashtags":{"type":"array","items":{"type":"string"}},"video_tags":{"type":"array","items":{"type":"string"}},"video_topics":{"type":"array","items":{"type":"string"}}}}},"components/schemas/HandleEmailPlatformResponse":{"id":"components/schemas/HandleEmailPlatformResponse","kind":"json-schema","title":"HandleEmailPlatformResponse","data":{"type":"object","properties":{"platform":{"type":"string","description":"The creator's social media platform.","nullable":true},"userId":{"type":"string","nullable":true},"url":{"type":"string","description":"The creator's profile URL.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"fullname":{"type":"string","nullable":true},"picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"followers":{"type":"integer","nullable":true}}}},"components/schemas/HandleEmailResponse":{"id":"components/schemas/HandleEmailResponse","kind":"json-schema","title":"HandleEmailResponse","data":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/HandleEmailPlatformResponse"},"credits_cost":{"type":"number","format":"double","nullable":true,"example":0.05}}}},"components/schemas/HandleFullFacebookResponse":{"id":"components/schemas/HandleFullFacebookResponse","kind":"json-schema","title":"HandleFullFacebookResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"user_info":{"type":"object","nullable":true,"additionalProperties":{}},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"post_data":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleFullInstagramResponse":{"id":"components/schemas/HandleFullInstagramResponse","kind":"json-schema","title":"HandleFullInstagramResponse","data":{"type":"object","properties":{"account_type":{"type":"integer","nullable":true},"avg_comments":{"type":"number","format":"double","nullable":true},"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact_phone_number":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"has_profile_pic":{"type":"boolean"},"is_business_account":{"type":"boolean"},"is_private":{"type":"boolean"},"is_verified":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"location_source":{"type":"array","items":{"type":"string"}},"media_count":{"type":"integer","nullable":true},"most_recent_post_date":{"type":"string","nullable":true},"niche_class":{"type":"array","items":{"type":"string"}},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"state":{"type":"string","nullable":true},"streamer":{"type":"boolean"},"userid":{"type":"string","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"},"video_content_creator":{"type":"boolean"},"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceDataResponse"}],"nullable":true},"brand_affinity":{"type":"array","items":{"$ref":"#/components/schemas/BrandAffinityResponse"}},"brands_found":{"type":"array","items":{"type":"object","additionalProperties":{}}},"comments_median":{"type":"number","format":"double","nullable":true},"creator_follower_growth":{"type":"object","nullable":true,"additionalProperties":{}},"has_merch":{"type":"boolean"},"hashtags":{"type":"array","items":{"type":"string"}},"hashtags_count":{"type":"array","items":{"type":"object","additionalProperties":{}}},"income":{"type":"object","nullable":true,"additionalProperties":{}},"likes_median":{"type":"number","format":"double","nullable":true},"locations":{"type":"array","items":{"type":"string"}},"niche_sub_class":{"type":"array","items":{"type":"string"}},"past_sponsors":{"type":"array","items":{"$ref":"#/components/schemas/PastSponsorResponse"}},"posting_frequency_recent_months":{"type":"number","format":"double","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"reels":{"type":"object","nullable":true,"additionalProperties":{}},"reels_percentage_last_12_posts":{"type":"number","format":"double","nullable":true},"sponsored_posts":{"type":"array","items":{"$ref":"#/components/schemas/SponsoredPostResponse"}},"tagged":{"type":"array","items":{"type":"object","additionalProperties":{}}},"post_data":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleFullLinkedinResponse":{"id":"components/schemas/HandleFullLinkedinResponse","kind":"json-schema","title":"HandleFullLinkedinResponse","data":{"type":"object","properties":{"biography":{"type":"string","nullable":true},"connections":{"type":"integer","nullable":true},"first_name":{"type":"string","nullable":true},"follower_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"hashtags":{"type":"array","items":{"type":"string"}},"is_verified":{"type":"boolean"},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"posts":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"components/schemas/HandleFullOnlyfansResponse":{"id":"components/schemas/HandleFullOnlyfansResponse","kind":"json-schema","title":"HandleFullOnlyfansResponse","data":{"type":"object","properties":{"avg_comments":{"type":"number","format":"double","nullable":true},"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"can_chat":{"type":"boolean"},"can_create_promotion":{"type":"boolean"},"can_earn":{"type":"boolean"},"can_receive_chat_message":{"type":"boolean"},"country":{"type":"string","nullable":true},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"first_name":{"type":"string","nullable":true},"first_published_post_date":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"is_adult_content":{"type":"boolean"},"is_real_performer":{"type":"boolean"},"is_verified":{"type":"boolean"},"join_date":{"type":"string","nullable":true},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"linktree":{"type":"string","nullable":true},"location_source":{"type":"array","items":{"type":"string"}},"media_count":{"type":"integer","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"streamer":{"type":"boolean"},"subscribe_price":{"type":"integer","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"},"archived_posts_count":{"type":"integer","nullable":true},"audios_count":{"type":"integer","nullable":true},"avg_durations":{"type":"number","format":"double","nullable":true},"comments_median":{"type":"number","format":"double","nullable":true},"finished_streams_count":{"type":"integer","nullable":true},"has_merch":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"is_spotify_connected":{"type":"boolean"},"likes_median":{"type":"number","format":"double","nullable":true},"photos_count":{"type":"integer","nullable":true},"post_dates":{"type":"array","items":{"type":"string"}},"post_durations":{"type":"array","items":{"type":"number","format":"double"}},"posts_count":{"type":"integer","nullable":true},"private_archived_posts_count":{"type":"integer","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"referal_bonus_sum_for_referer":{"type":"integer","nullable":true},"tips_enabled":{"type":"boolean"},"tips_max":{"type":"integer","nullable":true},"tips_min":{"type":"integer","nullable":true},"tips_min_internal":{"type":"integer","nullable":true},"tips_text_enabled":{"type":"boolean"},"total_likes":{"type":"integer","nullable":true},"videos_count":{"type":"integer","nullable":true}}}},"components/schemas/HandleFullPinterestResponse":{"id":"components/schemas/HandleFullPinterestResponse","kind":"json-schema","title":"HandleFullPinterestResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"pk":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"user_info":{"type":"object","nullable":true,"additionalProperties":{}},"user_media":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleFullPlatformResponse":{"id":"components/schemas/HandleFullPlatformResponse","kind":"json-schema","title":"HandleFullPlatformResponse","data":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/HandleFullResultResponse"},"credits_cost":{"type":"number","format":"double","nullable":true,"example":1}}}},"components/schemas/HandleFullResultResponse":{"id":"components/schemas/HandleFullResultResponse","kind":"json-schema","title":"HandleFullResultResponse","data":{"type":"object","properties":{"age_group":{"type":"object","nullable":true,"additionalProperties":{}},"creator_has":{"type":"object","nullable":true,"additionalProperties":{}},"email":{"type":"string","format":"email","description":"The creator's email address.","nullable":true},"email_type":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"has_brand_deals":{"type":"boolean"},"has_link_in_bio":{"type":"boolean"},"instagram_link":{"type":"string","nullable":true},"is_business":{"type":"boolean"},"is_creator":{"type":"boolean"},"linkedin_link":{"type":"string","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"onlyfans_link":{"type":"string","nullable":true},"other_links":{"type":"array","items":{"type":"string"}},"patreon_link":{"type":"string","nullable":true},"speaking_language":{"type":"string","nullable":true},"tiktok_link":{"type":"string","nullable":true},"twitch_link":{"type":"string","nullable":true},"twitter_link":{"type":"string","nullable":true},"youtube_link":{"type":"string","nullable":true},"instagram":{"$ref":"#/components/schemas/HandleFullInstagramResponse"},"youtube":{"$ref":"#/components/schemas/HandleFullYoutubeResponse"},"tiktok":{"$ref":"#/components/schemas/HandleFullTiktokResponse"},"onlyfans":{"$ref":"#/components/schemas/HandleFullOnlyfansResponse"},"twitter":{"$ref":"#/components/schemas/HandleFullTwitterResponse"},"twitch":{"$ref":"#/components/schemas/HandleFullTwitchResponse"},"linkedin":{"$ref":"#/components/schemas/HandleFullLinkedinResponse"},"facebook":{"$ref":"#/components/schemas/HandleFullFacebookResponse"},"pinterest":{"$ref":"#/components/schemas/HandleFullPinterestResponse"},"snapchat":{"$ref":"#/components/schemas/HandleProfileSnapchatResponse"},"discord":{"$ref":"#/components/schemas/HandleProfileDiscordResponse"},"audience_interests":{"type":"array","items":{"type":"object","additionalProperties":{}}},"lookalikes":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"components/schemas/HandleFullTiktokResponse":{"id":"components/schemas/HandleFullTiktokResponse","kind":"json-schema","title":"HandleFullTiktokResponse","data":{"type":"object","properties":{"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"duet_setting":{"type":"boolean"},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"is_ad":{"type":"boolean"},"is_commerce":{"type":"boolean"},"is_private":{"type":"boolean"},"is_verified":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"mention_status":{"type":"string","nullable":true},"most_recent_post_date":{"type":"string","nullable":true},"niche_class":{"type":"array","items":{"type":"string"}},"paid_partnership":{"type":"boolean"},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"region":{"type":"string","nullable":true},"sec_user_id":{"type":"string","nullable":true},"streamer":{"type":"boolean"},"tt_seller":{"type":"boolean","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"},"video_count":{"type":"integer","nullable":true},"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceDataResponse"}],"nullable":true},"brands_found":{"type":"array","items":{"type":"string"}},"challenges_list":{"type":"array","items":{"type":"string"}},"comment_count_avg":{"type":"number","format":"double","nullable":true},"comments_median":{"type":"number","format":"double","nullable":true},"creator_follower_growth":{"type":"object","nullable":true,"additionalProperties":{}},"duration_avg":{"type":"number","format":"double","nullable":true},"has_merch":{"type":"boolean"},"hashtags":{"type":"array","items":{"type":"string"}},"likes_median":{"type":"number","format":"double","nullable":true},"niche_sub_class":{"type":"array","items":{"type":"string"}},"play_count_avg":{"type":"number","format":"double","nullable":true},"play_count_median":{"type":"number","format":"double","nullable":true},"posting_frequency":{"type":"integer","nullable":true},"posting_frequency_recent_months":{"type":"number","format":"double","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"reach_score":{"type":"number","format":"double","nullable":true},"reach_score_list":{"type":"array","items":{"type":"number","format":"double"}},"saves_count_list":{"type":"array","items":{"type":"integer"}},"saves_median":{"type":"number","format":"double","nullable":true},"shares_median":{"type":"number","format":"double","nullable":true},"tagged":{"type":"array","items":{"type":"string"}},"total_likes":{"type":"integer","nullable":true},"total_saves":{"type":"integer","nullable":true},"total_shares":{"type":"integer","nullable":true},"post_data":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleFullTwitchResponse":{"id":"components/schemas/HandleFullTwitchResponse","kind":"json-schema","title":"HandleFullTwitchResponse","data":{"type":"object","properties":{"description":{"type":"string","nullable":true},"displayName":{"type":"string","nullable":true},"isPartner":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"other_links":{"type":"array","items":{"type":"string"}},"panels_descriptions":{"type":"array","items":{"type":"string"}},"panels_image":{"type":"array","items":{"type":"string"}},"panels_titles":{"type":"array","items":{"type":"string"}},"panels_type":{"type":"array","items":{"type":"string"}},"panels_urls":{"type":"array","items":{"type":"string"}},"profileImageURL":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"social_media":{"type":"object","nullable":true,"additionalProperties":{}},"total_followers":{"type":"integer","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"avg_views":{"type":"number","format":"double","nullable":true},"has_merch":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"last_broadcast_game":{"type":"string","nullable":true},"last_broadcast_id":{"type":"string","nullable":true},"last_streamed":{"type":"string","nullable":true},"primary_team_display_name":{"type":"string","nullable":true},"primary_team_name":{"type":"string","nullable":true},"promotes_affiliate_links":{"type":"boolean"},"streamed_hours_last_30_days":{"type":"number","format":"double","nullable":true},"streams_count_last_30_days":{"type":"integer","nullable":true},"post_data":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleFullTwitterResponse":{"id":"components/schemas/HandleFullTwitterResponse","kind":"json-schema","title":"HandleFullTwitterResponse","data":{"type":"object","properties":{"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"direct_messaging":{"type":"boolean"},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"is_verified":{"type":"boolean"},"join_date":{"type":"string","nullable":true},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"location_source":{"type":"string","nullable":true},"media_count":{"type":"integer","nullable":true},"most_recent_post_date":{"type":"string","nullable":true},"other_links":{"type":"array","items":{"type":"string"}},"patreon":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"streamer":{"type":"boolean"},"subscriber_button":{"type":"boolean"},"super_followed_by":{"type":"boolean"},"userid":{"type":"string","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"},"avg_quotes":{"type":"number","format":"double","nullable":true},"avg_reply":{"type":"number","format":"double","nullable":true},"avg_retweet":{"type":"number","format":"double","nullable":true},"avg_views":{"type":"number","format":"double","nullable":true},"creator_favorite_count":{"type":"integer","nullable":true},"has_merch":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"hashtags":{"type":"array","items":{"type":"string"}},"languages_tweet":{"type":"array","items":{"type":"string"}},"platforms":{"type":"object","nullable":true,"additionalProperties":{}},"promotes_affiliate_links":{"type":"boolean"},"recommended_users":{"type":"array","items":{"type":"string"}},"retweet_users":{"type":"array","items":{"type":"string"}},"retweets_count":{"type":"array","items":{"type":"string"}},"tagged":{"type":"array","items":{"type":"string"}},"tagged_usernames":{"type":"array","items":{"type":"string"}},"tweets_count":{"type":"integer","nullable":true},"tweets_frequency_recent_months":{"type":"number","format":"double","nullable":true},"tweets_type":{"type":"object","nullable":true,"additionalProperties":{}},"post_data":{"type":"object","nullable":true,"additionalProperties":{}},"tweets":{"type":"array","items":{"type":"string"}}}}},"components/schemas/HandleFullYoutubeResponse":{"id":"components/schemas/HandleFullYoutubeResponse","kind":"json-schema","title":"HandleFullYoutubeResponse","data":{"type":"object","properties":{"avg_comments":{"type":"integer","nullable":true},"avg_likes":{"type":"number","format":"double","nullable":true},"avg_views":{"type":"number","format":"double","nullable":true},"country":{"type":"string","nullable":true},"custom_url":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"first_name":{"type":"string","nullable":true},"has_community_posts":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"has_shorts":{"type":"boolean"},"id":{"type":"string","nullable":true},"is_monetization_enabled":{"type":"boolean"},"is_verified":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"link":{"type":"string","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"made_for_kids":{"type":"boolean"},"moderate_comments":{"type":"boolean"},"most_recent_post_date":{"type":"string","nullable":true},"niche_class":{"type":"array","items":{"type":"string"}},"privacy_status":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"published_at":{"type":"string","nullable":true},"related_playlist_id":{"type":"string","nullable":true},"streamer":{"type":"boolean"},"subscriber_count":{"type":"integer","nullable":true},"title":{"type":"string","nullable":true},"unsubscribed_trailer_id":{"type":"string","nullable":true},"uses_link_in_bio":{"type":"boolean"},"video_count":{"type":"integer","nullable":true},"view_count":{"type":"integer","nullable":true},"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceDataResponse"}],"nullable":true},"avg_views_long":{"type":"number","format":"double","nullable":true},"avg_views_shorts":{"type":"number","format":"double","nullable":true},"engagement_by_comments_and_views_long":{"type":"number","format":"double","nullable":true},"engagement_by_comments_and_views_shorts":{"type":"number","format":"double","nullable":true},"engagement_by_likes_and_views_long":{"type":"number","format":"double","nullable":true},"engagement_by_likes_and_views_shorts":{"type":"number","format":"double","nullable":true},"engagement_by_views_and_subs_long":{"type":"number","format":"double","nullable":true},"engagement_by_views_and_subs_shorts":{"type":"number","format":"double","nullable":true},"engagement_percent_long":{"type":"number","format":"double","nullable":true},"engagement_percent_shorts":{"type":"number","format":"double","nullable":true},"hashtags_count":{"type":"array","items":{"type":"object","additionalProperties":{}}},"income":{"type":"object","nullable":true,"additionalProperties":{}},"keywords":{"type":"array","items":{"type":"string"}},"last_long_video_upload_date":{"type":"string","nullable":true},"last_short_video_upload_date":{"type":"string","nullable":true},"least_views":{"type":"integer","nullable":true},"median_views_long":{"type":"number","format":"double","nullable":true},"niche_sub_class":{"type":"array","items":{"type":"string"}},"posting_frequency":{"type":"number","format":"double","nullable":true},"posting_frequency_long":{"type":"number","format":"double","nullable":true},"posting_frequency_recent_months":{"type":"number","format":"double","nullable":true},"posting_frequency_shorts":{"type":"number","format":"double","nullable":true},"posts_per_month":{"type":"object","nullable":true,"additionalProperties":{}},"promotes_affiliate_links":{"type":"boolean"},"shorts_percentage":{"type":"number","format":"double","nullable":true},"topic_details":{"type":"array","items":{"type":"string"}},"total_comments_last_50":{"type":"integer","nullable":true},"video_categories":{"type":"array","items":{"type":"string"}},"video_hashtags":{"type":"array","items":{"type":"string"}},"video_tags":{"type":"array","items":{"type":"string"}},"video_topics":{"type":"array","items":{"type":"string"}},"post_data":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleProfileDiscordResponse":{"id":"components/schemas/HandleProfileDiscordResponse","kind":"json-schema","title":"HandleProfileDiscordResponse","data":{"type":"object","properties":{"type":{"type":"integer","nullable":true},"code":{"type":"string","nullable":true},"id":{"type":"integer","nullable":true},"inviter":{"type":"object","nullable":true,"additionalProperties":{}},"expires_at":{"type":"string","nullable":true},"flags":{"type":"integer","nullable":true},"guild":{"type":"object","nullable":true,"additionalProperties":{}},"profile":{"type":"object","nullable":true,"additionalProperties":{}},"liveliness":{"type":"object","nullable":true,"additionalProperties":{}},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true}}}},"components/schemas/HandleProfileFacebookResponse":{"id":"components/schemas/HandleProfileFacebookResponse","kind":"json-schema","title":"HandleProfileFacebookResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"user_info":{"type":"object","nullable":true,"additionalProperties":{}},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true}}}},"components/schemas/HandleProfileInstagramResponse":{"id":"components/schemas/HandleProfileInstagramResponse","kind":"json-schema","title":"HandleProfileInstagramResponse","data":{"type":"object","properties":{"account_type":{"type":"integer","nullable":true},"avg_comments":{"type":"number","format":"double","nullable":true},"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"contact_phone_number":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"has_profile_pic":{"type":"boolean"},"is_business_account":{"type":"boolean"},"is_private":{"type":"boolean"},"is_verified":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"location_source":{"type":"array","items":{"type":"string"}},"media_count":{"type":"integer","nullable":true},"most_recent_post_date":{"type":"string","nullable":true},"niche_class":{"type":"array","items":{"type":"string"}},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"state":{"type":"string","nullable":true},"streamer":{"type":"boolean"},"userid":{"type":"string","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"},"video_content_creator":{"type":"boolean"}}}},"components/schemas/HandleProfileLinkedinResponse":{"id":"components/schemas/HandleProfileLinkedinResponse","kind":"json-schema","title":"HandleProfileLinkedinResponse","data":{"type":"object","properties":{"biography":{"type":"string","nullable":true},"connections":{"type":"integer","nullable":true},"first_name":{"type":"string","nullable":true},"follower_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"hashtags":{"type":"array","items":{"type":"string"}},"is_verified":{"type":"boolean"},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true}}}},"components/schemas/HandleProfileOnlyfansResponse":{"id":"components/schemas/HandleProfileOnlyfansResponse","kind":"json-schema","title":"HandleProfileOnlyfansResponse","data":{"type":"object","properties":{"avg_comments":{"type":"number","format":"double","nullable":true},"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"can_chat":{"type":"boolean"},"can_create_promotion":{"type":"boolean"},"can_earn":{"type":"boolean"},"can_receive_chat_message":{"type":"boolean"},"country":{"type":"string","nullable":true},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"first_name":{"type":"string","nullable":true},"first_published_post_date":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"is_adult_content":{"type":"boolean"},"is_real_performer":{"type":"boolean"},"is_verified":{"type":"boolean"},"join_date":{"type":"string","nullable":true},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"linktree":{"type":"string","nullable":true},"location_source":{"type":"array","items":{"type":"string"}},"media_count":{"type":"integer","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"streamer":{"type":"boolean"},"subscribe_price":{"type":"integer","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"}}}},"components/schemas/HandleProfilePinterestResponse":{"id":"components/schemas/HandleProfilePinterestResponse","kind":"json-schema","title":"HandleProfilePinterestResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"pk":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"user_info":{"type":"object","nullable":true,"additionalProperties":{}}}}},"components/schemas/HandleProfilePlatformResponse":{"id":"components/schemas/HandleProfilePlatformResponse","kind":"json-schema","title":"HandleProfilePlatformResponse","data":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/HandleProfileResultResponse"},"credits_cost":{"type":"number","format":"double","nullable":true,"example":0.2}}}},"components/schemas/HandleProfileResultResponse":{"id":"components/schemas/HandleProfileResultResponse","kind":"json-schema","title":"HandleProfileResultResponse","data":{"type":"object","properties":{"age_group":{"type":"object","nullable":true,"additionalProperties":{}},"creator_has":{"type":"object","nullable":true,"additionalProperties":{}},"email":{"type":"string","format":"email","description":"The creator's email address.","nullable":true},"email_type":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"has_brand_deals":{"type":"boolean"},"has_link_in_bio":{"type":"boolean"},"instagram_link":{"type":"string","nullable":true},"is_business":{"type":"boolean"},"is_creator":{"type":"boolean"},"linkedin_link":{"type":"string","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"onlyfans_link":{"type":"string","nullable":true},"other_links":{"type":"array","items":{"type":"string"}},"patreon_link":{"type":"string","nullable":true},"speaking_language":{"type":"string","nullable":true},"tiktok_link":{"type":"string","nullable":true},"twitch_link":{"type":"string","nullable":true},"twitter_link":{"type":"string","nullable":true},"youtube_link":{"type":"string","nullable":true},"instagram":{"$ref":"#/components/schemas/HandleProfileInstagramResponse"},"youtube":{"$ref":"#/components/schemas/HandleProfileYoutubeResponse"},"tiktok":{"$ref":"#/components/schemas/HandleProfileTiktokResponse"},"onlyfans":{"$ref":"#/components/schemas/HandleProfileOnlyfansResponse"},"twitter":{"$ref":"#/components/schemas/HandleProfileTwitterResponse"},"twitch":{"$ref":"#/components/schemas/HandleProfileTwitchResponse"},"linkedin":{"$ref":"#/components/schemas/HandleProfileLinkedinResponse"},"facebook":{"$ref":"#/components/schemas/HandleProfileFacebookResponse"},"pinterest":{"$ref":"#/components/schemas/HandleProfilePinterestResponse"},"snapchat":{"$ref":"#/components/schemas/HandleProfileSnapchatResponse"},"discord":{"$ref":"#/components/schemas/HandleProfileDiscordResponse"}}}},"components/schemas/HandleProfileSnapchatResponse":{"id":"components/schemas/HandleProfileSnapchatResponse","kind":"json-schema","title":"HandleProfileSnapchatResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"is_private":{"type":"boolean"},"profile_picture_url":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"title":{"type":"string","nullable":true},"biography":{"type":"string","nullable":true},"subscriber_count":{"type":"integer","nullable":true},"address":{"type":"string","nullable":true},"has_curated_highlights":{"type":"boolean"},"has_spotlight_highlights":{"type":"boolean"},"page_description":{"type":"string","nullable":true},"curated_highlights_story_titles":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"other_links":{"type":"array","items":{"type":"string"}}}}},"components/schemas/HandleProfileTiktokResponse":{"id":"components/schemas/HandleProfileTiktokResponse","kind":"json-schema","title":"HandleProfileTiktokResponse","data":{"type":"object","properties":{"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"duet_setting":{"type":"boolean"},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"is_ad":{"type":"boolean"},"is_commerce":{"type":"boolean"},"is_private":{"type":"boolean"},"is_verified":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"mention_status":{"type":"string","nullable":true},"most_recent_post_date":{"type":"string","nullable":true},"niche_class":{"type":"array","items":{"type":"string"}},"paid_partnership":{"type":"boolean"},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"region":{"type":"string","nullable":true},"sec_user_id":{"type":"string","nullable":true},"streamer":{"type":"boolean"},"tt_seller":{"type":"boolean","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"},"video_count":{"type":"integer","nullable":true}}}},"components/schemas/HandleProfileTwitchResponse":{"id":"components/schemas/HandleProfileTwitchResponse","kind":"json-schema","title":"HandleProfileTwitchResponse","data":{"type":"object","properties":{"description":{"type":"string","nullable":true},"displayName":{"type":"string","nullable":true},"isPartner":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"other_links":{"type":"array","items":{"type":"string"}},"panels_descriptions":{"type":"array","items":{"type":"string"}},"panels_image":{"type":"array","items":{"type":"string"}},"panels_titles":{"type":"array","items":{"type":"string"}},"panels_type":{"type":"array","items":{"type":"string"}},"panels_urls":{"type":"array","items":{"type":"string"}},"profileImageURL":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"social_media":{"type":"object","nullable":true,"additionalProperties":{}},"total_followers":{"type":"integer","nullable":true},"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true}}}},"components/schemas/HandleProfileTwitterResponse":{"id":"components/schemas/HandleProfileTwitterResponse","kind":"json-schema","title":"HandleProfileTwitterResponse","data":{"type":"object","properties":{"avg_likes":{"type":"number","format":"double","nullable":true},"biography":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"direct_messaging":{"type":"boolean"},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"full_name":{"type":"string","nullable":true},"is_verified":{"type":"boolean"},"join_date":{"type":"string","nullable":true},"language_code":{"type":"array","items":{"type":"string"}},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"location_source":{"type":"string","nullable":true},"media_count":{"type":"integer","nullable":true},"most_recent_post_date":{"type":"string","nullable":true},"other_links":{"type":"array","items":{"type":"string"}},"patreon":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"streamer":{"type":"boolean"},"subscriber_button":{"type":"boolean"},"super_followed_by":{"type":"boolean"},"userid":{"type":"string","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"uses_link_in_bio":{"type":"boolean"}}}},"components/schemas/HandleProfileYoutubeResponse":{"id":"components/schemas/HandleProfileYoutubeResponse","kind":"json-schema","title":"HandleProfileYoutubeResponse","data":{"type":"object","properties":{"avg_comments":{"type":"integer","nullable":true},"avg_likes":{"type":"number","format":"double","nullable":true},"avg_views":{"type":"number","format":"double","nullable":true},"country":{"type":"string","nullable":true},"custom_url":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"engagement_percent":{"type":"number","format":"double","nullable":true},"exists":{"type":"boolean"},"first_name":{"type":"string","nullable":true},"has_community_posts":{"type":"boolean"},"has_paid_partnership":{"type":"boolean"},"has_shorts":{"type":"boolean"},"id":{"type":"string","nullable":true},"is_monetization_enabled":{"type":"boolean"},"is_verified":{"type":"boolean"},"language_code":{"type":"array","items":{"type":"string"}},"link":{"type":"string","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"made_for_kids":{"type":"boolean"},"moderate_comments":{"type":"boolean"},"most_recent_post_date":{"type":"string","nullable":true},"niche_class":{"type":"array","items":{"type":"string"}},"privacy_status":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"published_at":{"type":"string","nullable":true},"related_playlist_id":{"type":"string","nullable":true},"streamer":{"type":"boolean"},"subscriber_count":{"type":"integer","nullable":true},"title":{"type":"string","nullable":true},"unsubscribed_trailer_id":{"type":"string","nullable":true},"uses_link_in_bio":{"type":"boolean"},"video_count":{"type":"integer","nullable":true},"view_count":{"type":"integer","nullable":true}}}},"components/schemas/HandleRawDiscordResponse":{"id":"components/schemas/HandleRawDiscordResponse","kind":"json-schema","title":"HandleRawDiscordResponse","data":{"type":"object","properties":{"type":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"inviter":{"type":"object","additionalProperties":{}},"expires_at":{"type":"string","nullable":true},"flags":{"type":"integer","nullable":true},"guild":{"type":"object","additionalProperties":{}},"profile":{"type":"object","additionalProperties":{}},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true}},"required":["inviter","guild","profile"]}},"components/schemas/HandleRawFacebookResponse":{"id":"components/schemas/HandleRawFacebookResponse","kind":"json-schema","title":"HandleRawFacebookResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"user_info":{"type":"object","additionalProperties":{}},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"post_data":{"type":"array","items":{"type":"string"}}},"required":["user_info","post_data"]}},"components/schemas/HandleRawInstagramResponse":{"id":"components/schemas/HandleRawInstagramResponse","kind":"json-schema","title":"HandleRawInstagramResponse","data":{"type":"object","properties":{"userid":{"type":"string","nullable":true},"exists":{"type":"boolean","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"has_profile_pic":{"type":"boolean","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"biography":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"media_count":{"type":"integer","nullable":true},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"is_private":{"type":"boolean","nullable":true},"is_business_account":{"type":"boolean","nullable":true},"is_verified":{"type":"boolean","nullable":true},"video_content_creator":{"type":"boolean","nullable":true},"uses_link_in_bio":{"type":"boolean","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"post_data":{"type":"array","items":{"type":"string"}}},"required":["links_in_bio","post_data"]}},"components/schemas/HandleRawLinkedInResponse":{"id":"components/schemas/HandleRawLinkedInResponse","kind":"json-schema","title":"HandleRawLinkedInResponse","data":{"type":"object","properties":{"id":{"type":"string","nullable":true},"connection":{"type":"string","nullable":true},"followers":{"type":"integer","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"is_creator":{"type":"boolean","nullable":true},"is_premium":{"type":"boolean","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_pictures":{"type":"array","items":{"type":"string"}},"background_image":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"headline":{"type":"string","nullable":true},"geo":{"type":"object","additionalProperties":{}},"position":{"type":"object","additionalProperties":{}},"full_positions":{"type":"array","items":{"type":"string"}},"skills":{"type":"array","items":{"type":"string"}},"projects":{"type":"array","items":{"type":"string"}},"supported_locales":{"type":"array","items":{"type":"string"}},"multi_locale_first_name":{"type":"object","additionalProperties":{}},"multi_locale_last_name":{"type":"object","additionalProperties":{}},"multi_locale_headline":{"type":"object","additionalProperties":{}}},"required":["profile_pictures","geo","position","full_positions","skills","projects","supported_locales","multi_locale_first_name","multi_locale_last_name","multi_locale_headline"]}},"components/schemas/HandleRawOnlyFansResponse":{"id":"components/schemas/HandleRawOnlyFansResponse","kind":"json-schema","title":"HandleRawOnlyFansResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"exists":{"type":"boolean","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"full_name":{"type":"string","nullable":true},"biography":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"is_verified":{"type":"boolean","nullable":true},"subscribe_price":{"type":"number","format":"double","nullable":true},"join_date":{"type":"string","nullable":true},"first_published_post_date":{"type":"string","nullable":true},"last_seen":{"type":"string","nullable":true},"wishlist":{"type":"array","items":{"type":"string"}},"posts_count":{"type":"integer","nullable":true},"photos_count":{"type":"integer","nullable":true},"videos_count":{"type":"integer","nullable":true},"audios_count":{"type":"integer","nullable":true},"media_count":{"type":"integer","nullable":true},"total_likes":{"type":"integer","nullable":true},"is_real_performer":{"type":"boolean","nullable":true},"is_adult_content":{"type":"boolean","nullable":true},"finished_streams_count":{"type":"integer","nullable":true},"can_create_promotion":{"type":"boolean","nullable":true},"tips_enabled":{"type":"boolean","nullable":true},"tips_text_enabled":{"type":"boolean","nullable":true},"tips_min":{"type":"number","format":"double","nullable":true},"tips_min_internal":{"type":"number","format":"double","nullable":true},"tips_max":{"type":"number","format":"double","nullable":true},"can_earn":{"type":"boolean","nullable":true},"archived_posts_count":{"type":"integer","nullable":true},"private_archived_posts_count":{"type":"integer","nullable":true},"is_spotify_connected":{"type":"boolean","nullable":true},"referal_bonus_sum_for_referer":{"type":"number","format":"double","nullable":true},"can_receive_chat_message":{"type":"boolean","nullable":true},"can_chat":{"type":"boolean","nullable":true},"post_dates":{"type":"array","items":{"type":"string"}},"post_data":{"type":"array","items":{"type":"string"}}},"required":["wishlist","post_dates","post_data"]}},"components/schemas/HandleRawPinterestResponse":{"id":"components/schemas/HandleRawPinterestResponse","kind":"json-schema","title":"HandleRawPinterestResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"pk":{"type":"string","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"user_info":{"type":"object","additionalProperties":{}}},"required":["user_info"]}},"components/schemas/HandleRawPlatformResponse":{"id":"components/schemas/HandleRawPlatformResponse","kind":"json-schema","title":"HandleRawPlatformResponse","data":{"type":"object","properties":{"credits_cost":{"type":"number","format":"double","nullable":true,"example":0.03},"result":{"$ref":"#/components/schemas/HandleRawResultResponse"}}}},"components/schemas/HandleRawRedditResponse":{"id":"components/schemas/HandleRawRedditResponse","kind":"json-schema","title":"HandleRawRedditResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"pk":{"type":"string","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"user_info":{"type":"object","additionalProperties":{}}},"required":["user_info"]}},"components/schemas/HandleRawResultResponse":{"id":"components/schemas/HandleRawResultResponse","kind":"json-schema","title":"HandleRawResultResponse","data":{"type":"object","properties":{"twitter":{"$ref":"#/components/schemas/HandleRawTwitterResponse"},"twitch":{"$ref":"#/components/schemas/HandleRawTwitchResponse"},"onlyfans":{"$ref":"#/components/schemas/HandleRawOnlyFansResponse"},"youtube":{"$ref":"#/components/schemas/HandleRawYouTubeResponse"},"tiktok":{"$ref":"#/components/schemas/HandleRawTikTokResponse"},"instagram":{"$ref":"#/components/schemas/HandleRawInstagramResponse"},"facebook":{"$ref":"#/components/schemas/HandleRawFacebookResponse"},"pinterest":{"$ref":"#/components/schemas/HandleRawPinterestResponse"},"reddit":{"$ref":"#/components/schemas/HandleRawRedditResponse"},"snapchat":{"$ref":"#/components/schemas/HandleRawSnapchatResponse"},"discord":{"$ref":"#/components/schemas/HandleRawDiscordResponse"},"linkedin":{"$ref":"#/components/schemas/HandleRawLinkedInResponse"}}}},"components/schemas/HandleRawSnapchatResponse":{"id":"components/schemas/HandleRawSnapchatResponse","kind":"json-schema","title":"HandleRawSnapchatResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"is_private":{"type":"boolean","nullable":true},"profile_picture_url":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"title":{"type":"string","nullable":true},"biography":{"type":"string","nullable":true},"subscriber_count":{"type":"integer","nullable":true},"address":{"type":"string","nullable":true},"has_curated_highlights":{"type":"boolean","nullable":true},"has_spotlight_highlights":{"type":"boolean","nullable":true},"page_description":{"type":"string","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}}},"required":["links_in_bio"]}},"components/schemas/HandleRawTikTokResponse":{"id":"components/schemas/HandleRawTikTokResponse","kind":"json-schema","title":"HandleRawTikTokResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"sec_user_id":{"type":"string","nullable":true},"exists":{"type":"boolean","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"full_name":{"type":"string","nullable":true},"biography":{"type":"string","nullable":true},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"video_count":{"type":"integer","nullable":true},"total_likes":{"type":"integer","nullable":true},"total_shares":{"type":"integer","nullable":true},"total_saves":{"type":"integer","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"tt_seller":{"type":"boolean","nullable":true},"is_ad":{"type":"boolean","nullable":true},"is_verified":{"type":"boolean","nullable":true},"is_commerce":{"type":"boolean","nullable":true},"duet_setting":{"type":"string","nullable":true},"is_private":{"type":"boolean","nullable":true},"saves_count_list":{"type":"array","items":{"type":"string"}},"post_data":{"type":"array","items":{"type":"string"}}},"required":["links_in_bio","saves_count_list","post_data"]}},"components/schemas/HandleRawTwitchResponse":{"id":"components/schemas/HandleRawTwitchResponse","kind":"json-schema","title":"HandleRawTwitchResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"profileImageURL":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"description":{"type":"string","nullable":true},"displayName":{"type":"string","nullable":true},"total_followers":{"type":"integer","nullable":true},"twitch_tracker_data":{"type":"object","additionalProperties":{}},"links_in_bio":{"type":"array","items":{"type":"string"}},"post_data":{"type":"array","items":{"type":"string"}}},"required":["twitch_tracker_data","links_in_bio","post_data"]}},"components/schemas/HandleRawTwitterResponse":{"id":"components/schemas/HandleRawTwitterResponse","kind":"json-schema","title":"HandleRawTwitterResponse","data":{"type":"object","properties":{"userid":{"type":"string","nullable":true},"exists":{"type":"boolean","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"full_name":{"type":"string","nullable":true},"biography":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"join_date":{"type":"string","nullable":true},"links_in_bio":{"type":"array","items":{"type":"string"}},"location":{"type":"string","nullable":true},"follower_count":{"type":"integer","nullable":true},"following_count":{"type":"integer","nullable":true},"media_count":{"type":"integer","nullable":true},"tweets_count":{"type":"integer","nullable":true},"creator_favorite_count":{"type":"integer","nullable":true},"is_verified":{"type":"boolean","nullable":true},"direct_messaging":{"type":"boolean","nullable":true},"subscriber_button":{"type":"boolean","nullable":true},"super_followed_by":{"type":"boolean","nullable":true},"tweets_type":{"type":"object","additionalProperties":{}},"post_data":{"type":"array","items":{"type":"string"}}},"required":["links_in_bio","tweets_type","post_data"]}},"components/schemas/HandleRawYouTubeResponse":{"id":"components/schemas/HandleRawYouTubeResponse","kind":"json-schema","title":"HandleRawYouTubeResponse","data":{"type":"object","properties":{"id":{"type":"string","nullable":true},"exists":{"type":"boolean","nullable":true},"link":{"type":"string","nullable":true},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"related_playlist_id":{"type":"string","nullable":true},"profile_picture_hd":{"type":"string","description":"URL to the creator's high-definition profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"custom_url":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"published_at":{"type":"string","nullable":true},"subscriber_count":{"type":"integer","nullable":true},"video_count":{"type":"integer","nullable":true},"view_count":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"has_shorts":{"type":"boolean","nullable":true},"has_community_posts":{"type":"boolean","nullable":true},"made_for_kids":{"type":"boolean","nullable":true},"privacy_status":{"type":"string","nullable":true},"moderate_comments":{"type":"boolean","nullable":true},"unsubscribed_trailer_id":{"type":"string","nullable":true},"total_comments_last_50":{"type":"integer","nullable":true},"topic_details":{"type":"array","items":{"type":"string"}},"post_data":{"type":"array","items":{"type":"string"}}},"required":["topic_details","post_data"]}},"components/schemas/ImageVersionsModel":{"id":"components/schemas/ImageVersionsModel","kind":"json-schema","title":"ImageVersionsModel","data":{"type":"object","properties":{"candidates":{"type":"array","items":{"$ref":"#/components/schemas/MediaCandidateModel"}}},"required":["candidates"]}},"components/schemas/InstagramDiscoveryFilters":{"id":"components/schemas/InstagramDiscoveryFilters","kind":"json-schema","title":"InstagramDiscoveryFilters","data":{"type":"object","properties":{"location":{"type":"array","items":{"type":"string","nullable":true}},"type":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"profile_language":{"type":"array","items":{"type":"string","nullable":true}},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? + are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}],"nullable":true},"keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"exclude_keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_in_captions":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_not_in_captions":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"number_of_followers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"engagement_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_likes":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_comments":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"number_of_posts":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"reels_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_views_for_reels":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"posting_frequency":{"type":"number","format":"double","nullable":true},"follower_growth":{"allOf":[{"$ref":"#/components/schemas/GrowthRequest"}],"nullable":true},"income":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"last_post":{"type":"string","description":"Allowed values: any, 90, 365","nullable":true},"has_videos":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"exclude_private_profile":{"type":"boolean","nullable":true},"is_verified":{"type":"boolean","nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"audience":{"allOf":[{"$ref":"#/components/schemas/AudienceFilterRequest"}],"nullable":true},"creator_has":{"$ref":"#/components/schemas/CreatorHasRequest"},"promotes_affiliate_links":{"type":"boolean","nullable":true},"has_done_brand_deals":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_link_in_bio":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"does_live_streaming":{"type":"boolean","nullable":true},"has_merch":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false},"exclude_handles":{"type":"array","items":{"type":"string"}},"exclude_list":{"type":"array","items":{"type":"integer"},"description":"IDs of exclusion lists to apply. Create and manage these via the Exclusion lists endpoints, then pass their IDs here; only lists for this platform are applied."},"exclude_default_list":{"type":"boolean","description":"When true, applies the team's default exclusion list for this platform.","default":false},"exclude_all_lists":{"type":"boolean","description":"When true, applies every exclusion list for this platform (the default list and all specific lists).","default":false}}}},"components/schemas/Language":{"id":"components/schemas/Language","kind":"json-schema","title":"Language","data":{"type":"object","properties":{"language":{"type":"string"},"abbreviation":{"type":"string"}},"required":["language","abbreviation"]}},"components/schemas/MatchedFilters":{"id":"components/schemas/MatchedFilters","kind":"json-schema","title":"MatchedFilters","data":{"type":"object","properties":{"audience_location":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoed location conditions, e.g. [\"US>30%\"]."},"children":[]}]}]}]},"audience_gender":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoed gender condition, e.g. \"female>60%\"."},"children":[]}]}]}]},"audience_age":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoed age conditions, e.g. [\"18-24>40%\"]."},"children":[]}]}]}]},"audience_interests":{"type":"array","items":{"type":"string"},"description":"Echoed interest conditions."},"audience_language":{"type":"array","items":{"type":"string"},"description":"Echoed language conditions."},"audience_credibility":{"type":"string","description":"Echoed audience credibility class."},"creator_has":{"$ref":"#/components/schemas/CreatorHas","description":"Requested networks/links that matched (true entries only)."},"has_brand_deals":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_done_brand_deals filter you sent."},"children":[]}]}]}]},"has_link_in_bio":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_link_in_bio filter you sent."},"children":[]}]}]}]},"has_merch":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_merch filter you sent."},"children":[]}]}]}]},"has_affiliate_links":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the promotes_affiliate_links filter you sent."},"children":[]}]}]}]},"hashtags":{"type":"array","items":{"type":"string"},"description":"The hashtags you searched for."},"not_hashtags":{"type":"array","items":{"type":"string"},"description":"The excluded hashtags you searched for."},"posting_frequency":{"type":"number","format":"double","description":"The creator's resolved posting frequency (posts per month)."},"creator_growth":{"type":"number","format":"double","description":"The creator's resolved growth percentage for the requested window."},"income":{"$ref":"#/components/schemas/Range","description":"The creator's resolved income range (rounded to hundreds)."},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the ai_search filter you sent."},"children":[]}]}]}]},"average_comments":{"type":"number","format":"double","description":"The creator's resolved average comments per post."},"average_likes":{"type":"number","format":"double","description":"The creator's resolved average likes per post."},"average_stream_duration":{"type":"number","format":"double","description":"The creator's resolved average stream duration."},"average_stream_views":{"type":"number","format":"double","description":"The creator's resolved average stream views."},"average_video_downloads":{"type":"number","format":"double","description":"The creator's resolved average downloads per video."},"average_views":{"type":"number","format":"double","description":"The creator's resolved average views per video."},"average_views_for_reels":{"type":"number","format":"double","description":"The creator's resolved average views on reels."},"average_views_on_long_videos":{"type":"number","format":"double","description":"The creator's resolved average views on long-form videos."},"average_views_on_shorts":{"type":"number","format":"double","description":"The creator's resolved average views on Shorts."},"avg_views_last_30_days":{"type":"number","format":"double","description":"The creator's resolved average views over the last 30 days."},"brands":{"type":"array","items":{"type":"string"},"description":"Echoes the brands values you sent."},"does_live_streaming":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the does_live_streaming filter you sent."},"children":[]}]}]}]},"engagement_percent":{"type":"number","format":"double","description":"The creator's resolved engagement percentage."},"exclude_keywords_in_bio":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the exclude_keywords_in_bio values you sent."},"children":[]}]}]}]},"exclude_private_profile":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the exclude_private_profile filter you sent."},"children":[]}]}]}]},"exclude_role_based_emails":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the exclude_role_based_emails filter you sent."},"children":[]}]}]}]},"followers":{"type":"integer","description":"The creator's resolved follower count."},"games_played":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the games_played values you sent."},"children":[]}]}]}]},"gender":{"type":"string","description":"Echoes the gender filter you sent."},"has_community_posts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_community_posts filter you sent."},"children":[]}]}]}]},"has_courses":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_courses filter you sent."},"children":[]}]}]}]},"has_free_account":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_free_account filter you sent."},"children":[]}]}]}]},"has_live_streams":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_live_streams filter you sent."},"children":[]}]}]}]},"has_membership":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_membership filter you sent."},"children":[]}]}]}]},"has_podcast":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_podcast filter you sent."},"children":[]}]}]}]},"has_shorts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_shorts filter you sent."},"children":[]}]}]}]},"has_tik_tok_shop":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_tik_tok_shop filter you sent."},"children":[]}]}]}]},"has_videos":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the has_videos filter you sent."},"children":[]}]}]}]},"is_monetizing":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the is_monetizing filter you sent."},"children":[]}]}]}]},"is_twitch_partner":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the is_twitch_partner filter you sent."},"children":[]}]}]}]},"is_verified":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the is_verified filter you sent."},"children":[]}]}]}]},"keywords_in_bio":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_in_bio values you sent."},"children":[]}]}]}]},"keywords_in_captions":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_in_captions values you sent."},"children":[]}]}]}]},"keywords_in_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_in_description values you sent."},"children":[]}]}]}]},"keywords_in_tweets":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_in_tweets values you sent."},"children":[]}]}]}]},"keywords_in_video_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_in_video_description values you sent."},"children":[]}]}]}]},"keywords_in_video_titles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_in_video_titles values you sent."},"children":[]}]}]}]},"keywords_not_in_captions":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_not_in_captions values you sent."},"children":[]}]}]}]},"keywords_not_in_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_not_in_description values you sent."},"children":[]}]}]}]},"keywords_not_in_tweets":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_not_in_tweets values you sent."},"children":[]}]}]}]},"keywords_not_in_video_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_not_in_video_description values you sent."},"children":[]}]}]}]},"keywords_not_in_video_titles":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the keywords_not_in_video_titles values you sent."},"children":[]}]}]}]},"last_active":{"type":"string","description":"The creator's resolved last-active date."},"last_post":{"type":"string","description":"The creator's resolved most recent post date."},"last_stream_upload":{"type":"string","description":"The creator's resolved last stream upload date."},"last_upload_long_video":{"type":"string","description":"The creator's resolved last long-form video upload date."},"last_upload_short_video":{"type":"string","description":"The creator's resolved last short-form video upload date."},"link_in_bio":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the link_in_bio values you sent."},"children":[]}]}]}]},"links_from_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the links_from_description values you sent."},"children":[]}]}]}]},"links_from_video_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the links_from_video_description values you sent."},"children":[]}]}]}]},"location":{"type":"array","items":{"type":"string"},"description":"Echoes the location values you sent."},"long_video_duration":{"$ref":"#/components/schemas/Range","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the long_video_duration range you sent."},"children":[]}]}]}]},"maximum_views_count":{"type":"number","format":"double","description":"The creator's resolved maximum views on a stream."},"most_recent_stream_date":{"type":"string","description":"The creator's resolved most recent stream date."},"not_link_in_bio":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the not_link_in_bio values you sent."},"children":[]}]}]}]},"not_video_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the not_video_description values you sent."},"children":[]}]}]}]},"number_of_followers":{"type":"integer","description":"The creator's resolved follower count."},"number_of_likes":{"type":"integer","description":"The creator's resolved total likes."},"number_of_photos":{"type":"number","format":"double","description":"The creator's resolved media count (matches what the filter ranges on; includes videos, not photos only)."},"number_of_posts":{"type":"number","format":"double","description":"The creator's resolved number of posts."},"number_of_subscribers":{"type":"integer","description":"The creator's resolved subscriber count."},"number_of_videos":{"type":"integer","description":"The creator's resolved video count."},"profile_language":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the profile_language values you sent."},"children":[]}]}]}]},"reels_percent":{"type":"number","format":"double","description":"The creator's resolved percentage of posts that are reels."},"shorts_percentage":{"type":"number","format":"double","description":"The creator's resolved percentage of uploads that are Shorts."},"streamed_hours_last_30_days":{"type":"number","format":"double","description":"The creator's resolved hours streamed over the last 30 days."},"streams_count_last_30_days":{"type":"number","format":"double","description":"The creator's resolved stream count over the last 30 days."},"streams_live":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the streams_live filter you sent."},"children":[]}]}]}]},"subscription_price":{"type":"number","format":"double","description":"The creator's resolved subscription price."},"topics":{"type":"array","items":{"type":"string"},"description":"Echoes the topics values you sent."},"tweets_count":{"type":"number","format":"double","description":"The creator's resolved tweet count."},"type":{"type":"string","description":"Echoes the type filter you sent."},"video_count":{"type":"integer","description":"The creator's resolved video count."},"video_description":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes the video_description values you sent."},"children":[]}]}]}]}}}},"components/schemas/MediaCandidateModel":{"id":"components/schemas/MediaCandidateModel","kind":"json-schema","title":"MediaCandidateModel","data":{"type":"object","properties":{"url":{"type":"string","description":"The creator's profile URL.","nullable":true},"width":{"type":"integer","nullable":true},"height":{"type":"integer","nullable":true}}}},"components/schemas/NlpSearchEcho":{"id":"components/schemas/NlpSearchEcho","kind":"json-schema","title":"NlpSearchEcho","data":{"type":"object","properties":{"from_nlp":{"type":"object","description":"The filters the AI inferred from the brief.","additionalProperties":{}},"overridden_by_user":{"type":"array","items":{"type":"string"},"description":"Fields where your explicit value beat the AI's inference."},"notes":{"type":"array","items":{"type":"string"},"description":"Human-readable reasons a filter wasn't applied, e.g. unavailable on this platform."}}}},"components/schemas/NotifyEndpoint":{"id":"components/schemas/NotifyEndpoint","kind":"json-schema","title":"NotifyEndpoint","data":{"type":"object","properties":{"id":{"type":"integer","description":"Notify endpoint identifier."},"destination":{"type":"string","description":"Delivery destination (e.g. the webhook URL)."},"notify_type":{"type":"string","description":"Delivery type of the endpoint (e.g. 'api')."},"created_at":{"type":"string","format":"date-time","description":"When the endpoint was created."}},"required":["id","destination","notify_type","created_at"]}},"components/schemas/NotifyEndpointInput":{"id":"components/schemas/NotifyEndpointInput","kind":"json-schema","title":"NotifyEndpointInput","data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of an existing notify endpoint. Mutually exclusive with 'destination'."},"destination":{"type":"string","description":"Destination for a new inline endpoint (e.g. a webhook URL). Mutually exclusive with 'id'."},"notify_type":{"type":"string","description":"Delivery type for a new inline endpoint. Defaults to 'api'.","default":"api"}}}},"components/schemas/OnlyFansDiscoveryFilters":{"id":"components/schemas/OnlyFansDiscoveryFilters","kind":"json-schema","title":"OnlyFansDiscoveryFilters","data":{"type":"object","properties":{"location":{"type":"array","items":{"type":"string","nullable":true}},"gender":{"type":"string","nullable":true},"profile_language":{"type":"array","items":{"type":"string","nullable":true}},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? + are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}],"nullable":true},"number_of_likes":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"number_of_photos":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"subscription_price":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"is_verified":{"type":"boolean","nullable":true},"has_videos":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_free_account":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_live_streams":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"last_active":{"type":"string","description":"Allowed values: any, 90, 365","nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"creator_has":{"$ref":"#/components/schemas/CreatorHasRequest"},"promotes_affiliate_links":{"type":"boolean","nullable":true},"has_done_brand_deals":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_link_in_bio":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"does_live_streaming":{"type":"boolean","nullable":true},"has_merch":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false},"exclude_handles":{"type":"array","items":{"type":"string"}},"exclude_list":{"type":"array","items":{"type":"integer"},"description":"IDs of exclusion lists to apply. Create and manage these via the Exclusion lists endpoints, then pass their IDs here; only lists for this platform are applied."},"exclude_default_list":{"type":"boolean","description":"When true, applies the team's default exclusion list for this platform.","default":false},"exclude_all_lists":{"type":"boolean","description":"When true, applies every exclusion list for this platform (the default list and all specific lists).","default":false}}}},"components/schemas/OverlapDataItem":{"id":"components/schemas/OverlapDataItem","kind":"json-schema","title":"OverlapDataItem","data":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/OverlapUser"},"user_id":{"type":"string","description":"The creator's unique platform identifier."},"username":{"type":"string","description":"The creator's username on the platform."},"followers":{"type":"integer"},"unique_percentage":{"type":"number","format":"double"},"overlapping_percentage":{"type":"number","format":"double"}},"required":["user","user_id","username","followers","unique_percentage","overlapping_percentage"]}},"components/schemas/OverlapUser":{"id":"components/schemas/OverlapUser","kind":"json-schema","title":"OverlapUser","data":{"type":"object","properties":{"user_id":{"type":"string","description":"The creator's unique platform identifier.","nullable":true},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"followers":{"type":"integer","nullable":true},"fullname":{"type":"string","nullable":true},"url":{"type":"string","description":"The creator's profile URL.","nullable":true},"is_verified":{"type":"boolean","nullable":true},"engagements":{"type":"integer","nullable":true},"stats":{"type":"array","items":{"$ref":"#/components/schemas/OverlapUserStats"}}}}},"components/schemas/OverlapUserStats":{"id":"components/schemas/OverlapUserStats","kind":"json-schema","title":"OverlapUserStats","data":{"type":"object","properties":{"post_type":{"type":"string","nullable":true},"engagements":{"type":"integer","nullable":true}}}},"components/schemas/Paging":{"id":"components/schemas/Paging","kind":"json-schema","title":"Paging","data":{"type":"object","properties":{"limit":{"type":"integer"},"page":{"type":"integer","description":"Page number (0-indexed). The first page is 0, not 1."}},"required":["limit","page"]}},"components/schemas/PagingRequest":{"id":"components/schemas/PagingRequest","kind":"json-schema","title":"PagingRequest","data":{"type":"object","properties":{"limit":{"type":"integer"},"page":{"type":"integer","description":"Page number (0-indexed). The first page is 0, not 1."}},"required":["limit","page"]}},"components/schemas/PastSponsorResponse":{"id":"components/schemas/PastSponsorResponse","kind":"json-schema","title":"PastSponsorResponse","data":{"type":"object","properties":{"handle":{"type":"string","description":"Handle of the mentioned sponsor.","nullable":true},"post_count":{"type":"integer","description":"Number of sponsored posts mentioning this handle."},"first_seen":{"type":"string","description":"Timestamp of the earliest sponsored post mentioning this handle, in ISO 8601 format.","nullable":true},"last_seen":{"type":"string","description":"Timestamp of the most recent sponsored post mentioning this handle, in ISO 8601 format.","nullable":true},"post_ids":{"type":"array","items":{"type":"string"},"description":"IDs of the sponsored posts mentioning this handle."}}}},"components/schemas/PostItemModel":{"id":"components/schemas/PostItemModel","kind":"json-schema","title":"PostItemModel","data":{"type":"object","properties":{"pk":{"type":"string"},"taken_at":{"type":"integer","nullable":true},"url":{"type":"string","description":"The creator's profile URL.","nullable":true},"device_timestamp":{"type":"integer","nullable":true},"media_url":{"type":"string","nullable":true},"media_id":{"type":"string","nullable":true},"image_versions":{"$ref":"#/components/schemas/ImageVersionsModel"},"media_type":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserInfoModel"},"engagement":{"$ref":"#/components/schemas/EngagementModel"},"caption":{"type":"string","nullable":true},"thumbnails":{"type":"object","nullable":true,"additionalProperties":{}}},"required":["pk","image_versions","media_type","user","engagement"]}},"components/schemas/PublicAPIInstagramAudience":{"id":"components/schemas/PublicAPIInstagramAudience","kind":"json-schema","title":"PublicAPIInstagramAudience","data":{"type":"object","properties":{"location":{"type":"array","items":{"$ref":"#/components/schemas/AudienceLocation"},"nullable":true},"gender":{"allOf":[{"$ref":"#/components/schemas/AudienceGender"}],"nullable":true},"language":{"type":"array","items":{"$ref":"#/components/schemas/AudienceLanguage"},"nullable":true},"age":{"type":"array","items":{"$ref":"#/components/schemas/AudienceAge"},"nullable":true},"interests":{"type":"array","items":{"$ref":"#/components/schemas/AudienceInterest"},"nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"brand_categories":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"credibility":{"type":"string","enum":["bad","low","normal","good","high","best"],"nullable":true}}}},"components/schemas/Range":{"id":"components/schemas/Range","kind":"json-schema","title":"Range","data":{"type":"object","properties":{"min":{"type":"number","format":"double","nullable":true},"max":{"type":"number","format":"double","nullable":true}}}},"components/schemas/RangeRequest":{"id":"components/schemas/RangeRequest","kind":"json-schema","title":"RangeRequest","data":{"type":"object","properties":{"min":{"type":"number","format":"double","nullable":true},"max":{"type":"number","format":"double","nullable":true}}}},"components/schemas/RegisterClientRequest":{"id":"components/schemas/RegisterClientRequest","kind":"json-schema","title":"RegisterClientRequest","data":{"type":"object","properties":{"client_name":{"type":"string","description":"Human-readable name of the client application."},"redirect_uris":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of allowed redirect URIs. At least one is required. The redirect_uri used in the authorization request must exactly match one of these."},"children":[]}]}]}]},"scope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Space-separated list of requested scopes. Available value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if omitted."},"children":[]}]}]}],"default":"all"}},"required":["client_name","redirect_uris"]}},"components/schemas/RegisterClientResponse":{"id":"components/schemas/RegisterClientResponse","kind":"json-schema","title":"RegisterClientResponse","data":{"type":"object","properties":{"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the registered client. Persist this value — it is required for all subsequent authorization requests."},"children":[]}]}]}]},"client_name":{"type":"string","description":"Human-readable name of the client application."},"redirect_uris":{"type":"array","items":{"type":"string"},"description":"Registered redirect URIs for this client."},"scope":{"type":"string","description":"Space-separated list of scopes granted to this client."},"token_endpoint_auth_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication method for the token endpoint. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (public client, PKCE required)."},"children":[]}]}]}]},"grant_types":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported grant types. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[authorization_code, refresh_token]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"response_types":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported response types. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[code]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"client_id_issued_at":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp of when the client_id was issued."},"children":[]}]}]}]}},"required":["client_id","client_name","redirect_uris","scope","token_endpoint_auth_method","grant_types","response_types","client_id_issued_at"]}},"components/schemas/RemoveCampaignCreatorsInput":{"id":"components/schemas/RemoveCampaignCreatorsInput","kind":"json-schema","title":"RemoveCampaignCreatorsInput","data":{"type":"object","properties":{"creator_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of the campaign creator links to remove, as returned in the campaign Creators list ('id')."}},"required":["creator_ids"]}},"components/schemas/RemoveCampaignCreatorsInputRequest":{"id":"components/schemas/RemoveCampaignCreatorsInputRequest","kind":"json-schema","title":"RemoveCampaignCreatorsInputRequest","data":{"type":"object","properties":{"creator_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of the campaign creator links to remove, as returned in the campaign Creators list ('id')."}},"required":["creator_ids"]}},"components/schemas/ReportInfo":{"id":"components/schemas/ReportInfo","kind":"json-schema","title":"ReportInfo","data":{"type":"object","properties":{"total_followers":{"type":"integer","nullable":true},"total_unique_followers":{"type":"integer","nullable":true}}}},"components/schemas/SimilarCreatorsInstagramRequest":{"id":"components/schemas/SimilarCreatorsInstagramRequest","kind":"json-schema","title":"SimilarCreatorsInstagramRequest","data":{"type":"object","required":["filter_key","filter_value","paging"],"properties":{"platform":{"type":"string","enum":["instagram"]},"filter_key":{"type":"string","enum":["url","username","id"]},"filter_value":{"type":"string","description":"Email, platform url or profile handle"},"paging":{"$ref":"#/components/schemas/PagingRequest"},"filters":{"$ref":"#/components/schemas/InstagramDiscoveryFilters"}}}},"components/schemas/SimilarCreatorsOnlyFansRequest":{"id":"components/schemas/SimilarCreatorsOnlyFansRequest","kind":"json-schema","title":"SimilarCreatorsOnlyFansRequest","data":{"type":"object","required":["filter_key","filter_value","paging"],"properties":{"platform":{"type":"string","enum":["onlyfans"]},"filter_key":{"type":"string","enum":["url","username","id"]},"filter_value":{"type":"string","description":"Email, platform url or profile handle"},"paging":{"$ref":"#/components/schemas/PagingRequest"},"filters":{"$ref":"#/components/schemas/OnlyFansDiscoveryFilters"}}}},"components/schemas/SimilarCreatorsTikTokRequest":{"id":"components/schemas/SimilarCreatorsTikTokRequest","kind":"json-schema","title":"SimilarCreatorsTikTokRequest","data":{"type":"object","required":["filter_key","filter_value","paging"],"properties":{"platform":{"type":"string","enum":["tiktok"]},"filter_key":{"type":"string","enum":["url","username","id"]},"filter_value":{"type":"string","description":"Email, platform url or profile handle"},"paging":{"$ref":"#/components/schemas/PagingRequest"},"filters":{"$ref":"#/components/schemas/TikTokDiscoveryFilters"}}}},"components/schemas/SimilarCreatorsTwitchRequest":{"id":"components/schemas/SimilarCreatorsTwitchRequest","kind":"json-schema","title":"SimilarCreatorsTwitchRequest","data":{"type":"object","required":["filter_key","filter_value","paging"],"properties":{"platform":{"type":"string","enum":["twitch"]},"filter_key":{"type":"string","enum":["url","username","id"]},"filter_value":{"type":"string","description":"Email, platform url or profile handle"},"paging":{"$ref":"#/components/schemas/PagingRequest"},"filters":{"$ref":"#/components/schemas/TwitchDiscoveryFilters"}}}},"components/schemas/SimilarCreatorsTwitterRequest":{"id":"components/schemas/SimilarCreatorsTwitterRequest","kind":"json-schema","title":"SimilarCreatorsTwitterRequest","data":{"type":"object","required":["filter_key","filter_value","paging"],"properties":{"platform":{"type":"string","enum":["twitter"]},"filter_key":{"type":"string","enum":["url","username","id"]},"filter_value":{"type":"string","description":"Email, platform url or profile handle"},"paging":{"$ref":"#/components/schemas/PagingRequest"},"filters":{"$ref":"#/components/schemas/TwitterDiscoveryFilters"}}}},"components/schemas/SimilarCreatorsYouTubeRequest":{"id":"components/schemas/SimilarCreatorsYouTubeRequest","kind":"json-schema","title":"SimilarCreatorsYouTubeRequest","data":{"type":"object","required":["filter_key","filter_value","paging"],"properties":{"platform":{"type":"string","enum":["youtube"]},"filter_key":{"type":"string","enum":["url","username","id"]},"filter_value":{"type":"string","description":"Email, platform url or profile handle"},"paging":{"$ref":"#/components/schemas/PagingRequest"},"filters":{"$ref":"#/components/schemas/YouTubeDiscoveryFilters"}}}},"components/schemas/Sort":{"id":"components/schemas/Sort","kind":"json-schema","title":"Sort","data":{"type":"object","properties":{"sort_by":{"type":"string","enum":["relevancy","engagement_rate","number_of_followers","growth_rate"],"default":"relevancy"},"sort_order":{"type":"string","enum":["asc","desc"],"default":"desc"}}}},"components/schemas/SortRequest":{"id":"components/schemas/SortRequest","kind":"json-schema","title":"SortRequest","data":{"type":"object","properties":{"sort_by":{"type":"string","enum":["relevancy","engagement_rate","number_of_followers","growth_rate"],"default":"relevancy"},"sort_order":{"type":"string","enum":["asc","desc"],"default":"desc"}}}},"components/schemas/SourceList":{"id":"components/schemas/SourceList","kind":"json-schema","title":"SourceList","data":{"type":"object","properties":{"id":{"type":"integer","description":"Discovery list ID."},"name":{"type":"string","description":"Discovery list name."}},"required":["id","name"]}},"components/schemas/SponsoredPostEngagementResponse":{"id":"components/schemas/SponsoredPostEngagementResponse","kind":"json-schema","title":"SponsoredPostEngagementResponse","data":{"type":"object","properties":{"likes":{"type":"integer","description":"Number of likes on the post.","nullable":true},"comments":{"type":"integer","description":"Number of comments on the post.","nullable":true}}}},"components/schemas/SponsoredPostResponse":{"id":"components/schemas/SponsoredPostResponse","kind":"json-schema","title":"SponsoredPostResponse","data":{"type":"object","properties":{"post_id":{"type":"string","description":"Platform-specific post identifier.","nullable":true},"created_at":{"type":"string","description":"Timestamp the post was created, in ISO 8601 format.","nullable":true},"post_url":{"type":"string","description":"URL to the post.","nullable":true},"media_type":{"type":"string","description":"Type of media in the post, e.g. photo, video, carousel.","nullable":true},"thumbnail":{"type":"string","description":"URL to the post's thumbnail image.","nullable":true},"caption":{"type":"string","description":"Text caption of the post.","nullable":true},"mentions":{"type":"array","items":{"type":"string"},"description":"Handles mentioned in the post."},"hashtags":{"type":"array","items":{"type":"string"},"description":"Hashtags used in the post."},"engagement":{"$ref":"#/components/schemas/SponsoredPostEngagementResponse","description":"Engagement metrics for the post."}}}},"components/schemas/SubscriptionCreator":{"id":"components/schemas/SubscriptionCreator","kind":"json-schema","title":"SubscriptionCreator","data":{"type":"object","properties":{"name":{"type":"string","description":"The creator's handle on the platform."},"platform":{"type":"string","description":"The creator's social media platform."},"avatar":{"type":"string","description":"Signed URL of the creator's profile picture, or null."},"followers":{"type":"string","description":"Latest scraped follower count for the creator, or null."},"source_list":{"type":"string","description":"Name of the discovery list the creator came from, or null."},"added_at":{"type":"string","format":"date-time","description":"When the creator was added to the subscription."}},"required":["name","platform","added_at"]}},"components/schemas/SubscriptionCreatorListPage":{"id":"components/schemas/SubscriptionCreatorListPage","kind":"json-schema","title":"SubscriptionCreatorListPage","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of creators matching the filter."},"next":{"type":"string","format":"uri","description":"URL of the next page, or null on the last page.","nullable":true},"previous":{"type":"string","format":"uri","description":"URL of the previous page, or null on the first page.","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionCreator"},"description":"Creators on the current page."}},"required":["count","results"]}},"components/schemas/SubscriptionDeliveries24h":{"id":"components/schemas/SubscriptionDeliveries24h","kind":"json-schema","title":"SubscriptionDeliveries24h","data":{"type":"object","properties":{"total":{"type":"integer","description":"Deliveries attempted in the last 24 hours."},"successful":{"type":"integer","description":"Successful deliveries in the last 24 hours."},"failed":{"type":"integer","description":"Failed deliveries in the last 24 hours."}},"required":["total","successful","failed"]}},"components/schemas/SubscriptionListResponse":{"id":"components/schemas/SubscriptionListResponse","kind":"json-schema","title":"SubscriptionListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of subscriptions matching the filter."},"next":{"type":"string","format":"uri","description":"URL of the next page, or null on the last page.","nullable":true},"previous":{"type":"string","format":"uri","description":"URL of the previous page, or null on the first page.","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionResponse"},"description":"Subscriptions on the current page."},"summary":{"$ref":"#/components/schemas/SubscriptionSummary","description":"Aggregate counts across all subscriptions matching the filter."}},"required":["count","results","summary"]}},"components/schemas/SubscriptionResponse":{"id":"components/schemas/SubscriptionResponse","kind":"json-schema","title":"SubscriptionResponse","data":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"subscription_type":{"type":"string"},"platform":{"type":"string","description":"The creator's social media platform."},"event_type":{"type":"string"},"status":{"type":"string"},"paused_reason":{"type":"string"},"filters":{"type":"object","nullable":true,"additionalProperties":{}},"interval":{"type":"string","description":"Polling interval for this subscription's event type."},"notify_endpoints":{"type":"array","items":{"$ref":"#/components/schemas/NotifyEndpoint"},"description":"Endpoints the subscription's events are delivered to."},"source_lists":{"type":"array","items":{"$ref":"#/components/schemas/SourceList"},"description":"Discovery lists feeding creators into the subscription."},"sample_creators":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 3 creators (handle + avatar) attached to the subscription."},"children":[]}]}]}]},"creator_count":{"type":"string","description":"Total number of creators attached to the subscription."},"delivery_health":{"type":"string","description":"Delivery counters (total, successful, and failed deliveries)."},"last_event_at":{"type":"string","description":"Timestamp of the most recent event for this subscription."},"credits_spent":{"type":"string","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifetime listening credits attributed to this subscription, accrued daily as 0.3 × its active creators (gross per-subscription). May exceed the deduplicated amount actually charged to the billing scope when creators are shared across subscriptions."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","subscription_type","platform","event_type","status","notify_endpoints","source_lists","credits_spent","created_at","updated_at"]}},"components/schemas/SubscriptionSummary":{"id":"components/schemas/SubscriptionSummary","kind":"json-schema","title":"SubscriptionSummary","data":{"type":"object","properties":{"active_subscriptions":{"type":"integer","description":"Number of subscriptions currently active (respects the 'type' filter)."},"deliveries_24h":{"$ref":"#/components/schemas/SubscriptionDeliveries24h","description":"Delivery counters over the last 24 hours."},"success_rate":{"type":"number","format":"double","description":"All-time successful-delivery percentage, or null when there have been no deliveries.","nullable":true},"avg_detection_latency_seconds":{"type":"number","format":"double","description":"Average time from detection to successful delivery, in seconds, or null when unavailable.","nullable":true}},"required":["active_subscriptions","deliveries_24h"]}},"components/schemas/TikTokDiscoveryFilters":{"id":"components/schemas/TikTokDiscoveryFilters","kind":"json-schema","title":"TikTokDiscoveryFilters","data":{"type":"object","properties":{"location":{"type":"array","items":{"type":"string","nullable":true}},"type":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"profile_language":{"type":"array","items":{"type":"string","nullable":true}},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? + are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}],"nullable":true},"keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"exclude_keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"last_post":{"type":"string","description":"Allowed values: any, 90, 365","nullable":true},"number_of_followers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"video_count":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"engagement_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_views":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_likes":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_comments":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_video_downloads":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"posting_frequency":{"type":"number","format":"double","nullable":true},"follower_growth":{"allOf":[{"$ref":"#/components/schemas/GrowthRequest"}],"nullable":true},"has_tik_tok_shop":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"exclude_private_profile":{"type":"boolean","nullable":true},"is_verified":{"type":"boolean","nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"creator_has":{"$ref":"#/components/schemas/CreatorHasRequest"},"promotes_affiliate_links":{"type":"boolean","nullable":true},"has_done_brand_deals":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_link_in_bio":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"does_live_streaming":{"type":"boolean","nullable":true},"has_merch":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false},"exclude_handles":{"type":"array","items":{"type":"string"}},"exclude_list":{"type":"array","items":{"type":"integer"},"description":"IDs of exclusion lists to apply. Create and manage these via the Exclusion lists endpoints, then pass their IDs here; only lists for this platform are applied."},"exclude_default_list":{"type":"boolean","description":"When true, applies the team's default exclusion list for this platform.","default":false},"exclude_all_lists":{"type":"boolean","description":"When true, applies every exclusion list for this platform (the default list and all specific lists).","default":false}}}},"components/schemas/Token":{"id":"components/schemas/Token","kind":"json-schema","title":"Token","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the API key token."},"name":{"type":"string","description":"Human-readable label for the token."},"scopes":{"type":"array","items":{"type":"string"},"description":"Scopes granted to the token."},"active":{"type":"boolean","description":"Whether the token is currently active."},"expires_at":{"type":"string","format":"date-time","description":"Expiration timestamp, or null if the token never expires.","nullable":true},"token":{"type":"string","description":"The API key value used as the Bearer credential. Returned in full on every read."},"created_at":{"type":"string","format":"date-time","description":"When the token was created."},"last_used_at":{"type":"string","format":"date-time","description":"When the token was last used to authenticate a request, or null if never used.","nullable":true}},"required":["id","name","scopes","active","created_at"]}},"components/schemas/TokenCreateRequest":{"id":"components/schemas/TokenCreateRequest","kind":"json-schema","title":"TokenCreateRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable label for the token, shown in the token list. May be blank."},"scopes":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scopes to grant the token. Available value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if omitted."},"children":[]}]}]}]}}}},"components/schemas/TokenRequest":{"id":"components/schemas/TokenRequest","kind":"json-schema","title":"TokenRequest","data":{"type":"object","properties":{"grant_type":{"type":"string","enum":["authorization_code","refresh_token"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grant type. Use authorization_code for desktop/CLI apps (requires PKCE), or refresh_token to refresh an expired access token."},"children":[]}]}]}]},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization code received in the redirect. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant."},"children":[]}]}]}]},"code_verifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKCE code verifier. The random string used to generate the code_challenge. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant."},"children":[]}]}]}]},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client_id returned during client registration. Required for both grant types."},"children":[]}]}]}]},"redirect_uri":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the redirect_uri used in the authorization request. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant."},"children":[]}]}]}]},"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refresh token from a previous token response. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant."},"children":[]}]}]}]},"resource":{"type":"string","description":"RFC 8707 resource indicator. If sent, must match the resource from the authorization request."}},"required":["grant_type","client_id"]}},"components/schemas/TokenResponse":{"id":"components/schemas/TokenResponse","kind":"json-schema","title":"TokenResponse","data":{"type":"object","properties":{"access_token":{"type":"string","description":"Bearer token for authenticating API requests."},"refresh_token":{"type":"string","description":"Token used to obtain a new access token when the current one expires."},"token_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"expires_in":{"type":"integer","description":"Lifetime of the access token in seconds."},"scope":{"type":"string","description":"Space-separated list of scopes granted to this token."}},"required":["access_token","refresh_token","token_type","expires_in","scope"]}},"components/schemas/TokenUpdateRequest":{"id":"components/schemas/TokenUpdateRequest","kind":"json-schema","title":"TokenUpdateRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable label for the token, shown in the token list."},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to deactivate the token, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate it."},"children":[]}]}]}]},"expires_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration timestamp (ISO 8601). Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove the expiration and make the token non-expiring."},"children":[]}]}]}],"nullable":true},"scopes":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement list of scopes for the token. Available value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/TwitchDiscoveryFilters":{"id":"components/schemas/TwitchDiscoveryFilters","kind":"json-schema","title":"TwitchDiscoveryFilters","data":{"type":"object","properties":{"location":{"type":"array","items":{"type":"string","nullable":true}},"gender":{"type":"string","nullable":true},"profile_language":{"type":"array","items":{"type":"string","nullable":true}},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? + are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}],"nullable":true},"games_played":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"is_twitch_partner":{"type":"boolean","nullable":true,"default":false},"keywords_in_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"most_recent_stream_date":{"type":"string","description":"Allowed values: any, 30, 60, 90","nullable":true},"followers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"avg_views_last_30_days":{"$ref":"#/components/schemas/RangeRequest"},"streamed_hours_last_30_days":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"streams_count_last_30_days":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"maximum_views_count":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"creator_has":{"$ref":"#/components/schemas/CreatorHasRequest"},"promotes_affiliate_links":{"type":"boolean","nullable":true},"has_done_brand_deals":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_link_in_bio":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"does_live_streaming":{"type":"boolean","nullable":true},"has_merch":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false},"exclude_handles":{"type":"array","items":{"type":"string"}},"exclude_list":{"type":"array","items":{"type":"integer"},"description":"IDs of exclusion lists to apply. Create and manage these via the Exclusion lists endpoints, then pass their IDs here; only lists for this platform are applied."},"exclude_default_list":{"type":"boolean","description":"When true, applies the team's default exclusion list for this platform.","default":false},"exclude_all_lists":{"type":"boolean","description":"When true, applies every exclusion list for this platform (the default list and all specific lists).","default":false}}}},"components/schemas/TwitterDiscoveryFilters":{"id":"components/schemas/TwitterDiscoveryFilters","kind":"json-schema","title":"TwitterDiscoveryFilters","data":{"type":"object","properties":{"location":{"type":"array","items":{"type":"string","nullable":true}},"type":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"profile_language":{"type":"array","items":{"type":"string","nullable":true}},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? + are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}],"nullable":true},"keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"exclude_keywords_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"number_of_followers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_link_in_bio":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_in_tweets":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_not_in_tweets":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"last_post":{"type":"string","description":"Allowed values: any, 90, 365","nullable":true},"tweets_count":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"engagement_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_likes":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"creator_has":{"$ref":"#/components/schemas/CreatorHasRequest"},"promotes_affiliate_links":{"type":"boolean","nullable":true},"has_done_brand_deals":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_link_in_bio":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"does_live_streaming":{"type":"boolean","nullable":true},"has_merch":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false},"exclude_handles":{"type":"array","items":{"type":"string"}},"exclude_list":{"type":"array","items":{"type":"integer"},"description":"IDs of exclusion lists to apply. Create and manage these via the Exclusion lists endpoints, then pass their IDs here; only lists for this platform are applied."},"exclude_default_list":{"type":"boolean","description":"When true, applies the team's default exclusion list for this platform.","default":false},"exclude_all_lists":{"type":"boolean","description":"When true, applies every exclusion list for this platform (the default list and all specific lists).","default":false}}}},"components/schemas/UpdateCampaignInput":{"id":"components/schemas/UpdateCampaignInput","kind":"json-schema","title":"UpdateCampaignInput","data":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused"],"description":"Set to 'paused' or 'active'. Not allowed on draft campaigns, which activate automatically on the start date."},"content_types":{"type":"array","items":{"type":"string"},"description":"Replaces the post types counted as campaign content."},"tracking_keywords":{"type":"array","items":{"type":"string"},"description":"Replaces the campaign's tracking keywords. Pass an empty list to clear them."},"budget":{"type":"string","format":"decimal","description":"Optional campaign budget.","nullable":true,"pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"}}}},"components/schemas/UpdateCampaignInputRequest":{"id":"components/schemas/UpdateCampaignInputRequest","kind":"json-schema","title":"UpdateCampaignInputRequest","data":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused"],"description":"Set to 'paused' or 'active'. Not allowed on draft campaigns, which activate automatically on the start date."},"content_types":{"type":"array","items":{"type":"string"},"description":"Replaces the post types counted as campaign content."},"tracking_keywords":{"type":"array","items":{"type":"string"},"description":"Replaces the campaign's tracking keywords. Pass an empty list to clear them."},"budget":{"type":"string","format":"decimal","description":"Optional campaign budget.","nullable":true,"pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"}}}},"components/schemas/UpdateSubscriptionInput":{"id":"components/schemas/UpdateSubscriptionInput","kind":"json-schema","title":"UpdateSubscriptionInput","data":{"type":"object","properties":{"name":{"type":"string","description":"New subscription name."},"status":{"type":"string","enum":["active","paused"],"description":"Set to 'paused' or 'active'. Draft and completed-campaign subscriptions cannot be activated manually."},"notify_endpoints":{"type":"array","items":{"$ref":"#/components/schemas/NotifyEndpointInput"},"description":"Replaces the subscription's notify endpoints. At least one is required when provided."},"add_handles":{"type":"array","items":{"type":"string"},"description":"Creator handles to add to the subscription."},"list_ids":{"type":"array","items":{"type":"integer"},"description":"Discovery list IDs whose creators are added. Each list's platform must match the subscription's platform."},"remove_handles":{"type":"array","items":{"type":"string"},"description":"Creator handles to remove from the subscription."},"filters":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement filter object, validated against the subscription's event_type."},"children":[]}]}]}],"additionalProperties":{}}}}},"components/schemas/UpdateSubscriptionInputRequest":{"id":"components/schemas/UpdateSubscriptionInputRequest","kind":"json-schema","title":"UpdateSubscriptionInputRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"New subscription name."},"status":{"type":"string","enum":["active","paused"],"description":"Set to 'paused' or 'active'. Draft and completed-campaign subscriptions cannot be activated manually."},"notify_endpoints":{"type":"array","items":{"$ref":"#/components/schemas/NotifyEndpointInput"},"description":"Replaces the subscription's notify endpoints. At least one is required when provided."},"add_handles":{"type":"array","items":{"type":"string"},"description":"Creator handles to add to the subscription."},"list_ids":{"type":"array","items":{"type":"integer"},"description":"Discovery list IDs whose creators are added. Each list's platform must match the subscription's platform."},"remove_handles":{"type":"array","items":{"type":"string"},"description":"Creator handles to remove from the subscription."},"filters":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement filter object, validated against the subscription's event_type."},"children":[]}]}]}],"additionalProperties":{}}}}},"components/schemas/UserInfoModel":{"id":"components/schemas/UserInfoModel","kind":"json-schema","title":"UserInfoModel","data":{"type":"object","properties":{"pk":{"type":"string"},"username":{"type":"string","description":"The creator's username on the platform.","nullable":true},"full_name":{"type":"string","nullable":true},"profile_pic_url":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true}},"required":["pk"]}},"components/schemas/ValidateJWTToken":{"id":"components/schemas/ValidateJWTToken","kind":"json-schema","title":"ValidateJWTToken","data":{"type":"object","properties":{"username":{"type":"string","description":"The creator's username on the platform."},"profile_picture":{"type":"string","description":"URL to the creator's profile picture. This URL is temporary and expires after 24 hours. To keep the image, download it to your own storage before it expires.","nullable":true},"email":{"type":"string","format":"email","description":"The creator's email address."},"credits_remaining":{"type":"number","format":"double","description":"Number of enrichment credits currently available on the account."}},"required":["username","email","credits_remaining"]}},"components/schemas/YouTubeDiscoveryFilters":{"id":"components/schemas/YouTubeDiscoveryFilters","kind":"json-schema","title":"YouTubeDiscoveryFilters","data":{"type":"object","properties":{"location":{"type":"array","items":{"type":"string","nullable":true}},"type":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"profile_language":{"type":"array","items":{"type":"string","nullable":true}},"ai_search":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds creators matching a single niche (e.g., 'plant-based recipes'), 3-150 characters; only letters, numbers and # - / , . ! ? + are supported. For best results, use one niche at a time—long or multi-topic phrases return weaker matches."},"children":[]}]}]}],"nullable":true},"keywords_in_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_not_in_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_in_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_not_in_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_in_video_titles":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"keywords_not_in_video_titles":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"not_hashtags":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"topics":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"links_from_video_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"links_from_description":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"number_of_subscribers":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"engagement_percent":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_views_on_long_videos":{"$ref":"#/components/schemas/RangeRequest"},"median_views_long":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_views_on_shorts":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"number_of_videos":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"posting_frequency":{"type":"number","format":"double","nullable":true},"subscriber_growth":{"allOf":[{"$ref":"#/components/schemas/GrowthRequest"}],"nullable":true},"is_verified":{"type":"boolean","nullable":true},"last_upload_long_video":{"type":"string","description":"Allowed values: any, 90, 365","nullable":true},"last_upload_short_video":{"type":"string","description":"Allowed values: any, 90, 365","nullable":true},"has_shorts":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"shorts_percentage":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"has_community_posts":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"streams_live":{"type":"boolean","nullable":true,"default":false},"has_merch":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_podcast":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_courses":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_membership":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"has_live_videos":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true,"default":false},"is_monetizing":{"type":"boolean","nullable":true,"default":false},"income":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"long_video_duration":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_stream_views":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"average_stream_duration":{"allOf":[{"$ref":"#/components/schemas/RangeRequest"}],"nullable":true},"last_stream_upload":{"type":"string","description":"Allowed values: any, 90, 180, 365","nullable":true},"brands":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"creator_has":{"$ref":"#/components/schemas/CreatorHasRequest"},"promotes_affiliate_links":{"type":"boolean","nullable":true},"has_done_brand_deals":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"has_link_in_bio":{"type":"boolean","description":"Only true is meaningful. Sending false or null has no effect (equivalent to omitting the field).","nullable":true},"does_live_streaming":{"type":"boolean","nullable":true},"exclude_role_based_emails":{"type":"boolean","nullable":true,"default":false},"exclude_handles":{"type":"array","items":{"type":"string"}},"exclude_list":{"type":"array","items":{"type":"integer"},"description":"IDs of exclusion lists to apply. Create and manage these via the Exclusion lists endpoints, then pass their IDs here; only lists for this platform are applied."},"exclude_default_list":{"type":"boolean","description":"When true, applies the team's default exclusion list for this platform.","default":false},"exclude_all_lists":{"type":"boolean","description":"When true, applies every exclusion list for this platform (the default list and all specific lists).","default":false}}}},"components/schemas/YouTubeTopic":{"id":"components/schemas/YouTubeTopic","kind":"json-schema","title":"YouTubeTopic","data":{"type":"object","properties":{"topic_details":{"type":"string"},"sub_topic_details":{"type":"array","items":{"type":"string"}}},"required":["topic_details","sub_topic_details"]}},"schema_27":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ExclusionList"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"string","enum":["instagram","youtube","tiktok","twitch","twitter","onlyfans"]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"integer","default":0,"minimum":0},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"integer","default":1000,"minimum":1,"maximum":10000},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","additionalProperties":{}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Language"}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","default":""},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"integer","default":50,"minimum":1,"maximum":100},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Brand"}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/YouTubeTopic"}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","enum":["csv","json"],"default":"csv"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","format":"binary","description":"Default CSV file with enriched results"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"input_value":{"type":"string"},"status":{"type":"string"},"enrichment_data":{"type":"object","additionalProperties":true}}}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"string","default":"-created_at"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","default":"added_at"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string","default":"-posted_at"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","properties":{"credits_available":{"type":"number"},"credits_used":{"type":"number"}},"required":["credits_available","credits_used"]},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Token"}},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"string","default":"S256"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectedApp"}},"id":"schema_53"}},"exampleStore":{"paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example":{"value":{"platform":"instagram","nlp_search":"fitness creators in New York with over 100k followers","filters":{"location":["United States"],"number_of_followers":{"min":1000},"profile_language":["en"],"engagement_percent":{"min":0.5}},"sort":{"sort_by":"relevancy","sort_order":"desc"},"paging":{"limit":10,"page":0}},"id":"paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1json/example"},"paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1x-www-form-urlencoded/example":{"value":{"platform":"instagram","nlp_search":"fitness creators in New York with over 100k followers","filters":{"location":["United States"],"number_of_followers":{"min":1000},"profile_language":["en"],"engagement_percent":{"min":0.5}},"sort":{"sort_by":"relevancy","sort_order":"desc"},"paging":{"limit":10,"page":0}},"id":"paths/~1public~1v1~1discovery~1/post/requestBody/content/application~1x-www-form-urlencoded/example"},"paths/~1public~1v1~1discovery~1/post/requestBody/content/multipart~1form-data/example":{"value":{"platform":"instagram","nlp_search":"fitness creators in New York with over 100k followers","filters":{"location":["United States"],"number_of_followers":{"min":1000},"profile_language":["en"],"engagement_percent":{"min":0.5}},"sort":{"sort_by":"relevancy","sort_order":"desc"},"paging":{"limit":10,"page":0}},"id":"paths/~1public~1v1~1discovery~1/post/requestBody/content/multipart~1form-data/example"},"paths/~1public~1v1~1enrichment~1batch~1/post/responses/409/content/application~1json/example":{"value":{"error":"Total batch limit reached. You have 5 active batch(es). Maximum 5 allowed.","error_code":"batch_limit_reached","active_batches":5,"max_allowed":5},"id":"paths/~1public~1v1~1enrichment~1batch~1/post/responses/409/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses/404/content/application~1json/example":{"value":{"error":"Batch 'abc123' not found.","error_code":"batch_not_found"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1status~1/get/responses/404/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/400/content/application~1json/example":{"value":{"error":"Batch cannot be resumed. Current status is 'processing'.","error_code":"batch_not_resumable","current_status":"processing"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/400/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/403/content/application~1json/example":{"value":{"error":"Insufficient credits. Purchase additional credits or upgrade your plan.","error_code":"insufficient_credits","available_credits":0.5,"required_minimum":1},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/403/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/404/content/application~1json/example":{"value":{"error":"Batch 'abc123' not found.","error_code":"batch_not_found"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1resume~1/post/responses/404/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/400/content/application~1json/example":{"value":{"error":"Batch not completed yet. Current status is 'processing'.","error_code":"batch_not_ready","current_status":"processing"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/400/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/404/content/application~1json/example":{"value":{"error":"Batch 'abc123' not found.","error_code":"batch_not_found"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/404/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/503/content/application~1json/example":{"value":{"error":"This endpoint is not currently enabled. Please use the standard download endpoint.","error_code":"feature_disabled"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1download~1/get/responses/503/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/400/content/application~1json/example":{"value":{"error":"Batch not completed yet. Current status is 'processing'.","error_code":"batch_not_ready","current_status":"processing"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/400/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/404/content/application~1json/example":{"value":{"error":"Batch 'abc123' not found.","error_code":"batch_not_found"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/404/content/application~1json/example"},"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/500/content/application~1json/example":{"value":{"error":"Failed to retrieve results file. Please retry in a few minutes.","error_code":"service_error"},"id":"paths/~1public~1v1~1enrichment~1batch~1{batch_id}~1/get/responses/500/content/application~1json/example"},"paths/~1public~1v1~1accounts~1credits~1/get/responses/200/content/application~1json/example":{"value":{"credits_available":0,"credits_used":0},"id":"paths/~1public~1v1~1accounts~1credits~1/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"API_KEY"}},"servers":[{"url":"https://api-dashboard.influencers.club","description":"Production"}]},"options":{"hideTryItPanel":false,"hideDownloadButtons":true,"hideInfoMetadata":true,"downloadUrls":[],"hideSidebar":true,"mockServer":{"off":true,"position":"off"},"disableRouter":true,"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Core API Concepts","description":"**Authentication**\n\nEvery request is authenticated by a Bearer credential in the `Authorization` header. There are two types of credential, each suited to a different use case:\n\n- **[API Keys](/openapi/api-keys)** — call the API as yourself (scripts, backend services). Create and revoke them in the dashboard or via the API; you can hold several and revoke any one independently.\n- **[OAuth](/openapi/oauth)** — for applications acting on behalf of other users (desktop or CLI tools), via OAuth 2.0 with PKCE.\n\nEach credential carries one or more scopes that control what it can access. Today every credential is issued with full access; scoped, least-privilege credentials are planned.\n\n**Discovery**\n\nIdentify and evaluate creators using structured, platform-specific search criteria.\nResponses are intentionally constrained to support ranking, filtering, and selection\nat scale rather than full profile hydration.\n\n**Enrichment**\n\nRetrieve complete creator-level data once a candidate has been identified.\nEnrichment responses provide the depth required for analysis, activation,\nand downstream data workflows.\n\n**Execution modes**\n\nEnrichment is available in both synchronous and asynchronous forms.\nSingle enrichment supports real-time use cases, while batch enrichment is optimized\nfor high-throughput, non-interactive processing.\n\n**Typical usage**\n\nDiscovery and enrichment are designed as complementary stages.\nDiscovery narrows the candidate set; enrichment supplies detailed data\nfor creators that have already been qualified.\n"}},"baseSlug":"/openapi","routesMapping":{}}