Configuring Facilita as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Facilita option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
Facilita gives access to your data through its Public API. The Public API is a feature of your Facilita plan: if it is not active in your account, ask Facilita to enable it. An administrator of your Facilita account generates the credentials in the Facilita panel. You need three values:- the instance: the exact name of your Facilita instance;
- the API key;
- the user token: the token of an administrator user.
The connector reads what the user of the token can see. Use the token of an administrator so that all deals, users and developments are extracted.
- Instance: the exact name of your Facilita instance. Required.
- API Key: the Public API key generated in Facilita. Required.
- User Token: the token of an administrator user, generated together with the API key. Required.
- Start Date (advanced): the earliest last-update date of the deals read on the first sync. Later syncs continue from where the previous one stopped. Leave it empty to read the whole history. The other streams are always extracted in full.
- Requests Per Minute (advanced): how fast the connector may call Facilita. The default is 45. Facilita allows 50 to 150 requests per minute depending on your plan; when Facilita asks the connector to slow down, it waits and continues automatically.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.
Deal Details takes one request per deal. On the first sync of an account with many deals it makes the extraction noticeably longer (at the default pace, about 2,700 deals per hour); later syncs only read the deals that changed. Use Start Date to limit how far back the first sync goes.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: deals and deal details are INCREMENTAL: each sync brings the deals that changed since the previous one. The other streams are FULL_TABLE: each sync replaces the table with what Facilita currently holds. Read more about Sync Types here.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Below you’ll find all available data streams from Facilita and their corresponding fields. API reference: Facilita Public API.Lists and objects are stored as JSON text, and timestamps are converted to UTC. Facilita has no list of customers: customer contact data comes with each deal, and the full customer record is in the
customer column of Deal Details.Deals
Deals
Deals (negócios) of your sales funnels, with their stage, value, customer contact and the people responsible. Incremental: each sync reads the deals updated since the previous one.Table:
deals · Primary key: id · Sync: IncrementalDeal Details
Deal Details
The full record of each deal read by Deals in the same sync: name, sale date, the custom fields filled on the deal, payment conditions and the activity history. Read with one request per deal, only for the deals that changed. Requires the Deals stream.Table:
deal_details · Primary key: id · Sync: IncrementalFunnels
Funnels
Sales funnels configured in your account. Extracted in full on every sync.Table:
funnels · Primary key: id · Sync: Full tableFunnel Stages
Funnel Stages
Stages (etapas) of the sales funnel. Join
id with deals.funnel_stage_id.Table: funnel_stages · Primary key: id · Sync: Full tableFunnel Stage Statuses
Funnel Stage Statuses
Statuses inside each funnel stage. Join
id with deals.funnel_stage_status_id.Table: funnel_stage_statuses · Primary key: id · Sync: Full tableIdle Rules
Idle Rules
Idleness rules (ociosidades): how long a deal may stay still in a stage before it is flagged.Table:
idle_rules · Primary key: id · Sync: Full tableUsers
Users
Users of your account, with their access group and their links to teams, managers and brokers.Table:
users · Primary key: id · Sync: Full tableTeams
Teams
Sales teams (equipes).Table:
teams · Primary key: id · Sync: Full tableDevelopments
Developments
Developments (empreendimentos) registered in your account, with their settings and unit summary.Table:
products · Primary key: id · Sync: Full tableAvailability Units
Availability Units
Units of each development (apartments, lots, houses), with price and commercial situation. Read for every development that has an availability. Requires the Developments stream.Table:
availability_units · Primary key: id · Sync: Full tableTasks
Tasks
Tasks (calls, e-mails, visits, WhatsApp, chats and notes), one row per task and user linked to it.Table:
tasks · Primary key: task_id, user_id, user_mode · Sync: Full tableReservations
Reservations
Unit reservations, with the unit, the customer, the deal and the users involved.Table:
reserves · Primary key: id_reserve · Sync: Full tableCustom Fields
Custom Fields
Definitions of the custom fields of deals, developments, units, teams and users. The values filled on each deal are in the
custom_fields column of Deal Details.Table: custom_fields · Primary key: id, entity_type · Sync: Full table