Skip to main content
Every screen and flow in Refero is tagged with structured metadata. Here’s what you’ll find in the responses.

​
Screens

A screen is a single page or view from a real product. Each screen has:
  • screen_id — unique identifier
  • platform — "web" or "ios"
  • site / site_name — the product it comes from (e.g., “Notion”, “Stripe”). In search results: site_name (string). In detail responses: site (object with name, categories, tagline, url).
  • page_types — what kind of page it is (e.g., “Pricing & Plans”, “Dashboard”, “Settings”). Can be empty.
  • ux_patterns — design patterns used (e.g., “Plan Comparison”, “Testimonials”, “Filter & Sorting”)
  • ui_elements — components present (e.g., “Button”, “Table”, “Modal”, “Toggle”)
  • fonts — typefaces used (e.g., ["Inter"], ["SF Pro", "New York"])
  • description — detailed AI-generated description of the screen’s design (200-400 words). Covers layout, colors, typography, and interactions.
  • content (detail only) — nested object with description, layout, functions. Each is a detailed prose field.
  • image — screenshot when requested. null when image_size is "none".
  • thumbnail_url — always present. URL to a small preview image.
  • url — link to the screen on refero.design
  • similar_screens — related screens when requested via include_similar
  • flows — associated flow if the screen is part of one. Often null.

​
Flows

A flow is a multi-step user journey — like signing up, completing onboarding, or managing a subscription. Each flow has:
  • flow_id — unique identifier
  • platform — "web" or "ios"
  • app — the product (object with name, categories, tagline). This is called app in flow details, unlike screens which use site. In flow search results, it’s flat: site_name (for web) or app_name (for iOS).
  • flow_name — what the flow does (e.g., “Complete checkout with promo code”)
  • screens_count — number of steps
  • description — what happens in the flow
  • problem — what user problem this flow solves
  • steps — array of step objects, each containing:
    • step — step number (1, 2, 3…)
    • screen_id — ID of the screen for this step
    • screen_name — name of the screen
    • goal — what the user wants to accomplish at this step
    • action — what the user does
    • system_response — how the product responds
    • page_types, ux_patterns, ui_elements, fonts — same as screen metadata
    • content — same nested object as screen detail (description, layout, functions)
    • thumbnail_url — preview image for this step
  • related_queries — suggested search queries to find related flows and screens (typically 5-10 suggestions)

​
Taxonomy

Refero tags every screen with structured categories. Here are the main dimensions: Page types (45+) — what the page does: Dashboard, Pricing & Plans, Settings, Profile, Onboarding, Login & Sign Up, Landing Page, Product Page, Search Results, Checkout, Error Page, Empty State, Paywall, Analytics, Notification Center, File Manager, Chat, Calendar, Email, Documentation, and more. UX patterns (87+) — how the page achieves its goals: Testimonials, Filter & Sorting, Plan Comparison, Social Proof, Reviews & Rating, Dark Mode, Skeleton Loading, Drag & Drop, Infinite Scroll, Breadcrumbs, Wizard, Progressive Disclosure, and more. UI elements (69+) — what components are on the page: Button, Table, Modal, Toggle, Card, Chart, Sidebar, Navigation Bar, Tab, Accordion, Toast, Tooltip, Avatar, Badge, Slider, Color Picker, and more. Categories — what industry the product belongs to: AI, SaaS, E-commerce, Fintech, Social Media, Health, Education, Productivity, Design Tools, Developer Tools, Collaboration Tools, and more.
These lists are not exhaustive — Refero’s taxonomy grows as new products and patterns are added. Use them as a guide for what to expect in responses.

​
Search vs Detail responses

When you search (via refero_search_screens or refero_search_flows), you get flat, compact results:
  • site_name (string), site_categories (array), site_tagline (string)
  • description (string) — a single description field
When you get details (via refero_get_screen or refero_get_flow), you get nested, richer data:
  • site or app (object with name, categories, tagline)
  • content (object with description, layout, functions)
This is intentional — search results are compact for scanning, detail results give you everything.

​
Platform differences

Web screens use site_name / site for the product. Web products have url fields.

​
Next

Tools

See all 4 tools with parameters and example responses.

Examples

Real workflows showing how to use the data in practice.