Configuring eKyte as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the eKyte option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
eKyte authenticates with a BI access key that belongs to your company. To get it, open Minha Empresa in eKyte and copy the key shown in the BI tab. The following configurations are available:- API Key: the BI access key of your company. Required.
- Start Date: the earliest date from which records will be synced: tasks, projects, tickets, and time entries created from this date on, and metrics dated from this date on. Leave it empty to extract the full history.
- Include Comments: also extract the comments of tasks and tickets. Syncs take longer when it is on.
- Include History: also extract the change history of tasks and the phase history of tickets. Syncs take longer when it is on.
- Form IDs: the IDs of the eKyte forms whose answers you want in the Form Answers stream. eKyte only returns answers form by form, so the stream is skipped when this list is empty.
- Lookback Days: how many days are re-read before the last sync point by the incremental streams, to pick up records eKyte changes after they first appear. The defaults are 7 days for time entries, 3 for phase completions, and 30 for metrics, which eKyte keeps updating as the ad platforms settle their numbers.
- Requests Per Minute: how fast the connector may call eKyte. The default is 60.
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.Select the streams and click Next.
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: Time Trackings, Phase Completions, Insights, and Organic Insights support INCREMENTAL. The other streams are FULL_TABLE. Read more about Sync Types here.
eKyte’s API does not tell when a task, project, or ticket last changed, so these streams are read in full (from the Start Date) on every sync. That is what keeps phase, executor, and status changes of older records up to date.
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.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
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 eKyte and their corresponding fields. API reference: eKyte BI API.eKyte sends dates in Brasília time; the connector converts every timestamp to UTC. Lists and objects (phases, checklists, comments, history, notes, and form answers) are stored as JSON text.
Tasks
Tasks
Every task of your company, in every situation: active, paused, done, and cancelled (
GET /v1.2/tasks). Phases and checklists always come along; comments and change history only when the corresponding settings are on.Primary key: idProjects
Projects
Projects of your company with planned and accomplished effort, budget, and expenses (
GET /v1.1/projects).Primary key: idTickets
Tickets
Help desk tickets of your company, in every status (
GET /v1.1/tickets).Primary key: idTime Trackings
Time Trackings
Time entries tracked on tasks, tickets, plans, and ads (
GET /v1.0/time-trackings).Primary key: id · Replication key: created_inPhase Completions
Phase Completions
One row per task phase concluded, with expected and actual dates and whether it was late (
GET /v1.2/activities/performance).Primary key: id · Replication key: real_phase_due_dateForm Answers
Form Answers
Answers submitted to the forms listed in Form IDs (
GET /v1.0/forms/answers). Skipped when no form ID is configured.Primary key: form_id, idInsights
Insights
Data-driven metrics imported into eKyte from paid media and analytics — cost, impressions, clicks, leads, revenue, and more (
GET /v1.0/insights). Each row is one metric of one entity on one date; values are not aggregated and must be summed as needed.Primary key: row_key · Replication key: dateOrganic Insights
Organic Insights
Social media monitoring metrics — followers, reach, engagement, reactions, comments, and shares, per profile or per post (
GET /v1.0/insights/organic).Primary key: row_key · Replication key: dateWorkspaces
Workspaces
Workspaces, the clients or departments your team works for (
GET /v1.0/workspaces).Primary key: idSquads
Squads
Squads, the teams of your company (
GET /v1.0/squads).Primary key: idUsers
Users
Users of your company with position and hourly rate (
GET /v1.0/users).Primary key: idTask Types
Task Types
Task types with their workflow, category, tags, and phases (
GET /v1.0/task-types).Primary key: idBoards
Boards
Knowledge base boards and their notes (
GET /v1.0/boards).Primary key: id