Get UGC Database Facets
get_ugc_database_facetsShow what the UGC Database holds for a set of filters: counts per niche, country, state/region, city, tier, platform, language, gender, estimated age band, email type, signal (including proven, for_hire and has_rates), brand (brands worked with), creator type, service, portfolio type, on camera, setting, production and saturation, market insights (including rates_pct and median_rate_usd, the median stated UGC video rate), and the user's unlock access and remaining leads. Use it to pick valid filter values and to size an audience before searching or unlocking. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uid | No | Optional Firebase uid. Must match the URL uid unless local fallback is enabled. | |
| view | No | all (default), net_new = not yet delivered to the user, unlocked = already unlocked. | |
| query | No | Word-prefix search over handle, name, niche, labels and bio ('ugc' matches kit.ugc). | |
| tiers | No | starter 0-999, nano 1k-9,999, micro 10k-99,999, mid 100k-499,999, macro 500k+ followers. | |
| brands | No | Worked with any of these brands ('Poppi', 'Cal AI'), verified (proven) or named in their bio; case-insensitive. get_ugc_database_facets lists brand names. | |
| cities | No | Cities the creator says they are based in, English names ('Austin', 'London', 'Mexico City'); case-insensitive. Combine with countries to disambiguate. | |
| niches | No | Niche labels or keys; use get_ugc_database_facets for valid values. | |
| genders | No | ||
| regions | No | States or regions the creator says they are based in, English names ('Texas', 'England', 'Ontario'); case-insensitive. Combine with countries to disambiguate. get_ugc_database_facets lists valid values. | |
| signals | No | All must match: ugc wording, portfolio link, brand collabs, engagement stats, untapped (no other brand got this creator), proven (verified UGC made for at least one brand, with proof posts), for_hire (says they take paid UGC work), has_rates (publishes their own rates on a rate card or portfolio page). | |
| services | No | Offers any of these services. | |
| settings | No | Where their recent posts are usually filmed. | |
| age_bands | No | Estimated age band from profile photos and bio (an estimate, not a verified age); unknown = not estimated. | |
| countries | No | ISO alpha-2 codes (GB is read as UK), or 'unknown'. | |
| languages | No | ||
| on_camera | No | Appears on camera in recent posts (no = faceless). | |
| platforms | No | ||
| email_kinds | No | ||
| productions | No | Production style of recent posts. | |
| saturations | No | How many brands they already work with: fresh 0, low 1-2, medium 3-5, high 6+. | |
| bearer_token | No | Optional Firebase ID token. Hosted clients normally authenticate with an API key header or ?uid= in the URL instead. | |
| max_rate_usd | No | Budget cap in USD: only creators whose lowest stated UGC video rate (rate_min_usd) is at or below this. Creators who state no rate are excluded. Rates are self-published by the creator, not verified. | |
| min_hit_rate | No | Minimum hit rate: share of the creator's posts with 10,000+ views, as a 0-1 fraction (0.25 = 25%). Creators without post metrics are excluded. | |
| creator_types | No | Account type; ugc_creator and both are creators who make UGC for brands. | |
| max_followers | No | ||
| min_followers | No | ||
| exclude_niches | No | ||
| portfolio_types | No | Where the creator keeps their portfolio, from their links. | |
| min_median_views | No | Minimum median views per post. | |
| added_within_days | No |