Skip to main content

Kapost 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 Kapost location.
kapost.png

Kapost

Follow the instructions below to create a new data flow that ingests data from a Kapost 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 Kapost connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Kapost account, and click Next; or, create a new Kapost credential for use in this flow.

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

    Kapost sources can also be configured manually, allowing you to ingest data from Kapost 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 Kapost endpoints. Each template is designed specifically for the corresponding Kapost 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.

    List Content

    List Content

    • This endpoint automatically retrieves all content from your Kapost account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://{subdomain}.kapost.com/api/v1/content where {subdomain} is your Kapost subdomain. The endpoint URL is automatically constructed based on your credential configuration.
    • The endpoint uses pagination (iteration.type: paging.incrementing) to retrieve all content. Pagination starts from page 1 and uses the page query parameter to navigate through pages. The per_page parameter controls how many records are returned per page, with an expected 100 records per page. The endpoint will automatically fetch all pages until all content is retrieved.
    • The response data path is $.response[*], which extracts all content objects from the response array in the API response. Additional pagination metadata is extracted from $.pagination for pagination information.
    • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

    This endpoint retrieves a list of all content from your Kapost account. The endpoint requires Basic Authentication with your API token, which is handled automatically by your credential configuration. The API token is used as the username in Basic Authentication, with the password set to "x". The subdomain is automatically retrieved from your credential configuration. The endpoint supports pagination through the page and per_page parameters, which allows you to retrieve large lists of content efficiently. For detailed information about listing content, pagination, and API response formats, see the Kapost API documentation.

    List tasks

    List tasks

    • Enter the Content ID in the Content ID field. This is the unique identifier for a specific content item in Kapost for which you want to retrieve tasks. You can obtain Content IDs from the "List Content" endpoint or from your Kapost account dashboard.
    • The endpoint uses GET requests to https://{subdomain}.kapost.com/api/v1/content/{content_id}/tasks where {subdomain} is your Kapost subdomain and {content_id} is the Content ID you configured. The endpoint URL is automatically constructed based on your credential configuration and the Content ID you specify.
    • The endpoint uses pagination (iteration.type: paging.incrementing) to retrieve all tasks. Pagination starts from page 1 and uses the page query parameter to navigate through pages. The per_page parameter controls how many records are returned per page, with an expected 100 records per page. The endpoint will automatically fetch all pages until all tasks are retrieved.
    • The response data path is $.response[*], which extracts all task objects from the response array in the API response. Additional pagination metadata is extracted from $.pagination for pagination information.
    • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

    This endpoint retrieves a list of all tasks associated with a specific content item in your Kapost account. The endpoint requires Basic Authentication with your API token, which is handled automatically by your credential configuration. The Content ID identifies which content item's tasks to retrieve. The endpoint supports pagination through the page and per_page parameters, which allows you to retrieve large lists of tasks efficiently. For detailed information about listing tasks, pagination, and API response formats, see the Kapost API documentation.

Configure Manually​

Kapost data sources can be manually configured to ingest data from any valid Kapost 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 Kapost 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 Kapost API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Kapost API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Kapost 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://), your Kapost subdomain, and any required path parameters. Kapost API endpoints typically follow the pattern https://{subdomain}.kapost.com/api/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 Basic Authentication with your API token, which is handled automatically by your credential configuration. The API token is used as the username in Basic Authentication, with the password set to "x". The subdomain is automatically retrieved from your credential configuration. For detailed information about Kapost API endpoints, authentication, and available APIs, see the Kapost API documentation.