> ## 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.

# Hi Platform as a data source

> Bring data from Hi Platform to Nekt.

<img height="50" src="https://mintcdn.com/nekt/3MFKt2g7jzqFpztO/assets/logo/logo-hi-platform.png?fit=max&auto=format&n=3MFKt2g7jzqFpztO&q=85&s=9ce82fa8ee82c429c770fb970039047a" data-path="assets/logo/logo-hi-platform.png" />

Hi Platform is a customer experience management platform that centralizes customer interactions from various channels into a single view. It provides tools for monitoring social media, managing support tickets, and analyzing customer feedback to help businesses improve their customer service and engagement.

## Configuring Hi Platform 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 Hi Platform option from the list of connectors.

Click **Next** and you'll be prompted to add your access.

### 1. Add account access

You'll need your Hi Platform API credentials for this connection. Check [this documentation](https://help.hiplatform.com/docs/api-de-integracao-para-o-hi-socialmonitoramentos-ocorrencias-publicacoes-chamados-relatorios-engajamento-outros#chaves-de-acesso) to see how to generate them.

* **API Secret**: The secret to authenticate against the API service.
* **API Key**: The key to authenticate against the API service.
* **Project ID**: The ID of the project to extract data from.
* **Start Date**: The earliest record date to sync.

Click **Next**.

### 2. Select streams

Choose which data streams you want to sync. The Hi Platform connector currently has only one available stream called `search_results`.

> 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 a name for each table (which will contain the fetched data) and the type of sync.

* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** and make this process faster!
* **Sync Type**: you can choose between INCREMENTAL and FULL\_TABLE.
  * Incremental: every time the extraction happens, we'll get only the new data - which is good if, for example, you want to keep every record ever fetched.
  * Full table: every time the extraction happens, we'll get the current state of the data - which is good if, for example, you don't want to have deleted data in your catalog.

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/runs/scheduling-and-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 determine when to execute a [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.

<Warning>For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.</Warning>

# Streams and Fields

Below you'll find the available data stream from Hi Platform and its corresponding fields:

<AccordionGroup>
  <Accordion title="Search Results">
    Stream for managing search results, which can include social media mentions, support tickets, and other customer interactions.

    **Key Fields:**

    * `id`: The search result's system ID
    * `type`: The type of search result
    * `title`: The title of the content
    * `text`: The content text
    * `url`: URL of the content
    * `media_id`: Media identifier
    * `published_on`: Timestamp of publication
    * `created_at`: Timestamp of creation
    * `user`: Username
    * `user_id`: User ID
    * `user_image`: User profile image URL
    * `attached_image_url`: URL of attached image
    * `social_media`: Social media platform
    * `search_term`: Search term used
    * `polarization`: Polarization score
    * `reach`: Reach metric
    * `favorite`: Whether result is favorited
    * `latitude`: Location latitude
    * `longitude`: Location longitude
    * `country`: Country name
    * `state`: State name
    * `city`: City name
    * `gender`: User gender
    * `crm_user_id`: CRM user ID
    * `can_hide`: Whether content can be hidden
    * `hidden_on_media`: Whether hidden on media platform
    * `likes`: Number of likes
    * `shares`: Number of shares
    * `comments`: Number of comments
    * `tags`: Content tags
  </Accordion>
</AccordionGroup>

## Skills for agents

<Snippet file="agent-skills-intro.mdx" />

<Card title="Download Hi Platform skills file" icon="wand-magic-sparkles" href="/sources/hi-platform.md">
  Hi Platform connector documentation as plain markdown, for use in AI agent contexts.
</Card>
