Skip to main content

Hootsuite Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Hootsuite location.
hootsuite_api.png

Hootsuite

Follow the instructions below to create a new data flow that ingests data from a Hootsuite source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Hootsuite connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Hootsuite account, and click Next; or, create a new Hootsuite credential for use in this flow.

  3. In Nexla, Hootsuite data sources can be created using pre-built endpoint templates, which expedite source setup for common Hootsuite endpoints. Each template is designed specifically for the corresponding Hootsuite endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Hootsuite sources can also be configured manually, allowing you to ingest data from Hootsuite endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Hootsuite endpoints. Each template is designed specifically for the corresponding Hootsuite endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Interactions

    Retrieves the interactions between two users of a particular social network type such as direct messages, comments, and posts. This API is only available to Enterprise users.

    • Select the social network type from the Social Network Type dropdown menu. Valid options are facebook and twitter. The default value is facebook if not specified. The social network type determines which social network platform's interactions will be retrieved.
    • Enter the social network ID of the user owned by the calling member or organization in the Social Network ID field. This should be the ID from the social network itself (e.g., Facebook Page ID or Twitter User ID), not the Hootsuite social profile ID.
    • Enter the social network ID of the target user whose interactions with your social profile you are interested in in the Target Social Network Id field. This should be the ID from the social network itself (e.g., Facebook User ID or Twitter User ID), not the Hootsuite social profile ID.
    • The endpoint uses GET requests to https://platform.hootsuite.com/v1/interactions/{social_network_type}?socialNetworkId={social_network_id}&targetSocialNetworkId={target_social_network_id} where {social_network_type} is the Social Network Type you select, {social_network_id} is the Social Network ID you provide, and {target_social_network_id} is the Target Social Network Id you provide. The endpoint URL is automatically constructed based on the Hootsuite API base URL and all the parameters.
    • The endpoint uses token-based pagination (iteration.type: paging.next.token) through the cursor mechanism. The response data path is $.data.interactions[*], which extracts all items from the interactions array in the API response. Additional metadata is also included from $.data.metadata.
    • When a response includes a cursor.next value in the metadata, Nexla automatically uses it as the cursor parameter for the subsequent request to fetch the next page of results until all interactions have been retrieved.

    This endpoint retrieves interactions between two users on a specific social network platform. The endpoint supports Facebook and Twitter social networks. This API is only available to Enterprise users, so you must have an Enterprise Hootsuite account to use this endpoint. The endpoint supports pagination through the cursor mechanism, which allows you to retrieve large lists of interactions efficiently. The response includes metadata that indicates the current cursor and next cursor available. For detailed information about the API response format and available fields, see the Hootsuite API documentation.

    Retrieve outbound messages

    Outbound messages are messages that are scheduled or were previously sent. This endpoint returns outbound messages sorted by increasing scheduled send time.

    • Enter the start date range of messages to be returned in the startTime field. This should be in ISO-8601 format (e.g., 2024-01-01T00:00:00Z). The start time determines the beginning of the date range for retrieving messages.
    • Optionally, enter the end date range of messages to be returned in the endTime field. This should be in ISO-8601 format (e.g., 2024-01-31T23:59:59Z). The end time must not be later than 4 weeks from the start time. If not specified, messages up to 4 weeks from the start time will be retrieved.
    • Optionally, select or enter the state filter for messages in the state field. Available options include PENDING_APPROVAL, REJECTED, SENT, SCHEDULED, and SEND_FAILED_PERMANENTLY. You can also add custom state values if needed. The default value is SCHEDULED if not specified. The state filter determines which message states will be included in the results.
    • The endpoint uses GET requests to https://platform.hootsuite.com/v1/messages?startTime={start_time}&endTime={end_time}&state={state} where {start_time} is the startTime you provide, {end_time} is the endTime you provide, and {state} is the state you provide. The endpoint URL is automatically constructed based on the Hootsuite API base URL and all the query parameters.
    • The endpoint uses token-based pagination (iteration.type: paging.next.token) through the cursor mechanism. The response data path is $.data.interactions[*], which extracts all items from the interactions array in the API response. Additional metadata is also included from $.data.metadata.
    • When a response includes a cursor value in the metadata, Nexla automatically uses it as the cursor parameter for the subsequent request to fetch the next page of results until all messages have been retrieved.

    This endpoint retrieves outbound messages (messages that are scheduled or were previously sent) from your Hootsuite account. Messages are returned sorted by increasing scheduled send time. The endpoint supports filtering by date range (start time and end time) and message state. The end time must not be later than 4 weeks from the start time. The endpoint supports pagination through the cursor mechanism, which allows you to retrieve large lists of messages efficiently. The response includes metadata that indicates the current cursor and next cursor available. For detailed information about the API response format and available fields, see the Hootsuite API documentation.

Configure Manually​

Hootsuite data sources can be manually configured to ingest data from any valid Hootsuite API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Hootsuite sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Hootsuite API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Hootsuite API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Hootsuite API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Hootsuite API endpoints typically follow the pattern https://platform.hootsuite.com/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. For detailed information about Hootsuite API endpoints and available APIs, see the Hootsuite API documentation.