Skip to main content

WordPress Data Source

The WordPress connector enables you to access WordPress REST API endpoints to extract content, retrieve posts and pages, and integrate WordPress data with other systems. This connector is particularly useful for applications that need to extract blog content, integrate WordPress with analytics systems, build content aggregation solutions, or automate content management workflows. Follow the instructions below to create a new data flow that ingests data from a WordPress source in Nexla.
wordpress_api.png

WordPress

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

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

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

    This endpoint retrieves blog posts using WordPress's REST API. Use this endpoint when you need to extract blog posts, retrieve post content, or integrate WordPress posts with other systems.

    • Enter the date filter in the After the date field. This limits the response to posts published after the specified date, in ISO8601 format (e.g., 2023-01-01T00:00:00Z). The default value is 2023-01-01T00:00:00Z.
    • This endpoint uses pagination with offset-based pagination. The endpoint automatically fetches additional pages using incrementing offset values, ensuring all posts are retrieved.

    The List Posts endpoint uses GET requests with pagination through offset-based pagination. The endpoint automatically fetches additional pages using incrementing offset values, ensuring all posts published after the specified date are retrieved. For more information about the List Posts endpoint, refer to the WordPress REST API Documentation.

    List Pages

    This endpoint retrieves pages using WordPress's REST API. Use this endpoint when you need to extract WordPress pages, retrieve page content, or integrate WordPress pages with other systems.

    • Enter the date filter in the After the date field. This limits the response to pages published after the specified date, in ISO8601 format (e.g., 2023-01-01T00:00:00Z). The default value is 2023-01-01T00:00:00Z.
    • This endpoint uses pagination with offset-based pagination. The endpoint automatically fetches additional pages using incrementing offset values, ensuring all pages are retrieved.

    The List Pages endpoint uses GET requests with pagination through offset-based pagination. The endpoint automatically fetches additional pages using incrementing offset values, ensuring all pages published after the specified date are retrieved. For more information about the List Pages endpoint, refer to the WordPress REST 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​

WordPress data sources can be manually configured to ingest data from any valid WordPress REST 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 WordPress sources, such as sources that use custom query parameters, sources that access custom post types, or sources that require custom authentication headers or request parameters.

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 WordPress API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most WordPress REST API endpoints use GET)

API Endpoint URL​

  1. Enter the URL of the WordPress REST 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. WordPress REST API endpoints typically follow the pattern {site_url}/wp-json/wp/{api_version}/{resource}, where {site_url} is your WordPress site URL and {api_version} is typically v2.

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 URL should use the WordPress site URL and API version configured in your credential. WordPress REST API may require Basic Authentication for protected endpoints, which is automatically included from your credential if configured.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records. For WordPress REST API responses, common paths include $ for the entire response array (which contains posts or pages), or $[*] for all array elements.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $ to access the entire response array).

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. For WordPress, the Authorization header with Basic Authentication is automatically included from your credential if configured.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. 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.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new WordPress data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.