> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.
# eKyte as a data source
> Bring data from eKyte to your Lakehouse.
eKyte is a project, task, and help desk management platform for marketing teams and agencies. The connector extracts your company's tasks, projects, tickets, time tracking, and phase completions, the data-driven and social media metrics imported into eKyte, and reference data such as workspaces, squads, users, tags, task types, and knowledge base boards, so you can analyze your team's productivity and your clients' results in your Lakehouse.
The connector uses eKyte's BI API, which is available on the eKyte **Performance** plan.
## Configuring eKyte as a Source
In the [Sources](https://app.nekt.ai/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 key gives read access to all of your company's data in eKyte. If it is regenerated or revoked in eKyte, this connection stops working until you update it with the new key. If your company is not on the Performance plan, eKyte refuses the requests and the run log says so.
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.
Once you're done, click **Next**.
### 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](https://docs.nekt.com/get-started/core-concepts/types-of-sync).
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.
Once you are done configuring, click **Next**.
### 4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters.
To define your [Trigger](https://docs.nekt.com/get-started/core-concepts/triggers), 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](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#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.
Once you are ready, click **Next** to finalize the setup.
### 5. Check your new source
You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.
# Streams and Fields
Below you'll find all available data streams from eKyte and their corresponding fields. API reference: [eKyte BI API](https://developers.ekyte.com/api-reference/).
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.
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: `id`
| Field | Type | Description |
| :------------------------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the task. |
| `title` | String | Title of the task. |
| `description` | String | Description of the task. |
| `allocation_type` | Integer | How the effort of the task is controlled (allocation type code). |
| `workspace_id` | Integer | Identifier of the workspace (client) the task belongs to. |
| `workspace` | String | Name of the workspace. |
| `situation` | Integer | Situation of the task: 10 = active, 20 = paused, 30 = done, 40 = cancelled. |
| `priority` | Integer | Priority: 10 = not prioritized, 100 = low, 200 = medium, 300 = high, 400 = urgent. |
| `priority_group` | Integer | Priority group, from 0 to 100. |
| `estimated_time` | Number | Estimated effort, in minutes. |
| `actual_time` | Number | Effort tracked so far, in minutes. |
| `phase_id` | Integer | Identifier of the current phase of the task. |
| `phase` | String | Name of the current phase. |
| `co_phase_id` | Integer | Identifier of the current co-phase of the task. |
| `co_phase` | String | Name of the current co-phase. |
| `creation_date` | Datetime | When the task was created. |
| `original_due_date` | Datetime | Original due date of the task. |
| `current_due_date` | Datetime | Current due date of the task. |
| `phase_start_date` | Datetime | When the current phase started. |
| `phase_due_date` | Datetime | Due date of the current phase. |
| `resolved_date` | Datetime | When the task was completed (situation 30). |
| `created_by_id` | String | Identifier of the user who created the task. |
| `created_by` | String | Name of the user who created the task. |
| `executor_id` | String | Identifier of the current executor. |
| `executor` | String | Name of the current executor. |
| `co_executor_id` | String | Identifier of the current co-executor. |
| `co_executor` | String | Name of the current co-executor. |
| `project_id` | Integer | Identifier of the project the task belongs to. |
| `project` | String | Name of the project. |
| `project_alias` | String | Short identification (alias) of the project. |
| `ctc_task_type_id` | Integer | Identifier of the task type. |
| `ctc_task_type` | String | Name of the task type. |
| `ctc_task_predecessor_id` | Integer | Identifier of the predecessor task. |
| `ctc_task_predecessor` | String | Title of the predecessor task. |
| `channel_id` | Integer | Identifier of the channel. |
| `channel` | String | Name of the channel. |
| `media_id` | Integer | Identifier of the media. |
| `media` | String | Name of the media. |
| `quantity` | Number | Number of pieces the task delivers. |
| `phases` | String | Phases of the task's workflow with effort, dates and executor of each (JSON array of objects). |
| `checklists` | String | Checklist items of the task, with completion date and user (JSON array of objects). |
| `comments` | String | Comments of the task (JSON array of objects). Only filled when the 'Include Comments' setting is on. |
| `iterations` | String | Change history of the task: when, who, action, field, old and new value (JSON array of objects). Only filled when the 'Include History' setting is on. |
Projects of your company with planned and accomplished effort, budget, and expenses (`GET /v1.1/projects`).
Primary key: `id`
| Field | Type | Description |
| :--------------------------------------- | :------- | :---------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the project. |
| `name` | String | Name of the project. |
| `alias` | String | Short identification (alias) of the project. |
| `link` | String | Link to the project in eKyte. |
| `workspace_id` | Integer | Identifier of the workspace (client) the project belongs to. |
| `workspace` | String | Name of the workspace. |
| `start_date` | Date | Start date of the project. |
| `end_date` | Date | End date of the project. |
| `planned_tasks_count` | Integer | Number of tasks in the project. |
| `accomplished_tasks_count` | Integer | Number of completed tasks in the project. |
| `planned_tasks_time` | Number | Estimated effort of all the project's tasks, in minutes. |
| `accomplished_tasks_time` | Number | Effort tracked on the project's tasks, in minutes. |
| `planned_project_tasks_count` | Integer | Number of planned tasks. |
| `ctc_task_project_tasks_count` | Integer | Total number of tasks. |
| `unplanned_project_tasks_count` | Integer | Number of unplanned tasks. |
| `expected_effort` | Number | Expected effort of the project. |
| `trend` | Number | Trend indicator of the project. |
| `planned_manual_budget` | Number | Planned budget. |
| `hourly_budget` | Number | Hourly rate of the project. |
| `planned_total_estimated_hourly_rate` | Number | Planned value, estimated. |
| `planned_total_accomplished_hourly_rate` | Number | Planned value, accomplished. |
| `total_estimated_expense` | Number | Estimated expenses. |
| `total_realized_expense` | Number | Realized expenses. |
| `situation` | Integer | Situation of the project: 0 = inactive, 1 = active, 2 = archived. |
| `created_by_id` | String | Identifier of the user who created the project. |
| `created_by` | String | Name of the user who created the project. |
| `tags` | String | Tags of the project. |
| `created_in` | Datetime | When the project was created. |
| `planned` | Integer | Whether the project is planned: 0 = no, 1 = yes. |
Help desk tickets of your company, in every status (`GET /v1.1/tickets`).
Primary key: `id`
| Field | Type | Description |
| :-------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the ticket. |
| `subject` | String | Subject of the ticket. |
| `link` | String | Link to the ticket in eKyte. |
| `workspace_id` | Integer | Identifier of the workspace (client) the ticket belongs to. |
| `workspace` | String | Name of the workspace. |
| `status` | Integer | Status of the ticket: 1 = in progress, 2 = waiting for the requester, 3 = resolved, 9 = cancelled. |
| `created_in` | Datetime | When the ticket was created. |
| `expect_due_date` | Datetime | When the ticket is expected to be done. |
| `priority` | Integer | Priority: 10 = not prioritized, 100 = low, 200 = medium, 300 = high, 400 = urgent. |
| `priority_group` | Integer | Priority group, from 0 to 100. |
| `source` | Integer | Origin of the ticket: 1 = internal, 2 = external. |
| `type` | Integer | Type of the ticket: 1 = request, 2 = question, 3 = correction, 4 = quote, 5 = improvement. |
| `concluded_in` | Datetime | When the ticket was concluded. |
| `reopen_count` | Integer | How many times the ticket was reopened. |
| `created_by_id` | String | Identifier of the user who created the ticket. |
| `created_by` | String | Name of the user who created the ticket. |
| `requester_by_id` | String | Identifier of the requester. |
| `requester_by` | String | Name of the requester. |
| `executor_id` | String | Identifier of the current executor. |
| `executor` | String | Name of the current executor. |
| `executor_email` | String | Email of the current executor. |
| `phase_id` | Integer | Identifier of the current phase of the ticket. |
| `phase` | String | Name of the current phase. |
| `actual_time` | Number | Effort tracked on the ticket, in minutes. |
| `time_first_response` | Number | Minutes between the opening of the ticket and the first reply to the client. |
| `iterations` | Integer | Number of interactions with the client (external comments). |
| `ticket_iteration` | String | Phase and conclusion history of the ticket: field, from, to, when and action (JSON array of objects). Only filled when the 'Include History' setting is on. |
| `comments` | String | Comments of the ticket with author, date, content and origin (JSON array of objects). Only filled when the 'Include Comments' setting is on. |
Time entries tracked on tasks, tickets, plans, and ads (`GET /v1.0/time-trackings`).
Primary key: `id` · Replication key: `created_in`
| Field | Type | Description |
| :------------------------- | :------- | :---------------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the time entry. |
| `effort` | Number | Total time of the entry, in minutes. |
| `workspace_id` | Integer | Identifier of the workspace (client) of the entry. |
| `workspace` | String | Name of the workspace. |
| `status` | Integer | Status of the entry: 10 = pending (running timer), 20 = done, 30 = cancelled. |
| `created_in` | Datetime | When the entry was created, used as the incremental replication key. |
| `start_date` | Datetime | When the tracked time started. |
| `end_date` | Datetime | When the tracked time ended. |
| `comment` | String | Comment entered with the time. |
| `ctc_task_id` | Integer | Identifier of the task the time was tracked on. |
| `ctc_task` | String | Title of the task. |
| `ctc_task_type_id` | Integer | Identifier of the task type. |
| `ctc_task_type` | String | Name of the task type. |
| `executor_id` | String | Identifier of the user who tracked the time. |
| `executor` | String | Name of the user who tracked the time. |
| `accomplished_hourly_rate` | Number | Value of the tracked time at the user's hourly rate. |
| `phase_id` | Integer | Identifier of the phase. |
| `phase` | String | Name of the phase. |
| `planning_id` | Integer | Identifier of the plan. |
| `planning` | String | Name of the plan. |
| `ad_id` | Integer | Identifier of the ad. |
| `ad` | String | Name of the ad. |
| `ad_set_id` | Integer | Identifier of the ad set. |
| `ad_set` | String | Name of the ad set. |
| `ticket_id` | Integer | Identifier of the ticket the time was tracked on. |
| `ticket` | String | Subject of the ticket. |
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_date`
| Field | Type | Description |
| :-------------------------- | :------- | :----------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the record. |
| `task_id` | Integer | Identifier of the task. |
| `task` | String | Title of the task. |
| `workspace_id` | Integer | Identifier of the workspace (client) of the task. |
| `workspace` | String | Name of the workspace. |
| `executor` | String | Name of the executor of the phase. |
| `executor_email` | String | Email of the executor of the phase. |
| `phase` | String | Name of the phase. |
| `workflow` | String | Name of the workflow the phase belongs to. |
| `expected_phase_start_date` | Datetime | Expected start of the phase (only for tasks planned by phase). |
| `expected_phase_due_date` | Datetime | Expected conclusion of the phase (only for tasks planned by phase). |
| `real_phase_start_date` | Datetime | Actual start of the phase. |
| `real_phase_due_date` | Datetime | Actual conclusion of the phase, used as the incremental replication key. |
| `overdue` | Boolean | Whether the phase was delivered late. |
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`, `id`
| Field | Type | Description |
| :------------- | :------- | :--------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the answer. |
| `form_id` | Integer | Identifier of the form. |
| `form_name` | String | Name of the form. |
| `task_id` | Integer | Identifier of the task the answer is linked to. |
| `workspace_id` | Integer | Identifier of the workspace (client) of the answer. |
| `workspace` | String | Name of the workspace. |
| `date` | Datetime | When the answer was submitted. |
| `created_by` | String | Email of the user who filled in the form. |
| `answers` | String | Answers to the form's questions, keyed by question name (JSON object). |
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: `date`
| Field | Type | Description |
| :------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `row_key` | String | Surrogate key of the row: a hash of all its dimensions (every field but value). |
| `external_id` | String | External identifier of the row. |
| `value` | Number | Value of the metric (cost, leads, clicks...). Rows are not aggregated. |
| `workspace_id` | Integer | Identifier of the workspace (client). |
| `workspace` | String | Name of the workspace. |
| `date` | Date | Date the metric refers to, used as the incremental replication key. |
| `updated_in` | Datetime | When the row was last updated in eKyte. |
| `end_date` | Datetime | End of the period the metric refers to. |
| `metric` | Integer | Metric code: 10 = amount spent, 20 = impressions, 21 = reach, 30 = clicks, 31 = total traffic, 32 = sessions, 41 = Google Display remarketing base, 42 = Facebook remarketing base, 43 = email list base, 50 = leads, 51 = email base, 60 = presentation, 70 = proposal, 80 = trial, 90 = account, 100 = revenue, 110 = add to cart, 120 = balance (Meta Ads). |
| `metric_name` | String | Name of the metric. |
| `channel_id` | Integer | Identifier of the conversion channel. |
| `channel` | String | Name of the conversion channel. |
| `media_id` | Integer | Identifier of the conversion media. |
| `media` | String | Name of the conversion media. |
| `source_channel_id` | Integer | Identifier of the channel the data came from. |
| `source_channel` | String | Name of the channel the data came from. |
| `source_media_id` | Integer | Identifier of the media the data came from. |
| `source_media` | String | Name of the media the data came from. |
| `campaign_id` | String | Identifier of the campaign (Google Ads or Facebook Ads). |
| `campaign` | String | Name of the campaign. |
| `ad_set_id` | String | Identifier of the ad set / ad group (Google Ads or Facebook Ads). |
| `ad_set` | String | Name of the ad set / ad group. |
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: `date`
| Field | Type | Description |
| :-------------------- | :------- | :---------------------------------------------------------------------------------------------------- |
| `row_key` | String | Surrogate key of the row: a hash of all its dimensions (every field but value). |
| `value` | Number | Value of the metric. |
| `metric` | Integer | Metric code: 10 = followers, 20 = reach, 30 = engagement, 40 = reactions, 50 = comments, 60 = shares. |
| `metric_name` | String | Name of the metric. |
| `frequency` | Integer | Frequency code: 20 = daily, 50 = total. |
| `frequency_name` | String | Name of the frequency. |
| `workspace_id` | Integer | Identifier of the workspace (client). |
| `workspace` | String | Name of the workspace. |
| `channel_id` | Integer | Identifier of the channel (profile). |
| `channel` | String | Name of the channel (profile). |
| `media_id` | Integer | Identifier of the social network. |
| `media` | String | Name of the social network. |
| `post_id` | Integer | Identifier of the post (empty for profile metrics). |
| `post` | String | Text of the post, truncated by eKyte. |
| `external_created_at` | Datetime | When the post was published. |
| `date` | Datetime | Date the metric refers to, used as the incremental replication key. |
Workspaces, the clients or departments your team works for (`GET /v1.0/workspaces`).
Primary key: `id`
| Field | Type | Description |
| :------------ | :------ | :---------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the workspace. |
| `name` | String | Name of the workspace. |
| `description` | String | Description of the workspace. |
| `squad_id` | Integer | Identifier of the squad serving the workspace. |
| `squad_name` | String | Name of the squad serving the workspace. |
| `active` | Integer | Status of the workspace. |
| `external_id` | String | External identifier of the workspace (usually the client's CNPJ). |
Squads, the teams of your company (`GET /v1.0/squads`).
Primary key: `id`
| Field | Type | Description |
| :----- | :------ | :------------------------------ |
| `id` | Integer | Unique identifier of the squad. |
| `name` | String | Name of the squad. |
Users of your company with position and hourly rate (`GET /v1.0/users`).
Primary key: `id`
| Field | Type | Description |
| :---------------- | :------- | :----------------------------------------- |
| `id` | String | Unique identifier of the user. |
| `email` | String | Email of the user. |
| `name` | String | Name of the user. |
| `username` | String | Nickname of the user. |
| `profile_company` | String | Access profile of the user in the company. |
| `position_id` | Integer | Identifier of the user's position. |
| `position` | String | Position (role) of the user. |
| `invited_in` | Datetime | When the user was invited. |
| `hourly_rate` | Number | Hourly rate of the user. |
Tags of your company (`GET /v1.0/tags`).
Primary key: `id`
| Field | Type | Description |
| :----- | :------ | :------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the tag. |
| `name` | String | Name of the tag. |
| `type` | Integer | Type of the tag: 0 = shared default, 10 = data-driven, 20 = project. |
Task types with their workflow, category, tags, and phases (`GET /v1.0/task-types`).
Primary key: `id`
| Field | Type | Description |
| :------------------------- | :------ | :------------------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the task type. |
| `name` | String | Name of the task type. |
| `description` | String | Description of the task type. |
| `workflow_id` | Integer | Identifier of the workflow of the task type. |
| `workflow_name` | String | Name of the workflow of the task type. |
| `ctc_task_type_group_id` | Integer | Identifier of the category of the task type. |
| `ctc_task_type_group_name` | String | Name of the category of the task type. |
| `tags` | String | Tags of the task type with id, name and color (JSON array of objects). |
| `flow_phases` | String | Phases of the task type's workflow with their checklist (JSON array of objects). |
Knowledge base boards and their notes (`GET /v1.0/boards`).
Primary key: `id`
| Field | Type | Description |
| :----------------- | :------- | :----------------------------------------------------------------------------- |
| `id` | Integer | Unique identifier of the board. |
| `title` | String | Title of the board. |
| `description` | String | Description of the board. |
| `created_at` | Datetime | When the board was created. |
| `active` | Boolean | Whether the board is active. |
| `workspace_id` | Integer | Identifier of the workspace of the board. |
| `workspace` | String | Name of the workspace of the board. |
| `created_by_id` | String | Identifier of the user who created the board. |
| `created_by_email` | String | Email of the user who created the board. |
| `notes` | String | Notes of the board with id, title, content and status (JSON array of objects). |