Skip to main content

Data Source

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

Pinterest API

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

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

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

    This endpoint template retrieves user account information from your Pinterest account. Use this template when you need to retrieve information about your Pinterest user account, including account details, profile information, and other user account data.

    • This endpoint automatically retrieves user account information from your Pinterest account. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns user account information from your Pinterest account, including account details, profile information, and other user account data. The endpoint returns a single user account record.

    For detailed information about user account management, API response structures, and available user account data, see the Pinterest API documentation.

    Get Pins

    This endpoint template retrieves pins from your Pinterest account. Use this template when you need to retrieve information about pins, including pin IDs, descriptions, images, and other pin data.

    • This endpoint automatically retrieves pins from your Pinterest account. The endpoint uses bookmark-based pagination to handle large datasets efficiently.

    This endpoint returns pins from your Pinterest account, including pin IDs, descriptions, images, and other pin data. The endpoint uses bookmark-based pagination with a bookmark parameter to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the bookmark returned in the API response.

    For detailed information about pin management, API response structures, pagination, and available pin data, see the Pinterest API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Pinterest data sources can be manually configured to ingest data from any valid Pinterest 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 Pinterest sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Pinterest API from the Method pulldown menu. Pinterest API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Pinterest API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Pinterest endpoint (e.g., https://api.pinterest.com/v5/user_account, https://api.pinterest.com/v5/pins). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Pinterest API uses bookmark-based pagination with a bookmark parameter for some endpoints. The endpoint URL should include the API version (/v5/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Pinterest API responses, use $ to extract the entire response for single record endpoints, or $.items[*] to extract all items from the items array for list endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Pinterest API response. Pinterest API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Pinterest API uses bookmark-based pagination with a bookmark parameter for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For bookmark-based pagination, specify the JSONPath expression to the bookmark in the response and the parameter name (bookmark).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.