Console API

Import data

19 endpoints.

GET/api/v1/admin/businesses/{business_id}/import-data/custom-imports

List custom import runs

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_CustomImportRunData__

Field Type Description

request_idrequired string

success true default true

datarequired

CustomImportRunData[]

CustomImportRunData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`import_name`	`string \| null`
`status`required	`enum`	one of "queued", "running", "awaiting_review", "completed", "failed"
`merge_mode`required	`string`
`text_content`	`string \| null`
`ingest`	`ImportDataStageStatus \| null`	ImportDataStageStatus fields ImportDataStageStatus (not expanded)
`extract`	`ImportDataStageStatus \| null`	ImportDataStageStatus fields ImportDataStageStatus (not expanded)
`merge`	`ImportDataStageStatus \| null`	ImportDataStageStatus fields ImportDataStageStatus (not expanded)
`created_at`required	`integer`
`updated_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/import-data/custom-imports

Create a custom import run

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

Provide at least one uploaded file or some text content.

multipart/form-dataBody_create_custom_import_api_v1_admin_businesses__business_id__import_data_custom_imports_post

Field	Type	Description
`import_name`	`string \| null`
`text_content`	`string \| null`
`files`	`string[] \| null`	string[] \| null fields

Responses

201Successful Response

application/jsonSuccessResponse_CustomImportActionResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

CustomImportActionResponseData

CustomImportActionResponseData fields

Field	Type	Description
`run`required	`CustomImportRunData`	CustomImportRunData fields CustomImportRunData, expanded above.

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}

Get a custom import run

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_CustomImportRunData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`CustomImportRunData`	CustomImportRunData fields CustomImportRunData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}/extract

Re-run extraction on stored custom import content

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ReExtractResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

ReExtractResponseData

ReExtractResponseData fields

Field	Type	Description
`run_id`required	`string`
`status`required	`string`
`attempt_id`required	`string`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}/extraction

Get the latest custom import extraction payload

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_CustomImportExtractionData_

Field Type Description

request_idrequired string

success true default true

datarequired

CustomImportExtractionData

CustomImportExtractionData fields

Field Type Description

attempt_idrequired string

run_idrequired string

statusrequired enum one of "queued", "running", "completed", "failed"

extractor_versionrequired string

started_at integer | null

completed_at integer | null

payload

ExtractionPayloadData

ExtractionPayloadData fields

Field	Type	Description
`business_profile`	`ExtractedBusinessProfileData \| null`	ExtractedBusinessProfileData fields ExtractedBusinessProfileData (not expanded)
`services`	`ExtractedServiceData[]`	ExtractedServiceData[] fields Nested object (not expanded)
`packages`	`ExtractedPackageData[]`	ExtractedPackageData[] fields Nested object (not expanded)
`service_items`	`ExtractedServiceItemData[]`	ExtractedServiceItemData[] fields Nested object (not expanded)
`jobs`	`ExtractedJobPostingData[]`	ExtractedJobPostingData[] fields Nested object (not expanded)
`faqs`	`ExtractedFaqData[]`	ExtractedFaqData[] fields Nested object (not expanded)
`locations`	`ExtractedLocationData[]`	ExtractedLocationData[] fields Nested object (not expanded)
`team_members`	`ExtractedTeamMemberData[]`	ExtractedTeamMemberData[] fields Nested object (not expanded)
`blog_posts`	`ExtractedBlogPostData[]`	ExtractedBlogPostData[] fields Nested object (not expanded)
`blog_post_authors`	`ExtractedBlogPostAuthorData[]`	ExtractedBlogPostAuthorData[] fields Nested object (not expanded)
`blog_post_tags`	`string[]`	string[] fields Nested object (not expanded)
`contexts`	`ExtractedContextData \| ExtractedTypedContextData[] \| null`	ExtractedContextData \| ExtractedTypedContextData[] \| null fields Nested object (not expanded)

summary object | null

error_message string | null

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}/files

List files attached to a custom import run

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`limit`	query	`integer`	default 25
`cursor`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_CustomImportFileData__

Field Type Description

request_idrequired string

success true default true

datarequired

CustomImportFileData[]

CustomImportFileData[] fields

Field	Type	Description
`id`required	`string`
`original_filename`required	`string`
`mime_type`	`string \| null`
`byte_size`	`integer \| null`
`checksum_sha256`	`string \| null`
`storage_bucket`	`string \| null`
`storage_blob_name`	`string \| null`
`storage_object_url`	`string \| null`
`extracted_text`	`string \| null`
`normalized_text`	`string \| null`
`parse_status`required	`string`
`parse_error`	`string \| null`
`created_at`required	`integer`
`updated_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}/files/{file_id}/download

Download a stored custom import file

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`file_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonany

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}/merge

Apply a selected subset of a custom import into the business record

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonMergeSelectionBody

Field Type Description

extract_attempt_idrequired string

business_profile

MergeBusinessProfileSelection | null

MergeBusinessProfileSelection fields

Field	Type	Description
`scalars`	`string[]`	string[] fields
`contact_info`	`string[]`	string[] fields
`address`	`boolean`	default false
`descriptions`	`string[]`	string[] fields
`social_profiles`	`string[]`	string[] fields

services

integer[]

integer[] fields

packages

integer[]

integer[] fields

service_items

integer[]

integer[] fields

offers

integer[]

integer[] fields

jobs

integer[]

integer[] fields

faqs

integer[]

integer[] fields

locations

integer[]

integer[] fields

team_members

integer[]

integer[] fields

blog_posts

integer[]

integer[] fields

blog_post_authors

integer[]

integer[] fields

blog_post_tags

integer[]

integer[] fields

contexts boolean default false

Responses

200Successful Response

application/jsonSuccessResponse_MergeApplyResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

MergeApplyResponseData

MergeApplyResponseData fields

Field Type Description

run_idrequired string

statusrequired string

merge_summaryrequired

MergeSummaryData

MergeSummaryData fields

Field	Type	Description
`business_profile`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`services`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`packages`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`service_items`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`jobs`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`faqs`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`locations`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`team_members`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`blog_posts`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`blog_post_authors`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`blog_post_tags`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`contexts`	`MergeEntityCounts`	MergeEntityCounts fields MergeEntityCounts (not expanded)
`warnings`	`object[]`	object[] fields Nested object (not expanded)
`provenance`	`object[]`	object[] fields Nested object (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/custom-imports/{import_run_id}/review

Get the merged review view for a custom import run

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`import_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_CustomImportReviewData_

Field Type Description

request_idrequired string

success true default true

datarequired

CustomImportReviewData

CustomImportReviewData fields

Field Type Description

runrequired

CustomImportRunData

CustomImportRunData fields

CustomImportRunData, expanded above.

extraction

CustomImportExtractionData | null

CustomImportExtractionData fields

CustomImportExtractionData, expanded above.

merge_summary

MergeSummaryData | null

MergeSummaryData fields

MergeSummaryData, expanded above.

current_business_profile

ExtractedBusinessProfileData | null

ExtractedBusinessProfileData fields

Field	Type	Description
`company_name`	`string \| null`
`year_founded`	`integer \| null`
`website_url`	`string \| null`
`tagline`	`string \| null`
`address`	`Address \| null`	Address fields Address (not expanded)
`contact_info`	`ContactInfo \| null`	ContactInfo fields ContactInfo (not expanded)
`descriptions`	`Descriptions \| null`	Descriptions fields Descriptions (not expanded)
`social_profiles`	`SocialProfiles \| null`	SocialProfiles fields SocialProfiles (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes

List website scrape runs

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_WebsiteScrapeRunData__

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteScrapeRunData[]

WebsiteScrapeRunData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`submitted_url`required	`string`
`normalized_domain`required	`string`
`status`required	`enum`	one of "queued", "running", "awaiting_review", "completed", "failed"
`scope_mode`required	`string`
`merge_mode`required	`string`
`onboarding`	`object \| null`
`rescrape_of`	`string \| null`
`last_heartbeat_at`	`integer \| null`
`crawl`	`ImportDataStageStatus \| null`	ImportDataStageStatus fields ImportDataStageStatus (not expanded)
`extract`	`ImportDataStageStatus \| null`	ImportDataStageStatus fields ImportDataStageStatus (not expanded)
`merge`	`ImportDataStageStatus \| null`	ImportDataStageStatus fields ImportDataStageStatus (not expanded)
`created_at`required	`integer`
`updated_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/import-data/website-scrapes

Start a website scrape run

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonWebsiteScrapeStartBody

Field	Type	Description
`website_url`required	`string`
`idempotency_key`	`string \| null`
`rescrape_of`	`string \| null`
`auto_onboard`	`boolean`	default false
`user_prompt`	`string \| null`

Responses

201Successful Response

application/jsonSuccessResponse_RunActionResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

RunActionResponseData

RunActionResponseData fields

Field	Type	Description
`run`required	`WebsiteScrapeRunData`	WebsiteScrapeRunData fields WebsiteScrapeRunData, expanded above.
`reused_existing_run`	`boolean`	default false

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}

Get a website scrape run

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteScrapeRunData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`WebsiteScrapeRunData`	WebsiteScrapeRunData fields WebsiteScrapeRunData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/assets

List stored crawl assets for a website scrape

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`limit`	query	`integer`	default 100
`cursor`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_WebsiteScrapeAssetData__

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteScrapeAssetData[]

WebsiteScrapeAssetData[] fields

Field	Type	Description
`id`required	`string`
`page_id`	`string \| null`
`asset_url`required	`string`
`asset_host`	`string \| null`
`asset_type`required	`string`
`mime_type`	`string \| null`
`alt_text`	`string \| null`
`source_page_url`	`string \| null`
`width`	`integer \| null`
`height`	`integer \| null`
`byte_size`	`integer \| null`
`checksum_sha256`	`string \| null`
`download_status`required	`string`
`download_error`	`string \| null`
`storage_status`required	`string`
`storage_error`	`string \| null`
`storage_provider`	`string \| null`
`storage_bucket`	`string \| null`
`storage_blob_name`	`string \| null`
`storage_object_url`	`string \| null`
`created_at`required	`integer`
`updated_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/extract

Re-run extraction on stored website scrape pages

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ReExtractResponseData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ReExtractResponseData`	ReExtractResponseData fields ReExtractResponseData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/extraction

Get the latest website scrape extraction payload

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteScrapeExtractionData_

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteScrapeExtractionData

WebsiteScrapeExtractionData fields

Field	Type	Description
`attempt_id`required	`string`
`run_id`required	`string`
`status`required	`enum`	one of "queued", "running", "completed", "failed"
`extractor_version`required	`string`
`started_at`	`integer \| null`
`completed_at`	`integer \| null`
`payload`	`ExtractionPayloadData`	ExtractionPayloadData fields ExtractionPayloadData, expanded above.
`summary`	`object \| null`
`error_message`	`string \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/merge

Apply a selected subset of extracted data into the business record

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonMergeSelectionBody

MergeSelectionBody, expanded above.

Responses

200Successful Response

application/jsonSuccessResponse_MergeApplyResponseData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`MergeApplyResponseData`	MergeApplyResponseData fields MergeApplyResponseData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/pages

List stored crawl pages for a website scrape

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`limit`	query	`integer`	default 50
`cursor`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_WebsiteScrapePageData__

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteScrapePageData[]

WebsiteScrapePageData[] fields

Field	Type	Description
`id`required	`string`
`url`required	`string`
`normalized_url`required	`string`
`title`	`string \| null`
`http_status`	`integer \| null`
`content_type`	`string \| null`
`depth`required	`integer`
`markdown`	`string \| null`
`cleaned_html`	`string \| null`
`raw_text`	`string \| null`
`metadata_json`	`object \| null`
`links_json`	`object \| null`
`images_json`	`object[] \| null`	object[] \| null fields Nested object (not expanded)
`crawl_error`	`string \| null`
`created_at`required	`integer`
`updated_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/pages/{page_id}

Get a stored crawl page

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`page_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteScrapePageData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`WebsiteScrapePageData`	WebsiteScrapePageData fields WebsiteScrapePageData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/import-data/website-scrapes/{scrape_run_id}/review

Get the merged review view for a website scrape

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`scrape_run_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_WebsiteScrapeReviewData_

Field Type Description

request_idrequired string

success true default true

datarequired

WebsiteScrapeReviewData

WebsiteScrapeReviewData fields

Field	Type	Description
`run`required	`WebsiteScrapeRunData`	WebsiteScrapeRunData fields WebsiteScrapeRunData, expanded above.
`extraction`	`WebsiteScrapeExtractionData \| null`	WebsiteScrapeExtractionData fields WebsiteScrapeExtractionData, expanded above.
`merge_summary`	`MergeSummaryData \| null`	MergeSummaryData fields MergeSummaryData, expanded above.
`current_business_profile`	`ExtractedBusinessProfileData \| null`	ExtractedBusinessProfileData fields ExtractedBusinessProfileData, expanded above.

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.