Overview
You can now access and export Pipeline Target data using an API endpoint. This endpoint retrieves all pipeline periods with their associated targets. To access the Pipeline Target data, all you need is your API Key obtained from your user profile.
Pipeline Targets API Endpoint
You can obtain your BulkData Pipeline Targets API Endpoint by using Swagger (for more information on how to access Swagger, kindly see the following article: How to find the available API Endpoints). Once you have entered the URL, select the Pipeline Targets endpoint under Pipeline Targets to view the available parameters or obtain the URL.
Note: the Pipeline Targets API Endpoint is currently only available on V1 definition. Ensure you select or input the V1 definition from the drop-down list of definitions or on your URLhttps://YourSiteName.pipware.net/api/v1/BulkData/pipelineTargets
The following is required for the Pipeline Targets API Endpoint to obtain data:
![]() | Your site URL |
![]() | The required version definition (V1) |
![]() | Your API Key |
BulkData Pipeline Targets Parameters
The following parameters are available to use on the BulkData
- IncludeInactive (boolean to include inactive periods)
- IncludeArchived (boolean to include archived periods)
When these parameters are set to True, the Pipeline Target API returns the parameters as well as the result of the pipeline target as follows: