All guides
User

Business Finder

Screen guide

Before you start

Use the account and workspace that own the relevant records. The feature also needs to be enabled for this installation and plan.

Open this feature
  1. Open /portal/business-finder on your site.

Steps

Use Apply filters

  1. Open /portal/business-finder on your application domain, using the workspace account for this task.
  2. Find the form containing Date range, From, To. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
  3. Select Apply filters. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
FieldWhat to enter or choose
Date rangeUse the date/time picker. Check the date range and the timezone shown by your account or this screen.
FromEnter the from for this task, using the help or example shown by the form.
ToEnter the to for this task, using the help or example shown by the form.
SourceEnter the source for this task, using the help or example shown by the form.
TaskEnter the task for this task, using the help or example shown by the form.

Use Start collection

  1. Open /portal/business-finder on your application domain, using the workspace account for this task.
  2. Find the form containing Task name, Business type, city, country — one per line, Maximum results per query. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
  3. Select Start collection. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
FieldWhat to enter or choose
Task nameEnter the task name for this task, using the help or example shown by the form. The form’s example is Cafés in our target cities. Replace it with your own value. Maximum 160 characters.
Business type, city, country — one per lineRequired. Enter the business type, city, country — one per line for this task, using the help or example shown by the form. The form’s example is Coffee shops, Ho Chi Minh City, Vietnam Coffee shops, Da Nang, Vietnam Coffee shops, Hanoi, Vietnam. Replace it with your own value.
Maximum results per queryRequired. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1.

Use Save connections

  1. Open /portal/business-finder on your application domain, using the workspace account for this task.
  2. Find the form containing API key, Remove the saved API key, Enable for this workspace. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
  3. Select Save connections. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
FieldWhat to enter or choose
API keyEnter the value privately from your account or the service configuration. Do not use sample credentials from a guide. The form’s example is Paste a key, or leave blank to keep the saved key. Replace it with your own value.
Remove the saved API keyEnter the remove the saved api key for this task, using the help or example shown by the form.
Enable for this workspaceEnter the enable for this workspace for this task, using the help or example shown by the form.
Enable PHP HTTP scraper for this workspaceEnter the enable php http scraper for this workspace for this task, using the help or example shown by the form.

Use Save changes

  1. Open /portal/business-finder on your application domain, using the workspace account for this task.
  2. Find the form containing Lead stage, Team notes, Archive this lead (can be restored). Complete the relevant fields using the table below. Fields can appear or change after you select an option.
  3. Select Save changes. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
FieldWhat to enter or choose
Lead stageChoose New, Qualified, Contacted, Not a fit.
Team notesEnter the team notes for this task, using the help or example shown by the form. The form’s example is Add context for your team…. Replace it with your own value. Maximum 5000 characters.
Archive this lead (can be restored)Enter the archive this lead (can be restored) for this task, using the help or example shown by the form.

Fields and choices

Field descriptions appear beside each task above so that separate forms are not mixed together.

Check the result

  1. Stay in the same account/workspace and reopen the intended record or result screen.
  2. For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
  3. For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.

Common problems

ProblemWhat to check
The screen or action is missingCheck the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint.
A field is rejectedRead its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice.
A list is emptyCheck the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing.
A request is still pendingCheck its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately.

Technical reference

Role-scoped source references

Pinned commit: 1d0944d30f606782c9abf5b878224cdd3cd09b99

Source-only route information
MethodSource-default route
GET/portal/business-finder
GET/portal/business-finder/assets/{asset}
GET/portal/business-finder/state
GET/portal/business-finder/reports
GET/portal/business-finder/reports/export
GET/portal/business-finder/leads
GET/portal/business-finder/export
POST/portal/business-finder/runs
POST/portal/business-finder/runs/{id}/cancel
PUT/portal/business-finder/connections
PUT/portal/business-finder/leads/{id}
Unmapped fields — not user instructions

These fields belong to this role’s source handler, but their screen labels were not confirmed.

Source keyHandler
titlemodules/AppBusinessFinder/Http/Controllers/FinderController.php
modemodules/AppBusinessFinder/Http/Controllers/FinderController.php
providermodules/AppBusinessFinder/Http/Controllers/FinderController.php
queriesmodules/AppBusinessFinder/Http/Controllers/FinderController.php
queries.*modules/AppBusinessFinder/Http/Controllers/FinderController.php
localitymodules/AppBusinessFinder/Http/Controllers/FinderController.php
per_querymodules/AppBusinessFinder/Http/Controllers/FinderController.php
remove_keymodules/AppBusinessFinder/Http/Controllers/FinderController.php
self_hosted_enabledmodules/AppBusinessFinder/Http/Controllers/FinderController.php
php_http_enabledmodules/AppBusinessFinder/Http/Controllers/FinderController.php
stagemodules/AppBusinessFinder/Http/Controllers/FinderController.php
notesmodules/AppBusinessFinder/Http/Controllers/FinderController.php
archivedmodules/AppBusinessFinder/Http/Controllers/FinderController.php
revisionmodules/AppBusinessFinder/Http/Controllers/FinderController.php