MImiddesk
websites

Retrieve website analysis for a business

Changed on

Returns website analysis data including domain info, pages, and quality indicators

get/v1/businesses/{business_id}/website

Request

Path parameters

business_idstring required

Business ID

Query parameters

includestring

Include additional data. Use "indicator_details" to include source examples and explanations for each indicator

Response

website analysis found

object'website' required
idstring uuid required
urlstring uri nullable required

The URL that was passed or found for the Business

created_atstring date-time required
updated_atstring date-time required
status'online' | 'offline' | 'unknown' required
http_status_codeinteger nullable

HTTP response status code

titlestring nullable

Website page title

descriptionstring nullable

Website meta description

parkedboolean nullable required

Whether the domain is parked

submittedboolean required

Whether the website was submitted by user

errorstring nullable

Error message if website analysis failed

categorystring nullable

Website category classification

platformstring nullable

Website platform (e.g., instagram.com, facebook.com)

posts_summarystring nullable

Summary of posts found on the website or linked social media profiles

reviews_summarystring nullable

Summary of reviews found on the website or linked third-party profiles

business_idstring uuid required
business_name_matchboolean required

Whether website content matches business name

peopleobject[] nullable

People found on website

Changes

  • 4c9cd4e834baRevision changes
    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      removed from the // response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

  • 668373c892ceRevision changes
    • info

      api operation id getBusinessWebsite removed and replaced with websites_getBusinessWebsite