Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 3.17 KB

input-reference.md

File metadata and controls

24 lines (21 loc) · 3.17 KB

Houzz input reference

Use houzzUrls for supported URLs. Advanced IDs and usernames can be combined with URLs. At least one target is needed. Prefill is a small example, not an implicit target for API requests.

Field Type Default Description
houzzUrls array null Paste supported houzz.com photo category, photo, professional, product, discussion or numeric ideabook URLs. Different types can be mixed. Category URLs select the category only, not extra style or location filters. For IDs or usernames, use Advanced: IDs and usernames.
maxItems integer 300 Total delivered records across all targets, including related projects, reviews, answers and comments. Categories are processed first; the run stops when this limit is reached.
includeProfessionalProjects boolean true Return the public project list for every professional target.
includeProjectDetails boolean false Fetch the full public project record, including description, year started and photo IDs, for every project found. Only applies when Include professional projects is enabled.
includeProductReviews boolean true Return the public review summary and latest reviews for every product target.
includeAnswers boolean true Return the public answers for every discussion target.
includeComments boolean false Return public comments for photo targets and idea gallery targets.
maxPhotosPerTopic integer 40 Maximum number of distinct photos collected from each photo category.
maxProjectsPerProfessional integer 20 Maximum number of public projects returned for each professional target.
photoTopics array null Houzz photo category URLs or numeric topic IDs. Copy a category URL from Houzz, for example https://www.houzz.com/photos/kitchen-ideas-and-designs-phbr0-bp~t_709, or enter the topic ID 709. The Actor reads the ID from the URL and browses that category.
photoIds array null Specific Houzz photos to collect. Paste photo URLs or numeric photo IDs. A URL such as https://www.houzz.com/photos/example-phvw-vp~160172880 resolves to photo ID 160172880.
professionalIds array null Houzz professional profile URLs or numeric user IDs. A URL such as https://www.houzz.com/professionals/kitchen-and-bath-remodelers/example-pfvwus-pf~1006662065 resolves to professional ID 1006662065.
professionalUsernames array null Houzz profile usernames such as designit. Use this when a profile URL does not expose a numeric professional ID.
productIds array null Houzz product URLs or numeric product IDs. A URL such as https://www.houzz.com/products/example-prvw-vr~200622379 resolves to product ID 200622379.
questionIds array null Houzz discussion URLs or numeric question IDs. A URL such as https://www.houzz.com/discussions/layout-advice-6621384 resolves to discussion ID 6621384.
galleryIds array null Numeric Houzz idea gallery IDs. The Actor returns the gallery items and, optionally, its public comments.

Photo category URLs select the category; extra style/location filters are not reproduced. Use known profiles, not professional-directory search URLs.