Schemas

List of URLs serving Smalk content. With ?flat=true this is a flat array of URL strings instead of objects.

Your workspace API key (UUID format)

Full URL of the page requesting ad content

Visitor's User-Agent string (required for AI agent detection)

Referrer URL (required for traffic source tracking)

Client's IP address for geographic targeting

DEPRECATED. Previously used to target a specific placement; no longer recommended. Targeting is now handled automatically via page_url. Field is still accepted for backwards compatibility but should not be used in new integrations.

Render a placeholder ad instead of serving a real one: no booking is consumed, no impression is recorded, nothing is read from the database. The response is shaped exactly like a served ad, so what the page shows is what a booking would show — only the editorial content is a fixed lorem placeholder.

Current vocabulary — a frame code {generation}{format}{content}, the same value a citation widget derives from its format and content type. Format: m minimal, t teaser, p paragraph, f full. Content: o ad_only, c toc, s summary, d tldr, v video. Accepted codes: 2mo, 2mc, 2ms, 2md, 2mv, 2to, 2tc, 2ts, 2td, 2tv, 2po, 2pc, 2ps, 2pd, 2pv, 2fo, 2fc, 2fs, 2fd, 2fv.

Legacy vocabulary (deprecated) — the frame_color values that predate the codes, still accepted: no, grey, black, clear, gradient, shadow, label, preview, summary_boxed_reveal, summary_editorial_brief, summary_video_transcript, summary_toc, summary_expert_content. They render the chrome they always did; prefer a frame code.

true / 1 turns preview on with no frame. false / 0 / off, or omitting the parameter, serves the real ad. An unreadable value is never an error: it falls back to no frame. A preview in the body wins over the query string.

HTML content to inject into the page. Empty string if no active booking. IMPORTANT: When the API returns {"html": ""}, the

UUID of the active booking (only present when ad content is available)

Metadata object containing project_id, timestamp, and session_id (only present when no active booking)

URL of the page containing this placement

Per-placement frame style. Overrides the project-level PublisherBrandSafety.frame_color when set. Null = inherit project default. Applies to the booking path for every value. The no-booking shell renders only for summary_toc and summary_video_transcript (other variants need an active booking to surface).

• no - No
• grey - Grey
• black - Black
• clear - Clear
• gradient - Gradient
• shadow - Shadow
• label - Label only
• preview - Preview with gradient fade
• summary_boxed_reveal - Summary — Boxed Reveal
• summary_editorial_brief - Summary — Editorial Brief
• summary_video_transcript - Summary — Video Transcript
• summary_toc - Summary — Table of Contents
• summary_expert_content - Summary — Expert Content
• 2mo - Minimal · Ad Only
• 2mc - Minimal · Toc
• 2ms - Minimal · Summary
• 2md - Minimal · Tldr
• 2mv - Minimal · Video
• 2to - Teaser · Ad Only
• 2tc - Teaser · Toc
• 2ts - Teaser · Summary
• 2td - Teaser · Tldr
• 2tv - Teaser · Video
• 2po - Paragraph · Ad Only
• 2pc - Paragraph · Toc
• 2ps - Paragraph · Summary
• 2pd - Paragraph · Tldr
• 2pv - Paragraph · Video
• 2fo - Full · Ad Only
• 2fc - Full · Toc
• 2fs - Full · Summary
• 2fd - Full · Tldr
• 2fv - Full · Video

Last time an ad was served on this placement

Total impressions served (denormalized)

Total revenue generated (denormalized)

Optional group name for this placement (e.g., 'Homepage Hero Banner')

Publisher-defined placement ID (e.g., 'sidebar-top')

Type of placement (manual vs auto-generated)

• MANUAL - Manual Validation
• AUTO - Auto approval

Position of the placement on the page (not specified, top of page, bottom of page, middle of page, before comments, after comments, middle of comments)

• 0 - Not Specified
• 1 - Top of Page
• 2 - Bottom of Page
• 3 - Middle of the page
• 4 - Before comments
• 5 - After Comments
• 6 - Middle of Comments

Visible-text char count from start of main content container up to the placement div. Raw measurement backing placement_position. 0 with content_total_chars=0 indicates a structural fallback (div inside

Visible-text char count of the main content container on the page. Raw measurement backing placement_position.

Current status of the placement

• 0 - Unverified (awaiting HTML verification)
• 1 - Not Connected (awaiting SSAI call)
• 2 - Installed (SSAI verified, no campaign)
• 3 - Active (has active campaign)
• 4 - Inactive (manually deactivated)
• 5 - Lazy (declared inventory, awaiting first serve)

If False, this placement is excluded and will never receive ads (publisher preference)

Allowed ad formats for this placement (empty = all)

Enable automatic approval of bookings for this placement

Minimum AI validation score required for auto-approval (0-100)

Echoed Firehose request id

Server epoch milliseconds

Error message

Total records received in the payload

Records queued for processing (after validation)

The IndexNow verification key, or empty string if disabled

Optional group name for this placement (e.g., 'Homepage Hero Banner')

URL of the page containing this placement

Publisher-defined placement ID (e.g., 'sidebar-top')

Type of placement (manual vs auto-generated)

• MANUAL - Manual Validation
• AUTO - Auto approval

Position of the placement on the page (not specified, top of page, bottom of page, middle of page, before comments, after comments, middle of comments)

• 0 - Not Specified
• 1 - Top of Page
• 2 - Bottom of Page
• 3 - Middle of the page
• 4 - Before comments
• 5 - After Comments
• 6 - Middle of Comments

Visible-text char count from start of main content container up to the placement div. Raw measurement backing placement_position. 0 with content_total_chars=0 indicates a structural fallback (div inside

Visible-text char count of the main content container on the page. Raw measurement backing placement_position.

Current status of the placement

• 0 - Unverified (awaiting HTML verification)
• 1 - Not Connected (awaiting SSAI call)
• 2 - Installed (SSAI verified, no campaign)
• 3 - Active (has active campaign)
• 4 - Inactive (manually deactivated)
• 5 - Lazy (declared inventory, awaiting first serve)

If False, this placement is excluded and will never receive ads (publisher preference)

Allowed ad formats for this placement (empty = all)

Enable automatic approval of bookings for this placement

Minimum AI validation score required for auto-approval (0-100)

Per-placement frame style. Overrides the project-level PublisherBrandSafety.frame_color when set. Null = inherit project default. Applies to the booking path for every value. The no-booking shell renders only for summary_toc and summary_video_transcript (other variants need an active booking to surface).

• no - No
• grey - Grey
• black - Black
• clear - Clear
• gradient - Gradient
• shadow - Shadow
• label - Label only
• preview - Preview with gradient fade
• summary_boxed_reveal - Summary — Boxed Reveal
• summary_editorial_brief - Summary — Editorial Brief
• summary_video_transcript - Summary — Video Transcript
• summary_toc - Summary — Table of Contents
• summary_expert_content - Summary — Expert Content
• 2mo - Minimal · Ad Only
• 2mc - Minimal · Toc
• 2ms - Minimal · Summary
• 2md - Minimal · Tldr
• 2mv - Minimal · Video
• 2to - Teaser · Ad Only
• 2tc - Teaser · Toc
• 2ts - Teaser · Summary
• 2td - Teaser · Tldr
• 2tv - Teaser · Video
• 2po - Paragraph · Ad Only
• 2pc - Paragraph · Toc
• 2ps - Paragraph · Summary
• 2pd - Paragraph · Tldr
• 2pv - Paragraph · Video
• 2fo - Full · Ad Only
• 2fc - Full · Toc
• 2fs - Full · Summary
• 2fd - Full · Tldr
• 2fv - Full · Video

Last time an ad was served on this placement

Total impressions served (denormalized)

Total revenue generated (denormalized)

URL to the website's favicon

Whether the project/workspace is active and usable

Date when this project/workspace will be deactivated due to subscription cancellation

Whether the publisher ads are enabled for this project

Whether the advertiser ads are enabled for this project

Whether legacy GEO features are enabled for this project

Whether AI traffic analytics are enabled for this project

Whether the publisher GEO solution (GEO Campaigns + GEO-Ready Articles) is activated for this project. Flipped by staff when a PublisherGEOActivationRequest is approved.

The brand safety category the project belongs to

• 0 - Unknown
• 1 - Apparel
• 2 - Clothing
• 3 - Children's Clothing
• 4 - Formal Wear
• 5 - Men's Clothing
• 6 - Plus Size Clothing
• 7 - Shirts, Tops & Blouses
• 8 - Sleepwear
• 9 - Swimwear
• 10 - Underwear
• 11 - Women's Clothing
• 12 - Footwear
• 13 - Athletic Shoes
• 14 - Jewelry
• 15 - Watches & Watch Accessories
• 16 - Handbags & Purses
• 17 - Sunglasses
• 18 - Arts & Entertainment
• 19 - Arts & Entertainment Awards
• 20 - Entertainment Industry
• 21 - Film & TV Industry
• 22 - Events, Shows & Cultural Attractions
• 23 - Ticket Sales & Exchanges
• 24 - Fantasy Sports
• 25 - Fun & Trivia
• 26 - Fun Tests & Silly Surveys
• 27 - Humor & Jokes
• 28 - Movies & Films
• 29 - Horror Films
• 30 - Music & Audio
• 31 - Music Streams & Downloads
• 32 - Radio
• 33 - Offbeat
• 34 - Edgy & Bizarre
• 35 - Sports Event Tickets & Ticketing Services
• 36 - TV & Video
• 37 - TV Broadcasting
• 38 - TV Shows & Programs
• 39 - Visual Art & Design
• 40 - Autos & Vehicles
• 41 - Boats & Watercraft
• 42 - Driving Instruction & Driver Education
• 43 - Motor Vehicles
• 44 - Campers & RVs
• 45 - Cars & Trucks
• 46 - Hybrid & Alternative Vehicles
• 47 - Motorcycles
• 48 - Used Motor Vehicles
• 49 - Vehicle Dealers
• 50 - Vehicle Parts & Accessories
• 51 - Vehicle Repair & Maintenance
• 52 - Beauty & Personal Care
• 53 - Anti-Aging
• 54 - Body Art
• 55 - Hair Care
• 56 - Shampoos & Conditioners
• 57 - Hygiene & Toiletries
• 58 - Antiperspirants, Deodorants & Body Spray
• 59 - Feminine Hygiene Products
• 60 - Make-Up & Cosmetics
• 61 - Oral Care
• 62 - Perfumes & Fragrances
• 63 - Shaving & Grooming
• 64 - Skin Care
• 65 - Face Care
• 66 - Hand & Body Soaps & Cleansers
• 67 - Spa & Medical Spa
• 68 - Tanning & Sun Care
• 69 - Business & Industrial
• 70 - Building Construction & Maintenance
• 71 - Building Materials & Supplies
• 72 - Commercial & General Contracting
• 73 - HVAC & Climate Control
• 74 - Hardware Tools & Accessories
• 75 - Chemical Industry
• 76 - Commercial & Industrial Printing
• 77 - Design & Engineering
• 78 - Energy Industry
• 79 - Oil & Gas
• 80 - Renewable & Alternative Energy
• 81 - Food Service Industry
• 82 - Industrial Goods & Manufacturing
• 83 - Industrial Electronics
• 84 - Plant & Facility
• 85 - Office
• 86 - Office Appliances
• 87 - Office & Facilities Management
• 88 - Scientific Equipment & Services
• 89 - Security Equipment & Services
• 90 - Guns & Firearms
• 91 - Security Weapons
• 92 - Travel & Tourism
• 93 - Accommodations
• 94 - Hotels, Motels & Resorts
• 95 - Vacation Rentals
• 96 - Air Travel
• 97 - Cruises & Cruise Services
• 98 - Last Minute Travel
• 99 - Luggage
• 100 - Specialty Travel
• 101 - Tourist Attractions & Destinations
• 102 - Transportation & Excursions
• 103 - Bus & Rail Services
• 104 - Car Rental Services
• 105 - Taxi Services
• 106 - Travel Booking Services
• 107 - Travel Media & Publications
• 108 - Vacation Packages
• 109 - Other
• 110 - Cosmetic Procedures & Body Modification
• 111 - Dating
• 112 - Downloadable Utilities
• 113 - Drugs & Supplements
• 114 - Get Rich Quick
• 115 - Politics
• 116 - References to Sex
• 117 - Religiond
• 118 - Sensationalism
• 119 - Sexual & Reproductive Health
• 120 - Social Casino Games
• 121 - Weight Loss
• 122 - Alcohol
• 123 - Blocked
• 124 - Gambling & Betting (18+)

The industry the project belongs to

• 99 - Other
• 1 - Travel and Tourism
• 2 - Food and Beverage
• 3 - Bank and Assurance
• 4 - Public Administration
• 5 - Consulting
• 6 - Real Estate
• 7 - Gaming
• 8 - Health and Wellness
• 9 - Home, Furniture and Appliances
• 10 - Kids and Parentality
• 11 - Legal Services
• 12 - Lifestyle
• 13 - Marketing Advices
• 14 - Communication Advices
• 15 - Media and Entertainment
• 16 - Mental health and Psychology
• 17 - Restaurants and Bars
• 18 - Science
• 19 - Music
• 20 - News
• 21 - Personal Blog
• 22 - Pets
• 23 - Photo and Video
• 24 - Politics
• 25 - Arts and Crafts
• 26 - Automotive and Transportation
• 27 - Beauty and Skincare
• 28 - Fashion and Luxury
• 29 - Business-Entrepreneurship
• 30 - Climate/Environment
• 31 - Culture
• 32 - DIY and Home renovation
• 33 - E-commerce/Store
• 34 - Shopping/Retail
• 35 - Education-Training
• 36 - Finance/Investing
• 37 - Software/Apps
• 38 - Sports, Fitness/Outdoors
• 39 - Heavy Industry

The organization this project belongs to

• publisher - publisher
• advertiser - advertiser

The URL path being visited (e.g., '/blog/my-article')

HTTP method of the request (GET, POST, etc.)

• GET - GET
• POST - POST
• PUT - PUT
• HEAD - HEAD
• DELETE - DELETE
• PATCH - PATCH
• OPTIONS - OPTIONS
• TRACE - TRACE

Filtered request headers. Only include: User-Agent (required), Referer (recommended). IP-bearing headers (X-Real-IP, X-Forwarded-For) are dropped server-side for GDPR and need not be sent. Do NOT include sensitive headers like Authorization, Cookie, or tokens.